GeekIt

Terraform命令速查

版本安装、init 初始化、fmt 与 validate、plan/apply/destroy、state 与 import、变量输出、工作区后端、调试与报错排查等 127 条命令

共 127 条命令 · 12 类场景 · 点击右侧图标可复制

命令 / 配置说明复制
terraform version查看当前版本
terraform version -jsonJSON 输出,便于脚本判断版本
terraform -help查看所有子命令
terraform -install-autocomplete安装 shell 自动补全
brew install terraformmacOS 安装
apt install terraformDebian/Ubuntu 安装(需官方源)
choco install terraformWindows 安装
tfenv install 1.9.5 && tfenv use 1.9.5用 tfenv 管理多版本,团队统一版本首选
.terraform-version 文件锁定版本配合 tfenv 自动切换,避免版本漂移
required_version = ">= 1.6.0"在 terraform 块中约束版本
命令 / 配置说明复制
terraform init下载 provider、初始化后端与模块
terraform init -upgrade升级 provider 与模块到允许的最新版本
terraform init -reconfigure后端配置变更后强制重新初始化
terraform init -migrate-state切换后端时迁移已有 state
terraform init -backend-config="bucket=my-tfstate" -backend-config="key=prod/terraform.tfstate"后端参数外置,便于多环境
terraform init -backend=false只下载 provider,不初始化后端(CI 校验常用)
terraform init -get=false跳过模块下载
terraform init -input=false非交互模式,CI 必加
terraform init -plugin-dir=./plugins从本地目录加载 provider,离线环境使用
.terraform.lock.hcl 必须提交到仓库锁定 provider 版本与校验和,保证环境一致
命令 / 配置说明复制
terraform fmt格式化当前目录的 .tf 文件
terraform fmt -recursive递归格式化子目录
terraform fmt -check只检查是否符合格式,CI 中返回非零即失败
terraform fmt -check -recursive -diff检查并显示差异,PR 流水线常用
terraform validate语法与引用校验(需先 init)
terraform validate -jsonJSON 输出,便于流水线解析
tflint第三方静态检查,覆盖 provider 规则与最佳实践
terraform fmt 与 validate 是 CI 第一道门能挡掉大部分低级错误
命令 / 配置说明复制
terraform plan生成执行计划,不实际改动资源
terraform plan -out=tfplan保存计划文件,后续 apply 直接使用
terraform plan -var="instance_type=t3.large"命令行传变量
terraform plan -var-file=prod.tfvars按环境变量文件规划
terraform plan -target=module.vpc只规划指定资源或模块(慎用,易造成不一致)
terraform plan -refresh=false跳过刷新,快速预览配置差异
terraform plan -destroy预览销毁会做什么
terraform plan -detailed-exitcode0 无变更、1 出错、2 有变更,CI 判断用
terraform plan -parallelism=20调整并发度,大项目提速
terraform plan -lock=false跳过状态锁(仅排障时使用)
terraform plan -replace=aws_instance.web强制重建指定资源
terraform plan -compact-warnings精简告警输出
命令 / 配置说明复制
terraform apply执行计划并交互确认
terraform apply tfplan按保存的计划文件执行,避免二次确认漂移
terraform apply -auto-approve跳过确认,CI 中使用需谨慎
terraform apply -var-file=prod.tfvars指定变量文件应用
terraform apply -target=module.app只应用指定模块
terraform apply -parallelism=20提高并发
terraform apply -refresh-only只同步 state 与真实资源,不改基础设施
terraform apply -replace=aws_instance.web重建资源
terraform destroy销毁全部受管资源(先确认 state 与工作区)
terraform destroy -target=module.test只销毁指定模块
terraform destroy -auto-approve无人值守销毁,务必加保护措施
production 环境建议 plan 与 apply 分离计划文件审核后再执行,避免误操作
命令 / 配置说明复制
terraform state list列出 state 中所有资源地址
terraform state show aws_instance.web查看单个资源的属性
terraform state mv aws_instance.old aws_instance.new重命名资源地址,避免被销毁重建
terraform state mv module.a module.b移动整个模块
terraform state rm aws_instance.web从 state 移除(资源仍存在,后续会“孤儿”)
terraform state pull > backup.tfstate导出远端 state 做备份
terraform state push backup.tfstate推送 state 并更新版本号
terraform state replace-provider hashicorp/aws registry.example.com/aws替换 provider 源地址(私有仓库迁移)
terraform force-unlock <LOCK_ID>强制解锁 state,确认无人操作后执行
state 是唯一事实来源删除 state 等于丢失资源映射,操作前务必备份
命令 / 配置说明复制
terraform import aws_instance.web i-1234567890abcdef0把已有资源纳入管理
terraform import module.vpc.aws_vpc.main vpc-xxxx导入到模块中的资源地址
import { to = aws_instance.web id = "i-1234567890abcdef0" }声明式 import 块(1.5+),可版本化管理
terraform plan -generate-config-out=generated.tf为 import 块自动生成配置代码
terraform state rm aws_instance.web不再管理但保留资源,等价于“反导入”
removed { from = aws_instance.web lifecycle { destroy = false } }声明式移除(1.7+),避免误删
terraform apply -refresh-only把真实属性同步进 state
导入后先 plan 确认无差异有差异说明配置与真实资源不一致,需要对齐
批量导入配合 for_each 与脚本逐个手写太慢,可用 CLI 输出生成配置
命令 / 配置说明复制
terraform output列出所有输出变量
terraform output -jsonJSON 输出,交给脚本处理
terraform output -raw vpc_id只输出值,适合 shell 变量赋值
terraform output -json | jq -r .vpc_id.value按字段取值
terraform console交互式求值,调试表达式很方便
export TF_VAR_region=ap-east-1环境变量传变量
terraform.tfvars 与 *.auto.tfvars 自动加载自动加载的文件不要放敏感信息
变量优先级:环境变量 < terraform.tfvars < *.auto.tfvars < -var/-var-file同名后面的覆盖前面的
sensitive = true标记敏感输出,日志中会打码
validation 块校验变量取值范围在 variables 中提前拦截非法值
命令 / 配置说明复制
terraform workspace list列出工作区
terraform workspace new prod创建并切换到新工作区
terraform workspace select prod切换工作区(同一后端不同 state)
terraform workspace show查看当前工作区,执行前先确认
terraform workspace delete staging删除空工作区
backend "s3" { bucket = "my-tfstate" key = "prod/terraform.tfstate" region = "ap-east-1" dynamodb_table = "tf-lock" }S3 后端 + DynamoDB 锁,团队协作标准做法
backend "azurerm" / "gcs" / "http"其他常见后端类型
terraform init -migrate-state切换后端时迁移 state
terraform login登录 Terraform Cloud / HCP
后端配置要开加密与版本控制state 含敏感信息,桶权限必须收紧
命令 / 配置说明复制
terraform providers列出当前配置使用的 provider 树
terraform providers lock -platform=linux_amd64 -platform=darwin_arm64为多平台生成校验和,跨平台开发必备
terraform providers mirror ./vendor离线镜像 provider
terraform providers schema -json导出 schema,做代码生成或校验
terraform get下载模块
terraform get -update更新模块到最新允许版本
module "vpc" { source = "terraform-aws-modules/vpc/aws" version = "5.8.1" }引用公共模块并锁版本
module "app" { source = "./modules/app" }引用本地模块
terraform init -upgrade升级模块与 provider
provider 版本约束写在 required_providers避免自动升级到不兼容版本
命令 / 配置说明复制
export TF_LOG=DEBUG开启详细日志,排查 provider 调用
export TF_LOG_PATH=/tmp/terraform.log日志落盘,便于检索
export TF_LOG_PROVIDER=TRACE只对 provider 开 TRACE,日志量更可控
terraform plan -detailed-exitcode用退出码判断是否有变更,CI 门禁用
terraform show -json tfplan | jq结构化查看计划内容
terraform show -json | jq .values查看当前 state 的 JSON 结构
terraform graph | dot -Tpng > graph.png输出依赖图,排查循环依赖
terraform validate -json机器可读的校验结果
terraform apply -auto-approve -input=falseCI 标准执行方式
terraform plan -lock-timeout=60s等待锁释放,减少并发冲突
terraform apply -parallelism=1串行执行,排查资源竞争
命令 / 配置说明复制
Error acquiring the state lock他人正在操作或上次异常退出,确认后用 force-unlock 解锁
state snapshot was created by Terraform vX, which is newer than current本地版本过低,升级 Terraform
Backend initialization required, please run "terraform init"后端配置变动或未初始化
provider registry.terraform.io/hashicorp/xxx: not foundprovider 名称写错或网络不可达,检查 required_providers
no valid credential sources for S3 Backend found缺少云凭据,配置环境变量或 profile
Cycle: aws_instance.a, aws_instance.b循环依赖,用 terraform graph 定位并拆分
Unsupported argument / Invalid reference参数名写错或引用不存在的资源,结合 validate 修正
Error: resource already exists资源已存在但 state 没有,先 import
Provider produced inconsistent result after applyprovider bug 或 API 回写差异,升级 provider 或加 ignore_changes
Failed to install provider网络或镜像问题,配置 plugin_cache_dir 或离线镜像
Module not installed未执行 init 或模块源不可达
Invalid legacy provider address0.12 升级遗留,执行 terraform state replace-provider
版本约束冲突多个模块要求不同大版本,统一升级或放宽约束
plan 显示大量无意义变更多为 provider 默认值或 API 回写,用 ignore_changes 处理
apply 中途失败修复后重新 apply 即可,state 已记录部分结果;不要手改 state

