Difference between revisions of "Terraform --help"

From wikieduonline
Jump to navigation Jump to search
(Created page with "<pre> terraform --help Usage: terraform [-version] [-help] <command> [args] The available commands for execution are listed below. The most common, useful commands are shown...")
 
Line 37: Line 37:
 
     state              Advanced state management
 
     state              Advanced state management
 
</pre>
 
</pre>
 +
 +
 +
Main commands:
 +
  [[terraform init|init]]          Prepare your working directory for other commands
 +
  [[terraform validate|validate]]      Check whether the configuration is valid
 +
  [[terraform plan|plan]]          Show changes required by the current configuration
 +
  [[terraform apply|apply]]        Create or update infrastructure
 +
  [[terraform destroy|destroy]]      Destroy previously-created infrastructure
 +
 +
All other commands:
 +
  console      Try Terraform expressions at an interactive command prompt
 +
  fmt          Reformat your configuration in the standard style
 +
  force-unlock  Release a stuck lock on the current workspace
 +
  get          Install or upgrade remote Terraform modules
 +
  graph        Generate a Graphviz graph of the steps in an operation
 +
  import        Associate existing infrastructure with a Terraform resource
 +
  login        Obtain and save credentials for a remote host
 +
  logout        Remove locally-stored credentials for a remote host
 +
  output        Show output values from your root module
 +
  providers    Show the providers required for this configuration
 +
  refresh      Update the state to match remote systems
 +
  [[terraform show|show]]          Show the current state or a saved plan
 +
  [[terraform state|state]]        Advanced state management
 +
  taint        Mark a resource instance as not fully functional
 +
  untaint      Remove the 'tainted' state from a resource instance
 +
  version      Show the current Terraform version
 +
  workspace    Workspace management
 +
 +
Global options (use these before the subcommand, if any):
 +
  -chdir=DIR    Switch to a different working directory before executing the
 +
                given subcommand.
 +
  -help        Show this help output, or the help for a specified subcommand.
 +
  -version      An alias for the "version" subcommand.
 +
 +
 +
 +
Older versions:
 +
    [[terraform apply|apply]]              Builds or changes infrastructure
 +
    console            Interactive console for Terraform interpolations
 +
    destroy            Destroy Terraform-managed infrastructure
 +
    [[terraform fmt|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              Initialize a new or existing Terraform configuration
 +
    output            Read an output from a state file
 +
    plan              Generate and show an execution plan
 +
    providers          Prints a tree of the providers used in the configuration
 +
    push              Upload this Terraform module to Terraform Enterprise to run
 +
    refresh            Update local state file against real resources
 +
    [[terraform show|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
 +
    [[terraform version|version]]            Prints the Terraform version
 +
    workspace          Workspace management
 +
 +
All other commands:
 +
    0.12upgrade        Rewrites pre-0.12 module source code for v0.12
 +
    0.13upgrade        Rewrites pre-0.13 module source code for v0.13
 +
    debug              Debug output management (experimental)
 +
    force-unlock      Manually unlock the terraform state
 +
    push              Obsolete command for Terraform Enterprise legacy (v1)
 +
    state              Advanced state management
 +
  
 
== See also ==
 
== See also ==

Revision as of 09:39, 26 April 2021

terraform --help
Usage: terraform [-version] [-help] <command> [args]

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
    console            Interactive console for Terraform interpolations
    destroy            Destroy Terraform-managed infrastructure
    env                Workspace management
    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               Initialize a Terraform working directory
    output             Read an output from a state file
    plan               Generate and show an execution plan
    providers          Prints a tree of the providers used in the configuration
    refresh            Update local state file against real resources
    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
    workspace          Workspace management

All other commands:
    0.12upgrade        Rewrites pre-0.12 module source code for v0.12
    debug              Debug output management (experimental)
    force-unlock       Manually unlock the terraform state
    push               Obsolete command for Terraform Enterprise legacy (v1)
    state              Advanced state management


Main commands:
  init          Prepare your working directory for other commands
  validate      Check whether the configuration is valid
  plan          Show changes required by the current configuration
  apply         Create or update infrastructure
  destroy       Destroy previously-created infrastructure

All other commands:
  console       Try Terraform expressions at an interactive command prompt
  fmt           Reformat your configuration in the standard style
  force-unlock  Release a stuck lock on the current workspace
  get           Install or upgrade remote Terraform modules
  graph         Generate a Graphviz graph of the steps in an operation
  import        Associate existing infrastructure with a Terraform resource
  login         Obtain and save credentials for a remote host
  logout        Remove locally-stored credentials for a remote host
  output        Show output values from your root module
  providers     Show the providers required for this configuration
  refresh       Update the state to match remote systems
  show          Show the current state or a saved plan
  state         Advanced state management
  taint         Mark a resource instance as not fully functional
  untaint       Remove the 'tainted' state from a resource instance
  version       Show the current Terraform version
  workspace     Workspace management

Global options (use these before the subcommand, if any):

 -chdir=DIR    Switch to a different working directory before executing the
               given subcommand.
 -help         Show this help output, or the help for a specified subcommand.
 -version      An alias for the "version" subcommand.


Older versions:

    apply              Builds or changes infrastructure
    console            Interactive console for Terraform interpolations
    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               Initialize a new or existing Terraform configuration
    output             Read an output from a state file
    plan               Generate and show an execution plan
    providers          Prints a tree of the providers used in the configuration
    push               Upload this Terraform module to Terraform Enterprise to run
    refresh            Update local state file against real resources
    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
    workspace          Workspace management

All other commands:
    0.12upgrade        Rewrites pre-0.12 module source code for v0.12
    0.13upgrade        Rewrites pre-0.13 module source code for v0.13
    debug              Debug output management (experimental)
    force-unlock       Manually unlock the terraform state
    push               Obsolete command for Terraform Enterprise legacy (v1)
    state              Advanced state management


See also

Advertising: