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.17

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
   help, h     Shows a list of commands or help for one command
   completion  Output shell completion script for bash, zsh, fish, or Powershell

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 [options]  <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. [$TFCMT_PLAN_PATCH]
   --skip-no-changes  If there is no change tfcmt updates a label but doesn't post a comment [$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. [$TFCMT_IGNORE_WARNING]
   --disable-label    Disable to add or update a label [$TFCMT_DISABLE_LABEL]
   --help, -h         show help

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

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 [options]  <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

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

tfcmt version​

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

USAGE:
   tfcmt version [options]

OPTIONS:
   --json, -j  Output version in JSON format
   --help, -h  show help

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

tfcmt completion​

$ tfcmt completion --help
NAME:
   tfcmt completion - Output shell completion script for bash, zsh, fish, or Powershell

USAGE:
   tfcmt completion [command [command options]]

DESCRIPTION:
   Output shell completion script for bash, zsh, fish, or Powershell.
   Source the output to enable completion.

   # .bashrc
   source <(tfcmt completion bash)

   # .zshrc
   source <(tfcmt completion zsh)

   # fish
   tfcmt completion fish > ~/.config/fish/completions/tfcmt.fish

   # Powershell
   Output the script to path/to/autocomplete/tfcmt.ps1 an run it.


COMMANDS:
   bash  Output bash completion script
   zsh   Output zsh completion script
   fish  Output fish completion script
   pwsh  Output pwsh completion script

OPTIONS:
   --help, -h  show help

completion bash​

$ completion bash --help
NAME:
   tfcmt completion bash - Output bash completion script

USAGE:
   tfcmt completion bash [options]

OPTIONS:
   --help, -h  show help

completion zsh​

$ completion zsh --help
NAME:
   tfcmt completion zsh - Output zsh completion script

USAGE:
   tfcmt completion zsh [options]

OPTIONS:
   --help, -h  show help

completion fish​

$ completion fish --help
NAME:
   tfcmt completion fish - Output fish completion script

USAGE:
   tfcmt completion fish [options]

OPTIONS:
   --help, -h  show help

completion pwsh​

$ completion pwsh --help
NAME:
   tfcmt completion pwsh - Output pwsh completion script

USAGE:
   tfcmt completion pwsh [options]

OPTIONS:
   --help, -h  show help