运维常用组合

新项目初始化写 backend 与 required_providers → terraform init → fmt → validate → plan -out → apply tfplan
日常变更git pull → terraform init -upgrade → plan -detailed-exitcode → 审核计划 → apply tfplan
接管已有资源import 块 → plan -generate-config-out → 对齐配置 → plan 确认无差异 → apply
重构资源地址terraform state mv → plan 应显示无变更 → 提交代码 → 团队同步
多环境隔离独立 backend key 或 workspace → -var-file 区分参数 → workspace show 确认 → 执行
故障排查TF_LOG=DEBUG → terraform validate → terraform graph → state list/show → 必要时 pull 备份

常见问题排查

1. plan 与 apply 分离

生产环境先出计划文件,人工审核后再 apply tfplan,避免执行时状态漂移

2. state 必须远端化

本地 state 无法协作且有丢失风险,用 S3/GCS 后端并开启锁

3. 锁文件纳入仓库

.terraform.lock.hcl 提交后各环境 provider 版本一致

4. 慎用 -target

只影响局部资源,容易造成 state 与配置不一致,仅作应急

5. sensitive 要打标

输出与变量标记 sensitive,避免密码出现在 CI 日志

6. 改动前备份 state

state pull 存档,配合版本控制可以快速回退到可用状态

