Skip to main content

Command Usage

$ tfcmt --help
NAME:
tfcmt - Notify the execution result of terraform command

USAGE:
tfcmt [global options] [command [command options]]

VERSION:
4.14.5

COMMANDS:
plan Run terraform plan and post a comment to GitHub commit, pull request, or issue
apply Run terraform apply and post a comment to GitHub commit, pull request, or issue
version Show version
version Show version
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--owner string GitHub Repository owner name [$TFCMT_REPO_OWNER]
--repo string GitHub Repository name [$TFCMT_REPO_NAME]
--sha string commit SHA (revision) [$TFCMT_SHA]
--build-url string build url
--log-level string log level
--pr int pull request number (default: 0) [$TFCMT_PR_NUMBER]
--config string config path [$TFCMT_CONFIG]
--var string [ --var string ] template variables. The format of value is '<name>:<value>'. You can refer to the variable in the comment and label template using {{.Vars.<variable name>}}.
--output string specify file to output result instead of posting a comment
--help, -h show help
--version, -v print the version

tfcmt plan

$ tfcmt plan --help
NAME:
tfcmt plan - Run terraform plan and post a comment to GitHub commit, pull request, or issue

USAGE:
tfcmt plan <command> <args>...

DESCRIPTION:
Run terraform plan and post a comment to GitHub commit, pull request, or issue.

$ tfcmt [<global options>] plan [-patch] [-skip-no-changes] -- terraform plan [<terraform plan options>]

OPTIONS:
--patch update an existing comment instead of creating a new comment. If there is no existing comment, a new comment is created. (default: false) [$TFCMT_PLAN_PATCH]
--skip-no-changes If there is no change tfcmt updates a label but doesn't post a comment (default: false) [$TFCMT_SKIP_NO_CHANGES]
--ignore-warning If skip-no-changes is enabled, comment is posted even if there is a warning. If skip-no-changes is disabled, warning is removed from the comment. (default: false) [$TFCMT_IGNORE_WARNING]
--disable-label Disable to add or update a label (default: false) [$TFCMT_DISABLE_LABEL]
--help, -h show help

tfcmt apply

$ tfcmt apply --help
NAME:
tfcmt apply - Run terraform apply and post a comment to GitHub commit, pull request, or issue

USAGE:
tfcmt apply <command> <args>...

DESCRIPTION:
Run terraform apply and post a comment to GitHub commit, pull request, or issue.

$ tfcmt [<global options>] apply -- terraform apply [<terraform apply options>]

OPTIONS:
--help, -h show help

tfcmt version

$ tfcmt version --help
NAME:
tfcmt version - Show version

USAGE:
tfcmt version

OPTIONS:
--json, -j Output version in JSON format (default: false)
--help, -h show help

tfcmt version

$ tfcmt version --help
NAME:
tfcmt version - Show version

USAGE:
tfcmt version

OPTIONS:
--json, -j Output version in JSON format (default: false)
--help, -h show help