From 5f35c7852f734ddc921fdd65521cf95deb55ddf2 Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Fri, 5 Dec 2014 15:29:00 -0800 Subject: [PATCH] website: Update CLI flags for existing commands --- .../docs/commands/destroy.html.markdown | 2 +- .../source/docs/commands/init.html.markdown | 21 +++++++++++++++++++ .../source/docs/commands/plan.html.markdown | 6 ++++++ .../source/docs/commands/show.html.markdown | 9 +++++--- 4 files changed, 34 insertions(+), 4 deletions(-) diff --git a/website/source/docs/commands/destroy.html.markdown b/website/source/docs/commands/destroy.html.markdown index 311fe174e1..4ea84f8800 100644 --- a/website/source/docs/commands/destroy.html.markdown +++ b/website/source/docs/commands/destroy.html.markdown @@ -19,5 +19,5 @@ Infrastructure managed by Terraform will be destroyed. This will ask for confirmation before destroying. This command accepts all the flags that the -[apply command](/docs/commands/apply.html) accepts. If `-input=false` is +[apply command](/docs/commands/apply.html) accepts. If `-force` is set, then the destroy confirmation will not be shown. diff --git a/website/source/docs/commands/init.html.markdown b/website/source/docs/commands/init.html.markdown index bed95eac06..ee4286c278 100644 --- a/website/source/docs/commands/init.html.markdown +++ b/website/source/docs/commands/init.html.markdown @@ -24,3 +24,24 @@ information from the module (such as Git history) will not be copied. The directory being initialized must be empty of all Terraform configurations. If the module has other files which conflict with what is already in the directory, they _will be overwritten_. + +The command-line options available are a subset of the ones for the +[remote command](/docs/commands/remote.html), and are used to initialize +a remote state configuration if provided. + +The command-line flags are all optional. The list of available flags are: + +* `-address=url` - URL of the remote storage server. Required for HTTP backend, + optional for Atlas and Consul. + +* `-access-token=token` - Authentication token for state storage server. + Required for Atlas backend, optional for Consul. + +* `-backend=atlas` - Specifies the type of remote backend. Must be one + of Atlas, Consul, or HTTP. Defaults to atlas. + +* `-name=name` - Name of the state file in the state storage server. + Required for Atlas backend. + +* `-path=path` - Path of the remote state in Consul. Required for the Consul backend. + diff --git a/website/source/docs/commands/plan.html.markdown b/website/source/docs/commands/plan.html.markdown index 1d8f1a778f..14c10c5da3 100644 --- a/website/source/docs/commands/plan.html.markdown +++ b/website/source/docs/commands/plan.html.markdown @@ -28,6 +28,12 @@ The command-line flags are all optional. The list of available flags are: * `-destroy` - If set, generates a plan to destroy all the known resources. +* `-input=true` - Ask for input for variables if not directly set. + +* `-module-depth=n` - Specifies the depth of modules to show in the output. + This does not affect the plan itself, only the output shown. By default, + this is zero. -1 will expand all. + * `-no-color` - Disables output with coloring. * `-out=path` - The path to save the generated execution plan. This plan diff --git a/website/source/docs/commands/show.html.markdown b/website/source/docs/commands/show.html.markdown index 8593b75c02..a374b51fe4 100644 --- a/website/source/docs/commands/show.html.markdown +++ b/website/source/docs/commands/show.html.markdown @@ -15,12 +15,15 @@ as terraform sees it. ## Usage -Usage: `terraform show [options] ` +Usage: `terraform show [options] [path]` -You must call `show` with a path to either a Terraform state file or plan -file. +You must may `show` with a path to either a Terraform state file or plan +file. If no path is specified, the current state will be shown. The command-line flags are all optional. The list of available flags are: +* `-module-depth=n` - Specifies the depth of modules to show in the output. + By default this is zero. -1 will expand all. + * `-no-color` - Disables output with coloring