← 返回命令列表

Linux command

tfsec 命令

文本

复制后可按需替换文件名、目录或参数。

常用示例

Scan the current directory

tfsec

Scan a specific directory

tfsec [path/to/terraform]

Output results in JSON format

tfsec --format json

Exclude specific checks

tfsec -e [check1,check2]

Scan with a specific tfvars file

tfsec --tfvars-file [terraform.tfvars]

Only show high severity issues

tfsec --minimum-severity HIGH

Save results to a file

tfsec --format json --out [results.json]

Exclude directories

tfsec --exclude-path [path/to/exclude]

说明

tfsec is a static analysis security scanner for Terraform code. It analyzes Terraform files to detect potential security misconfigurations, policy violations, and best practice issues before infrastructure is deployed. The scanner runs locally and in CI/CD pipelines, providing developer-friendly output with documented checks. It supports multiple output formats for integration with various tools and platforms. Issues are categorized by severity to help prioritize remediation efforts. tfsec can be configured via command-line flags, configuration files, or environment variables (prefixed with TFSEC_). Inline comments can also be used to ignore specific warnings in Terraform files.

参数

--format _format_
Output format: default, json, csv, checkstyle, sarif, junit, gif, or text.
--out _file_
Write results to a file instead of stdout.
-e, --exclude _checks_
Comma-separated list of check IDs to exclude from the scan.
--exclude-path _path_
Exclude specific directories from scanning.
--minimum-severity _level_
Filter results by minimum severity: LOW, MEDIUM, HIGH, or CRITICAL.
--tfvars-file _file_
Include variable values from a tfvars file in the scan.
--config-file _file_
Use a custom configuration file (default: tfsec-config.json).
--no-colour, --no-color
Disable colored output (useful for CI pipelines).
--soft-fail
Exit with code 0 even if issues are found.
--include-ignored
Include results that have been marked as ignored.
--include-passed
Include checks that passed in the output.
--version
Display version information and exit.
-h, --help
Display help message and exit.

FAQ

What is the tfsec command used for?

tfsec is a static analysis security scanner for Terraform code. It analyzes Terraform files to detect potential security misconfigurations, policy violations, and best practice issues before infrastructure is deployed. The scanner runs locally and in CI/CD pipelines, providing developer-friendly output with documented checks. It supports multiple output formats for integration with various tools and platforms. Issues are categorized by severity to help prioritize remediation efforts. tfsec can be configured via command-line flags, configuration files, or environment variables (prefixed with TFSEC_). Inline comments can also be used to ignore specific warnings in Terraform files.

How do I run a basic tfsec example?

Run `tfsec` in a terminal, then adjust file names, paths, flags, or remote targets for your system.

What does --format _format_ do in tfsec?

Output format: default, json, csv, checkstyle, sarif, junit, gif, or text.