mirror of
https://github.com/opentofu/opentofu.git
synced 2025-02-25 18:45:20 -06:00
update command docs
This commit is contained in:
parent
af2e289212
commit
7cfb515a03
@ -31,6 +31,10 @@ The command-line flags are all optional. The list of available flags are:
|
|||||||
* `-backup=path` - Path to the backup file. Defaults to `-state-out` with
|
* `-backup=path` - Path to the backup file. Defaults to `-state-out` with
|
||||||
the ".backup" extension. Disabled by setting to "-".
|
the ".backup" extension. Disabled by setting to "-".
|
||||||
|
|
||||||
|
* `-lock=true` - Lock the state file when locking is supported.
|
||||||
|
|
||||||
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
||||||
|
|
||||||
* `-input=true` - Ask for input for variables if not directly set.
|
* `-input=true` - Ask for input for variables if not directly set.
|
||||||
|
|
||||||
* `-no-color` - Disables output with coloring.
|
* `-no-color` - Disables output with coloring.
|
||||||
|
@ -42,6 +42,17 @@ The command-line flags are all optional. The list of available flags are:
|
|||||||
|
|
||||||
* `-input=true` - Whether to ask for input for provider configuration.
|
* `-input=true` - Whether to ask for input for provider configuration.
|
||||||
|
|
||||||
|
* `-lock=true` - Lock the state file when locking is supported.
|
||||||
|
|
||||||
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
||||||
|
|
||||||
|
* `-no-color` - If specified, output won't contain any color.
|
||||||
|
|
||||||
|
* `-provider=provider` - Specified provider to use for import. This is used for
|
||||||
|
specifying provider aliases, such as "aws.eu". This defaults to the normal
|
||||||
|
provider based on the prefix of the resource being imported. You usually
|
||||||
|
don't need to specify this.
|
||||||
|
|
||||||
* `-state=path` - The path to read and save state files (unless state-out is
|
* `-state=path` - The path to read and save state files (unless state-out is
|
||||||
specified). Ignored when [remote state](/docs/state/remote.html) is used.
|
specified). Ignored when [remote state](/docs/state/remote.html) is used.
|
||||||
|
|
||||||
@ -49,11 +60,6 @@ The command-line flags are all optional. The list of available flags are:
|
|||||||
the state path. Ignored when [remote state](/docs/state/remote.html) is
|
the state path. Ignored when [remote state](/docs/state/remote.html) is
|
||||||
used.
|
used.
|
||||||
|
|
||||||
* `-provider=provider` - Specified provider to use for import. This is used for
|
|
||||||
specifying provider aliases, such as "aws.eu". This defaults to the normal
|
|
||||||
provider based on the prefix of the resource being imported. You usually
|
|
||||||
don't need to specify this.
|
|
||||||
|
|
||||||
* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag
|
* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag
|
||||||
can be set multiple times. Variable values are interpreted as
|
can be set multiple times. Variable values are interpreted as
|
||||||
[HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
|
[HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
|
||||||
|
@ -33,8 +33,8 @@ Common commands:
|
|||||||
apply Builds or changes infrastructure
|
apply Builds or changes infrastructure
|
||||||
console Interactive console for Terraform interpolations
|
console Interactive console for Terraform interpolations
|
||||||
destroy Destroy Terraform-managed infrastructure
|
destroy Destroy Terraform-managed infrastructure
|
||||||
|
env Environment management
|
||||||
fmt Rewrites config files to canonical format
|
fmt Rewrites config files to canonical format
|
||||||
force-unlock Manually unlock the terraform state
|
|
||||||
get Download and install modules for the configuration
|
get Download and install modules for the configuration
|
||||||
graph Create a visual graph of Terraform resources
|
graph Create a visual graph of Terraform resources
|
||||||
import Import existing infrastructure into Terraform
|
import Import existing infrastructure into Terraform
|
||||||
@ -51,6 +51,7 @@ Common commands:
|
|||||||
|
|
||||||
All other commands:
|
All other commands:
|
||||||
debug Debug output management (experimental)
|
debug Debug output management (experimental)
|
||||||
|
force-unlock Manually unlock the terraform state
|
||||||
state Advanced state management
|
state Advanced state management
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -54,6 +54,15 @@ The command-line flags are all optional. The list of available flags are:
|
|||||||
* `-input=true` - Ask for input interactively if necessary. If this is false
|
* `-input=true` - Ask for input interactively if necessary. If this is false
|
||||||
and input is required, `init` will error.
|
and input is required, `init` will error.
|
||||||
|
|
||||||
|
* `-lock=true` - Lock the state file when locking is supported.
|
||||||
|
|
||||||
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
||||||
|
|
||||||
|
* `-no-color` - If specified, output won't contain any color.
|
||||||
|
|
||||||
|
* `-force-copy` - Suppress prompts about copying state data. This is equivalent
|
||||||
|
to providing a "yes" to all confirmation prompts.
|
||||||
|
|
||||||
## Backend Config
|
## Backend Config
|
||||||
|
|
||||||
The `-backend-config` can take a path or `key=value` pair to specify additional
|
The `-backend-config` can take a path or `key=value` pair to specify additional
|
||||||
|
@ -39,6 +39,10 @@ The command-line flags are all optional. The list of available flags are:
|
|||||||
|
|
||||||
* `-input=true` - Ask for input for variables if not directly set.
|
* `-input=true` - Ask for input for variables if not directly set.
|
||||||
|
|
||||||
|
* `-lock=true` - Lock the state file when locking is supported.
|
||||||
|
|
||||||
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
||||||
|
|
||||||
* `-module-depth=n` - Specifies the depth of modules to show in the output.
|
* `-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 does not affect the plan itself, only the output shown. By default,
|
||||||
this is -1, which will expand all.
|
this is -1, which will expand all.
|
||||||
|
@ -31,6 +31,14 @@ 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
|
||||||
|
|
||||||
|
* `-input=true` - Ask for input for variables if not directly set.
|
||||||
|
|
||||||
|
* `-lock=true` - Lock the state file when locking is supported.
|
||||||
|
|
||||||
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
||||||
|
|
||||||
|
* `-no-color` - If specified, output won't contain any color.
|
||||||
|
|
||||||
* `-state=path` - Path to read and write the state file to. Defaults to "terraform.tfstate".
|
* `-state=path` - Path to read and write the state file to. Defaults to "terraform.tfstate".
|
||||||
Ignored when [remote state](/docs/state/remote.html) is used.
|
Ignored when [remote state](/docs/state/remote.html) is used.
|
||||||
|
|
||||||
|
@ -47,6 +47,10 @@ The command-line flags are all optional. The list of available flags are:
|
|||||||
* `-backup=path` - Path to the backup file. Defaults to `-state-out` with
|
* `-backup=path` - Path to the backup file. Defaults to `-state-out` with
|
||||||
the ".backup" extension. Disabled by setting to "-".
|
the ".backup" extension. Disabled by setting to "-".
|
||||||
|
|
||||||
|
* `-lock=true` - Lock the state file when locking is supported.
|
||||||
|
|
||||||
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
||||||
|
|
||||||
* `-module=path` - The module path where the resource to taint exists.
|
* `-module=path` - The module path where the resource to taint exists.
|
||||||
By default this is the root path. Other modules can be specified by
|
By default this is the root path. Other modules can be specified by
|
||||||
a period-separated list. Example: "foo" would reference the module
|
a period-separated list. Example: "foo" would reference the module
|
||||||
|
@ -47,6 +47,10 @@ certain cases, see above note). The list of available flags are:
|
|||||||
time, there is a maxiumum of one tainted instance per resource, so this flag
|
time, there is a maxiumum of one tainted instance per resource, so this flag
|
||||||
can be safely omitted.
|
can be safely omitted.
|
||||||
|
|
||||||
|
* `-lock=true` - Lock the state file when locking is supported.
|
||||||
|
|
||||||
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
||||||
|
|
||||||
* `-module=path` - The module path where the resource to untaint exists.
|
* `-module=path` - The module path where the resource to untaint exists.
|
||||||
By default this is the root path. Other modules can be specified by
|
By default this is the root path. Other modules can be specified by
|
||||||
a period-separated list. Example: "foo" would reference the module
|
a period-separated list. Example: "foo" would reference the module
|
||||||
|
@ -54,8 +54,8 @@ Common commands:
|
|||||||
apply Builds or changes infrastructure
|
apply Builds or changes infrastructure
|
||||||
console Interactive console for Terraform interpolations
|
console Interactive console for Terraform interpolations
|
||||||
destroy Destroy Terraform-managed infrastructure
|
destroy Destroy Terraform-managed infrastructure
|
||||||
|
env Environment management
|
||||||
fmt Rewrites config files to canonical format
|
fmt Rewrites config files to canonical format
|
||||||
force-unlock Manually unlock the terraform state
|
|
||||||
get Download and install modules for the configuration
|
get Download and install modules for the configuration
|
||||||
graph Create a visual graph of Terraform resources
|
graph Create a visual graph of Terraform resources
|
||||||
import Import existing infrastructure into Terraform
|
import Import existing infrastructure into Terraform
|
||||||
@ -72,6 +72,7 @@ Common commands:
|
|||||||
|
|
||||||
All other commands:
|
All other commands:
|
||||||
debug Debug output management (experimental)
|
debug Debug output management (experimental)
|
||||||
|
force-unlock Manually unlock the terraform state
|
||||||
state Advanced state management
|
state Advanced state management
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user