Terraform Workspaces and State Cheat Sheet

terraform workspace list

# Show available Terraform CLI workspaces for the current configuration.

terraform workspace show

# Print the current Terraform CLI workspace name.

terraform workspace new dev

# Create and switch to a new workspace.

terraform workspace select prod

# Switch to an existing workspace.

terraform workspace delete dev

# Delete a Terraform CLI workspace.

terraform import aws_s3_bucket.logs my-logs-bucket

# Associate an existing infrastructure object with a resource address in state.

terraform import -generate-config-out=generated.tf aws_s3_bucket.logs my-logs-bucket

# Generate configuration while importing supported resources.

terraform state mv aws_instance.old aws_instance.new

# Rename or move a resource address in state.

terraform state rm aws_instance.web

# Stop tracking a resource without destroying the remote object.

terraform state replace-provider hashicorp/aws registry.acme.corp/acme/aws

# Update provider source addresses recorded in state.

terraform state pull > terraform.tfstate

# Download the latest state and write it to a local file.

terraform state push terraform.tfstate

# Upload a local state file into the configured backend.

terraform state list module.network

# List resources beneath a specific module path.

terraform init -migrate-state

# Move state to a newly configured backend during re-init.

terraform init -force-copy

# Automatically copy existing state to a new backend without prompting.

terraform init -lockfile=readonly

# Use providers from the dependency lock file without updating it.

terraform plan -state=terraform.tfstate

# Use a non-default local state path for commands that support it.

.terraformignore
.git/
.terraform/
node_modules/
*.pem

# Exclude paths from uploaded configuration when using remote CLI-driven runs.

terraform {
  backend "remote" {
    organization = "acme"
    workspaces {
      name = "networking-prod"
    }
  }
}

# Example backend configuration for HCP Terraform remote state and runs.