Skip to content

Usage

tfcoach

Tiny Terraform coach

tfcoach [flags]

Options

  -h, --help   help for tfcoach

Exit Codes

Code Meaning
0 OK

tfcoach lint

Lint Terraform files

tfcoach lint [path] [flags]

Options

  -c, --config string              Custom config file path (default current directory)
  -f, --format string              Output format. Supported: json|compact|pretty|educational (default "educational")
  -h, --help                       help for lint
      --include-terragrunt-cache   Include Terragrunt cache in scanned files
      --no-color                   Disable color output
      --no-emojis                  Prevent emojis in output

Exit Codes

Code Meaning
0 No issues found
1 Issues found
2 Runtime error

tfcoach print

Print tfcoach JSON report in another format

tfcoach print [path] [flags]

Options

  -c, --config string   Custom config file path (default current directory)
  -f, --format string   Output format. Supported: json|compact|pretty|educational (default "educational")
  -h, --help            help for print
      --no-color        Disable color output
      --no-emojis       Prevent emojis in output

Exit Codes

Code Meaning
0 No issues found
1 Read error
2 Conversion error

tfcoach version

Print the version number

tfcoach version [flags]

Options

  -h, --help   help for version

Exit Codes

Code Meaning
0 OK