github.com/rstandt/terraform@v0.12.32-0.20230710220336-b1063613405c/website/docs/commands/index.html.markdown

github.com/rstandt/terraform@v0.12.32-0.20230710220336-b1063613405c/website/docs/commands/index.html.markdown (about)

1 ---
2 layout: "docs"
3 page_title: "Commands"
4 sidebar_current: "docs-commands"
5 description: |-
6 Terraform is controlled via a very easy to use command-line interface (CLI). Terraform is only a single command-line application: terraform. This application then takes a subcommand such as "apply" or "plan". The complete list of subcommands is in the navigation to the left.
7 ---
8
9 # Terraform Commands (CLI)
10
11 Terraform is controlled via a very easy to use command-line interface (CLI).
12 Terraform is only a single command-line application: terraform. This application
13 then takes a subcommand such as "apply" or "plan". The complete list of subcommands
14 is in the navigation to the left.
15
16 The terraform CLI is a well-behaved command line application. In erroneous cases,
17 a non-zero exit status will be returned. It also responds to -h and --help as you'd
18 most likely expect.
19
20 To view a list of the available commands at any time, just run terraform with no arguments:
21
22 ```text
23 $ terraform
24 Usage: terraform [-version] [-help] <command> [args]
25
26 The available commands for execution are listed below.
27 The most common, useful commands are shown first, followed by
28 less common or more advanced commands. If you're just getting
29 started with Terraform, stick with the common commands. For the
30 other commands, please read the help and docs before usage.
31
32 Common commands:
33 apply Builds or changes infrastructure
34 console Interactive console for Terraform interpolations
35 destroy Destroy Terraform-managed infrastructure
36 env Workspace management
37 fmt Rewrites config files to canonical format
38 get Download and install modules for the configuration
39 graph Create a visual graph of Terraform resources
40 import Import existing infrastructure into Terraform
41 init Initialize a Terraform working directory
42 output Read an output from a state file
43 plan Generate and show an execution plan
44 providers Prints a tree of the providers used in the configuration
45 refresh Update local state file against real resources
46 show Inspect Terraform state or plan
47 taint Manually mark a resource for recreation
48 untaint Manually unmark a resource as tainted
49 validate Validates the Terraform files
50 version Prints the Terraform version
51 workspace Workspace management
52
53 All other commands:
54 0.12upgrade Rewrites pre-0.12 module source code for v0.12
55 debug Debug output management (experimental)
56 force-unlock Manually unlock the terraform state
57 push Obsolete command for Terraform Enterprise legacy (v1)
58 state Advanced state management
59 ```
60
61 To get help for any specific command, pass the -h flag to the relevant subcommand. For example,
62 to see help about the graph subcommand:
63
64 ```text
65 $ terraform graph -h
66 Usage: terraform graph [options] PATH
67
68 Outputs the visual graph of Terraform resources. If the path given is
69 the path to a configuration, the dependency graph of the resources are
70 shown. If the path is a plan file, then the dependency graph of the
71 plan itself is shown.
72
73 The graph is outputted in DOT format. The typical program that can
74 read this format is GraphViz, but many web services are also available
75 to read this format.
76 ```
77
78 ## Shell Tab-completion
79
80 If you use either `bash` or `zsh` as your command shell, Terraform can provide
81 tab-completion support for all command names and (at this time) _some_ command
82 arguments.
83
84 To add the necessary commands to your shell profile, run the following command:
85
86 ```bash
87 terraform -install-autocomplete
88 ```
89
90 After installation, it is necessary to restart your shell or to re-read its
91 profile script before completion will be activated.
92
93 To uninstall the completion hook, assuming that it has not been modified
94 manually in the shell profile, run the following command:
95
96 ```bash
97 terraform -uninstall-autocomplete
98 ```
99
100 Currently not all of Terraform's subcommands have full tab-completion support
101 for all arguments. We plan to improve tab-completion coverage over time.
102
103 ## Upgrade and Security Bulletin Checks
104
105 The Terraform CLI commands interact with the HashiCorp service
106 [Checkpoint](https://checkpoint.hashicorp.com/) to check for the availability
107 of new versions and for critical security bulletins about the current version.
108
109 One place where the effect of this can be seen is in `terraform version`, where
110 it is used by default to indicate in the output when a newer version is
111 available.
112
113 Only anonymous information, which cannot be used to identify the user or host,
114 is sent to Checkpoint. An anonymous ID is sent which helps de-duplicate warning
115 messages. Both the anonymous id and the use of checkpoint itself are completely
116 optional and can be disabled.
117
118 Checkpoint itself can be entirely disabled for all HashiCorp products by
119 setting the environment variable `CHECKPOINT_DISABLE` to any non-empty value.
120
121 Alternatively, settings in
122 [the CLI configuration file](/docs/commands/cli-config.html) can be used to
123 disable checkpoint features. The following checkpoint-related settings are
124 supported in this file:
125
126 * `disable_checkpoint` - set to `true` to disable checkpoint calls
127 entirely. This is similar to the `CHECKPOINT_DISABLE` environment variable
128 described above.
129
130 * `disable_checkpoint_signature` - set to `true` to disable the use of an
131 anonymous signature in checkpoint requests. This allows Terraform to check
132 for security bulletins but does not send the anonymous signature in these
133 requests.
134
135 [The Checkpoint client code](https://github.com/hashicorp/go-checkpoint) used
136 by Terraform is available for review by any interested party.