共 127 条 Terraform 命令 · 示例中的桶名、后端与资源地址请替换为实际环境

关于Terraform命令速查

在线 Terraform 命令速查手册,按安装与版本、初始化 init、格式化与校验、计划 plan、应用与销毁、状态 state 管理、导入与移除、输出与变量、工作区与后端、Provider 与模块、调试与自动化、常见报错与排查等 12 类场景整理 140+ 条常用命令与配置片段,每条附中文说明与可直接复制的写法,支持关键词搜索、分类折叠和一键复制,打开网页即可查阅。涵盖 terraform version/-help/-install-autocomplete 与 tfenv 与 required_version、init 的 -upgrade/-reconfigure/-migrate-state/-backend-config/-backend=false/-get=false/-input=false/-plugin-dir 与 .terraform.lock.hcl、fmt 的 -recursive/-check/-diff 与 validate/-json 与 tflint、plan 的 -out/-var/-var-file/-target/-refresh=false/-destroy/-detailed-exitcode/-parallelism/-lock=false/-replace/-compact-warnings、apply 的计划文件/auto-approve/-target/-parallelism/-refresh-only/-replace 与 destroy/-target/-auto-approve、state 的 list/show/mv/rm/pull/push/replace-provider 与 force-unlock、import 命令与 import 块与 plan -generate-config-out 与 removed 块、output 的 -json/-raw 与 console 与 TF_VAR_ 与 tfvars 自动加载与变量优先级与 sensitive 与 validation、workspace 的 list/new/select/show/delete 与 backend s3/azurerm/gcs/http 与 DynamoDB 锁与 terraform login、providers 的 lock -platform 与 mirror 与 schema -json 与 get/-update 与 module source/version 与 required_providers、TF_LOG/TF_LOG_PATH/TF_LOG_PROVIDER 与 show -json 与 graph | dot 与 -lock-timeout 与 -parallelism=1,以及 Error acquiring the state lock、state snapshot newer、Backend initialization required、provider not found、no valid credential sources、Cycle 循环依赖、Unsupported argument、resource already exists、Provider produced inconsistent result、Failed to install provider、Module not installed、Invalid legacy provider address 等报错排查。适用于 Terraform 基础设施即代码实践、多云资源编排、state 远端化与团队协作、资源重构与导入、多环境工作区隔离、CI/CD 流水线集成、plan 审核与安全变更,以及 DevOps 与云原生运维面试复习。

