website: Revise show command docs

This commit is contained in:
Nick Fagerlund 2019-02-20 17:14:12 -08:00
parent a43004e382
commit 7ba654a8a9
1 changed files with 10 additions and 12 deletions

View File

@ -14,23 +14,21 @@ that the planned operations are expected, or to inspect the current state
as Terraform sees it. as Terraform sees it.
Machine-readable output is generated by adding the `-json` command-line Machine-readable output is generated by adding the `-json` command-line
flag. This is only available when using `show` with a path to a Terraform flag.
plan file.
**NOTE** -> **Note:** When using the `-json` command-line flag, any sensitive values in
When using the `-json` command-line flag, any sensitive values in Terraform state will be displayed in plain text. For more information, see
terraform state will be displayed in plain text. For more information, see [Sensitive Data in State](/docs/state/sensitive-data.html).
[_Sensitive Data in State_](/docs/state/sensitive-data.html).
## json output ## JSON Output
When `terraform show -json` is run with a path to a Terraform state file or no For Terraform state files (including when no path is provided),
path, a json representation of the current state will be shown. `terraform show -json` will show a JSON representation of the state.
When `terraform show -json` is run with a path to a Terraform plan file, a json For Terraform plan files, `terraform show -json` will show a JSON representation
representation of the plan, configuration, and current state will be shown. of the plan, configuration, and current state.
The output format is covered in detail in [_JSON Format_](/docs/internals/json-format.html). The output format is covered in detail in [JSON Format](/docs/internals/json-format.html).
## Usage ## Usage