Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

terraform -help and apply -help do not show -replace options #36779

Open
drewmullen opened this issue Mar 26, 2025 · 0 comments · May be fixed by #36780
Open

terraform -help and apply -help do not show -replace options #36779

drewmullen opened this issue Mar 26, 2025 · 0 comments · May be fixed by #36780
Labels
documentation new new issue not yet triaged

Comments

@drewmullen
Copy link
Contributor

Terraform Version

tf -version
Terraform v1.11.

Affected Pages

tf apply -h
Usage: terraform [global options] apply [options] [PLAN]

  Creates or updates infrastructure according to Terraform configuration
  files in the current directory.

  By default, Terraform will generate a new plan and present it for your
  approval before taking any action. You can optionally provide a plan
  file created by a previous call to "terraform plan", in which case
  Terraform will take the actions described in that plan without any
  confirmation prompt.

Options:

  -auto-approve          Skip interactive approval of plan before applying.

  -backup=path           Path to backup the existing state file before
                         modifying. Defaults to the "-state-out" path with
                         ".backup" extension. Set to "-" to disable backup.

  -compact-warnings      If Terraform produces any warnings that are not
                         accompanied by errors, show them in a more compact
                         form that includes only the summary messages.

  -destroy               Destroy Terraform-managed infrastructure.
                         The command "terraform destroy" is a convenience alias
                         for this option.

  -lock=false            Don't hold a state lock during the operation. This is
                         dangerous if others might concurrently run commands
                         against the same workspace.

  -lock-timeout=0s       Duration to retry a state lock.

  -input=true            Ask for input for variables if not directly set.

  -no-color              If specified, output won't contain any color.

  -parallelism=n         Limit the number of parallel resource operations.
                         Defaults to 10.

  -state=path            Path to read and save state (unless state-out
                         is specified). Defaults to "terraform.tfstate".

  -state-out=path        Path to write state to that is different than
                         "-state". This can be used to preserve the old
                         state.
                         
  -var 'foo=bar'         Set a value for one of the input variables in the root
                         module of the configuration. Use this option more than
                         once to set more than one variable.

  -var-file=filename     Load variable values from the given file, in addition
                         to the default files terraform.tfvars and *.auto.tfvars.
                         Use this option more than once to include more than one
                         variables file.

  If you don't provide a saved plan file then this command will also accept
  all of the plan-customization options accepted by the terraform plan command.
  For more information on those options, run:
      terraform plan -help

taint is shown but thats deprecated...

tf -help | grep taint
  taint         Mark a resource instance as not fully functional
  untaint       Remove the 'tainted' state from a resource instance

What is the docs issue?

the -help command should show -replace

Proposal

the -help command should show -replace

References

No response

@drewmullen drewmullen added documentation new new issue not yet triaged labels Mar 26, 2025
@drewmullen drewmullen changed the title terraform -help and apply -help do not show -replace options terraform -help and apply -help do not show -replace options Mar 26, 2025
@drewmullen drewmullen linked a pull request Mar 26, 2025 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation new new issue not yet triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant