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.9.1 (7a2e3a22abd25e095dac93e2834b87f9b9d84320)

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

GLOBAL OPTIONS:
--owner value GitHub Repository owner name [$TFCMT_REPO_OWNER]
--repo value GitHub Repository name [$TFCMT_REPO_NAME]
--sha value commit SHA (revision) [$TFCMT_SHA]
--build-url value build url
--log-level value log level
--pr value pull request number (default: 0) [$TFCMT_PR_NUMBER]
--config value config path [$TFCMT_CONFIG]
--var value [ --var value ] template variables. The format of value is '<name>:<value>'
--output value specify file to output result instead of post comment
--help, -h show help
--version, -v print the version

tfcmt plan

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

USAGE:
tfcmt plan [command 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)
--skip-no-changes If there is no change tfcmt updates a label but doesn't post a comment (default: false)
--help, -h show help

tfcmt apply

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

USAGE:
tfcmt apply [command options]

OPTIONS:
--help, -h show help