1.1 KiB
1.1 KiB
layout | page_title | sidebar_current | description |
---|---|---|---|
docs | Command: fmt | docs-commands-fmt | The `terraform fmt` command is used to rewrite Terraform configuration files to a canonical format and style. |
Command: fmt
The terraform fmt
command is used to rewrite Terraform configuration files
to a canonical format and style.
Usage
Usage: terraform fmt [options] [DIR]
By default, fmt
scans the current directory for configuration files. If
the dir
argument is provided then it will scan that given directory
instead. If dir
is a single dash (-
) then fmt
will read from standard
input (STDIN).
The command-line flags are all optional. The list of available flags are:
-list=true
- List files whose formatting differs (disabled if using STDIN)-write=true
- Write result to source file instead of STDOUT (disabled if using STDIN or -check)-diff=false
- Display diffs of formatting changes-check=false
- Check if the input is formatted. Exit status will be 0 if all input is properly formatted and non-zero otherwise.