Recursively find HashiCorp Configuration Language (HCL) files and rewrite them into a canonical format.
Recursively format all HCL files in the current directory.
terragrunt hcl fmt--check
Enable check mode in the hclfmt command.
When enabled, Terragrunt will check if HCL files are properly formatted without making any changes. This is useful in CI/CD pipelines to ensure consistent formatting.
The command will:
Example:
terragrunt hcl fmt --checkEnvironment Variables:
TG_CHECK--diff
Print diff between original and modified file versions when running with 'hclfmt'.
When enabled, Terragrunt will show the differences between the original and formatted versions of HCL files. This helps you understand what changes the formatter would make.
Example:
terragrunt hcl fmt --diffEnvironment Variables:
TG_DIFF--exclude-dir
Skip HCL formatting in given directories.
Specifies directories to exclude from HCL formatting. This is useful when you want to skip formatting certain parts of your codebase.
Example:
terragrunt hcl fmt --exclude-dir=vendor --exclude-dir=.terragrunt-cacheEnvironment Variables:
TG_EXCLUDE_DIR--file
The path to a single hcl file that the hclfmt command should run on.
Specifies a single HCL file to format instead of recursively searching for files. This is useful when you want to format just one specific file.
Example:
terragrunt hcl fmt --file=./environments/prod/terragrunt.hclEnvironment Variables:
TG_FILE--filter
Filter configurations using a flexible query language
The --filter flag provides a path-based querying syntax for targeting specific HCL files to format.
terragrunt hcl fmt --filter './prod/**'Match HCL files by their file system path:
# Relative paths with globsterragrunt hcl fmt --filter './envs/prod/**'
# Format all HCL files in a specific directoryterragrunt hcl fmt --filter './modules/**/*.hcl'
# Absolute pathsterragrunt hcl fmt --filter '/absolute/path/to/envs/dev/apps/*'Exclude paths using the ! prefix:
# Exclude by pathterragrunt hcl fmt --filter '!./prod/**'
# Exclude specific directoriesterragrunt hcl fmt --filter '!./test/**'Use the | operator to refine results:
# Format HCL files in prod directory, excluding teststerragrunt hcl fmt --filter './prod/** | !./prod/test/**'
# Format specific file patternsterragrunt hcl fmt --filter './**/*.hcl | !./**/test/**'Specify multiple --filter flags to combine results using OR logic:
# Format files in either dev or staging directoriesterragrunt hcl fmt --filter './dev/**' --filter './staging/**'For comprehensive examples and advanced usage patterns, see the Filters feature documentation.
--stdin
Format HCL from stdin and print result to stdout.
When enabled, Terragrunt will read HCL content from standard input, format it, and write the result to standard output. This is useful for integrating with text editors or other tools.
Example:
echo 'locals { foo="bar" }' | terragrunt hcl fmt --stdinEnvironment Variables:
TG_STDIN--parallelism
Parallelism for --all commands.
Sets the maximum number of concurrent operations when running commands with --all. This helps control resource usage and API rate limits when working with multiple units.
Environment Variables:
TG_PARALLELISM--queue-exclude-dir
Unix-style glob of directories to exclude from the queue of Units to run.
Environment Variables:
TG_QUEUE_EXCLUDE_DIR--queue-exclude-external
Exclude external dependencies from the queue of Units to run.
Environment Variables:
TG_QUEUE_EXCLUDE_EXTERNAL--queue-excludes-file
Path to a file with a list of directories that need to be excluded when running `run --all` commands.
Environment Variables:
TG_QUEUE_EXCLUDES_FILE--queue-ignore-dag-order
Ignore DAG order for --all commands.
When enabled, Terragrunt will ignore the dependency order when running commands with --all. This means units will be executed in arbitrary order, which can be useful for read-only operations like plan.
Note that this can lead to errors if used with commands that modify state, as dependencies might be processed in the wrong order.
To learn more about how to use this flag, see the Stacks feature documentation.
Environment Variables:
TG_QUEUE_IGNORE_DAG_ORDER--queue-ignore-errors
Continue processing Units even if a dependency fails.
When enabled, Terragrunt will continue processing remaining units even if one fails. This can be useful when you want to see all potential errors in your configuration, rather than stopping at the first failure.
Note that this may lead to incomplete or inconsistent states if used with commands that modify infrastructure.
To learn more about how to use this flag, see the Stacks feature documentation.
Environment Variables:
TG_QUEUE_IGNORE_ERRORS--queue-include-dir
Unix-style glob of directories to include in the queue of Units to run.
Environment Variables:
TG_QUEUE_INCLUDE_DIR--queue-include-external
Include external dependencies in the queue of Units to run.
Environment Variables:
TG_QUEUE_INCLUDE_EXTERNAL--queue-include-units-reading
If flag is set, 'run --all' will only run the command against Terragrunt units that read the specified file via an HCL function or include.
Environment Variables:
TG_QUEUE_INCLUDE_UNITS_READING--queue-strict-include
Only process the directories matched by --queue-include-dir.
Environment Variables:
TG_QUEUE_STRICT_INCLUDE