website/docs: add -json flag to terraform show docsn

This commit is contained in:
Kristin Laemmert 2019-01-29 14:29:02 -08:00
parent f9b62cb5fe
commit f7ab90207c
2 changed files with 11 additions and 3 deletions

View File

@ -186,8 +186,8 @@ Usage: terraform show [options] [path]
Options: Options:
-no-color If specified, output won't contain any color. -no-color If specified, output won't contain any color.
-json If specified, output the Terraform plan in a machine- -json If specified, output the Terraform plan or state in
readable form. Only available for plan files. a machine-readable form.
` `
return strings.TrimSpace(helpText) return strings.TrimSpace(helpText)

View File

@ -22,6 +22,14 @@ 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
When `terraform show -json` is run with a path to a Terraform state file or no
path, a json representation of the current state will be shown.
When `terraform show -json` is run with a path to a Terraform plan file, a json
representation of the plan, configuration, and current state will be shown.
## Usage ## Usage
Usage: `terraform show [options] [path]` Usage: `terraform show [options] [path]`
@ -33,4 +41,4 @@ The command-line flags are all optional. The list of available flags are:
* `-no-color` - Disables output with coloring * `-no-color` - Disables output with coloring
* `-json` - Displays machine-readable output from a plan file * `-json` - Displays machine-readable output from a state or plan file