核心能力

  • 涵盖 terraform version/-help/-install-autocomplete 与 tfenv 与 required_version、init 的 -upgrade/-reconfigure/-migrate-state/-backend-config/-backend=false/-get=false/-input=false/-plugin-dir 与 .terraform.lock.hcl、fmt 的 -recursive/-check/-diff 与 validate/-json 与 tflint、plan 的 -out/-var/-var-file/-target/-refresh=false/-destroy/-detailed-exitcode/-parallelism/-lock=false/-replace/-compact-warnings、apply 的计划文件/auto-approve/-target/-parallelism/-refresh-only/-replace 与 destroy/-target/-auto-approve、state 的 list/show/mv/rm/pull/push/replace-provider 与 force-unlock、import 命令与 import 块与 plan -generate-config-out 与 removed 块、output 的 -json/-raw 与 console 与 TF_VAR_ 与 tfvars 自动加载与变量优先级与 sensitive 与 validation、workspace 的 list/new/select/show/delete 与 backend s3/azurerm/gcs/http 与 DynamoDB 锁与 terraform login、providers 的 lock -platform 与 mirror 与 schema -json 与 get/-update 与 module source/version 与 required_providers、TF_LOG/TF_LOG_PATH/TF_LOG_PROVIDER 与 show -json 与 graph | dot 与 -lock-timeout 与 -parallelism=1,以及 Error acquiring the state lock、state snapshot newer、Backend initialization required、provider not found、no valid credential sources、Cycle 循环依赖、Unsupported argument、resource already exists、Provider produced inconsistent result、Failed to install provider、Module not installed、Invalid legacy provider address 等报错排查

适用场景

适用于 Terraform 基础设施即代码实践、多云资源编排、state 远端化与团队协作、资源重构与导入、多环境工作区隔离、CI/CD 流水线集成、plan 审核与安全变更,以及 DevOps 与云原生运维面试复习。Terraform命令速查全程在浏览器中完成,无需安装插件,可放心用于日常办公与排障。

常见问题

Terraform命令速查是免费的吗?需要注册或安装吗?
Terraform命令速查完全免费,无需注册、无需下载安装任何软件,用浏览器打开网页即可直接使用,也不限制使用次数。
Terraform命令速查支持哪些功能?
涵盖 terraform version/-help/-install-autocomplete 与 tfenv 与 required_version、init 的 -upgrade/-reconfigure/-migrate-state/-backend-config/-backend=false/-get=false/-input=false/-plugin-dir 与 .terraform.lock.hcl、fmt 的 -recursive/-check/-diff 与 validate/-json 与 tflint、plan 的 -out/-var/-var-file/-target/-refresh=false/-destroy/-detailed-exitcode/-parallelism/-lock=false/-replace/-compact-warnings、apply 的计划文件/auto-approve/-target/-parallelism/-refresh-only/-replace 与 destroy/-target/-auto-approve、state 的 list/show/mv/rm/pull/push/replace-provider 与 force-unlock、import 命令与 import 块与 plan -generate-config-out 与 removed 块、output 的 -json/-raw 与 console 与 TF_VAR_ 与 tfvars 自动加载与变量优先级与 sensitive 与 validation、workspace 的 list/new/select/show/delete 与 backend s3/azurerm/gcs/http 与 DynamoDB 锁与 terraform login、providers 的 lock -platform 与 mirror 与 schema -json 与 get/-update 与 module source/version 与 required_providers、TF_LOG/TF_LOG_PATH/TF_LOG_PROVIDER 与 show -json 与 graph | dot 与 -lock-timeout 与 -parallelism=1,以及 Error acquiring the state lock、state snapshot newer、Backend initialization required、provider not found、no valid credential sources、Cycle 循环依赖、Unsupported argument、resource already exists、Provider produced inconsistent result、Failed to install provider、Module not installed、Invalid legacy provider address 等报错排查。
Terraform命令速查适合哪些场景使用?
适用于 Terraform 基础设施即代码实践、多云资源编排、state 远端化与团队协作、资源重构与导入、多环境工作区隔离、CI/CD 流水线集成、plan 审核与安全变更,以及 DevOps 与云原生运维面试复习。