Merge #10347: Update CLI usage information on the website

commands.go

@@ -35,6 +35,12 @@ func init() {
 		Ui:          Ui,
 	}
 
+	// The command list is included in the terraform -help
+	// output, which is in turn included in the docs at
+	// website/source/docs/commands/index.html.markdown; if you
+	// add, remove or reclassify commands then consider updating
+	// that to match.
+
 	PlumbingCommands = map[string]struct{}{
 		"state": struct{}{}, // includes all subcommands
 		"debug": struct{}{}, // includes all subcommands

help.go

@@ -28,6 +28,9 @@ func helpFunc(commands map[string]cli.CommandFactory) string {
 		}
 	}
 
+	// The output produced by this is included in the docs at
+	// website/source/docs/commands/index.html.markdown; if you
+	// change this then consider updating that to match.
 	helpText := fmt.Sprintf(`
 Usage: terraform [--version] [--help] <command> [args]
 

website/source/intro/getting-started/install.html.markdown

@@ -42,23 +42,35 @@ terminal session and checking that `terraform` is available. By executing
 
 ```
 $ terraform
-usage: terraform [--version] [--help] <command> [<args>]
+Usage: terraform [--version] [--help] <command> [args]
 
-Available commands are:
+The available commands for execution are listed below.
-    apply       Builds or changes infrastructure
+The most common, useful commands are shown first, followed by
-    destroy     Destroy Terraform-managed infrastructure
+less common or more advanced commands. If you're just getting
-    get         Download and install modules for the configuration
+started with Terraform, stick with the common commands. For the
-    graph       Create a visual graph of Terraform resources
+other commands, please read the help and docs before usage.
-    init        Initializes Terraform configuration from a module
+
-    output      Read an output from a state file
+Common commands:
-    plan        Generate and show an execution plan
+    apply              Builds or changes infrastructure
-    push        Upload this Terraform module to Atlas to run
+    destroy            Destroy Terraform-managed infrastructure
-    refresh     Update local state file against real resources
+    fmt                Rewrites config files to canonical format
-    remote      Configure remote state storage
+    get                Download and install modules for the configuration
-    show        Inspect Terraform state or plan
+    graph              Create a visual graph of Terraform resources
-    taint       Manually mark a resource for recreation
+    import             Import existing infrastructure into Terraform
-    validate    Validates the Terraform files
+    init               Initializes Terraform configuration from a module
-    version     Prints the Terraform version
+    output             Read an output from a state file
+    plan               Generate and show an execution plan
+    push               Upload this Terraform module to Atlas to run
+    refresh            Update local state file against real resources
+    remote             Configure remote state storage
+    show               Inspect Terraform state or plan
+    taint              Manually mark a resource for recreation
+    untaint            Manually unmark a resource as tainted
+    validate           Validates the Terraform files
+    version            Prints the Terraform version
+
+All other commands:
+    state              Advanced state management
 ```
 
 If you get an error that `terraform` could not be found, then your PATH