Merge #10347: Update CLI usage information on the website
This commit is contained in:
commit
b5df653779
|
@ -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
|
||||
|
|
3
help.go
3
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]
|
||||
|
||||
|
|
|
@ -42,13 +42,21 @@ 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.
|
||||
The most common, useful commands are shown first, followed by
|
||||
less common or more advanced commands. If you're just getting
|
||||
started with Terraform, stick with the common commands. For the
|
||||
other commands, please read the help and docs before usage.
|
||||
|
||||
Common commands:
|
||||
apply Builds or changes infrastructure
|
||||
destroy Destroy Terraform-managed infrastructure
|
||||
fmt Rewrites config files to canonical format
|
||||
get Download and install modules for the configuration
|
||||
graph Create a visual graph of Terraform resources
|
||||
import Import existing infrastructure into Terraform
|
||||
init Initializes Terraform configuration from a module
|
||||
output Read an output from a state file
|
||||
plan Generate and show an execution plan
|
||||
|
@ -57,8 +65,12 @@ Available commands are:
|
|||
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
|
||||
|
|
Loading…
Reference in New Issue