terraform · HashiCorp
Terraform CLI Agent 使用指南
格式化、校验、规划和应用基础设施,并明确区分 plan 与 apply 风险。
官方工具操作风险: R0–R3docs-verified
为 Agent 安装
选择与运行环境匹配的官方安装方式。在团队或 CI 环境中固定版本,并先运行版本检查。
用于稳定自动化的结构化输出
优先使用机器可读格式,并把 stdout 作为结果、stderr 作为诊断信息分别处理。
R0–R3 命令风险指南
风险按单条命令判断。R0 是本地或远程只读,R1 是可逆的本地写入,R2 会改变远程状态,R3 可能造成不可逆或生产级影响。
只读不等于可公开
R0 只表示命令不更改本地或远程状态。只读命令仍可能返回令牌、身份信息、配置或生产数据;只展示完成任务所需的最少内容,不得写入日志、Prompt 或提交内容。
Agent Readiness 评分依据
适配度描述 Agent 操作工具的稳定程度,不代表所有命令都安全,也不替代独立执行测试。
文档证据对应的 Agent Readiness 为 87/100;尚未记录本地执行测试。
生成 Skill 或 Agent 策略
选择目标 Agent 和安全模式,生成包含安装、允许命令、确认边界与证据说明的可复制产物。
生成结果预览
SKILL.md
---
name: terraform-agent-workflow
description: Use Terraform CLI for infrastructure planning, state inspection, provider workflows with explicit command risk and evidence boundaries.
---
# Terraform CLI agent workflow
Use this skill when the task needs infrastructure planning, state inspection, provider workflows, reviewable plans.
## Evidence boundary
- Registry confidence: `docs-verified`
- Documentation checked: `2026-07-10`
- Locally tested version: `not tested`
- Do not describe this CLI as locally verified until its commands have actually been executed in an isolated environment.
## Executed smoke checks
- No local execution record is available.
## Installation
- Homebrew (macos, linux): `brew tap hashicorp/tap && brew install hashicorp/tap/terraform`
- winget (windows): `winget install Hashicorp.Terraform`
## Authentication
- Methods: provider credentials, Terraform Cloud token, workload identity
- Secret environment variables: `TF_TOKEN_app_terraform_io`, `TF_CLI_CONFIG_FILE`
- Minimum permissions: Use read-only provider credentials for validate and plan, and separate apply credentials by environment.
- Credential storage: For headless runs, inject TF_TOKEN_app_terraform_io, TF_CLI_CONFIG_FILE from the CI or platform secret manager at process start. For local interactive use, prefer the CLI or operating-system credential store when the official client supports one. Never save values in repository files.
- Never print, persist, or commit credential values.
## Allowed commands (read-only)
- `terraform validate -json` — R0: Checks local configuration syntax and internal consistency.
- `terraform plan -out=tfplan` — R0: Refreshes state and writes a reviewable local plan file without applying changes.
## Commands requiring explicit approval (read-only)
- None recorded.
## Forbidden commands (read-only)
- R2 `terraform apply tfplan` — Changes remote infrastructure exactly as recorded in the plan.
- R3 `terraform destroy` — Deletes managed infrastructure resources.
## Execution rules
1. Mode boundary: R0 exact commands may be used; R1, R2, and R3 commands are forbidden.
2. Confirm the selected account, project, context, database, namespace, or environment before any command.
3. Prefer structured output using `show -json`, `output -json`.
4. Capture the exact command, exit code, stdout, and stderr separately.
5. A generated prefix policy must prompt unless that exact prefix is explicitly marked suffix-safe; do not infer safety from the executable name.
6. Never broaden credentials or disable safety controls to make a command succeed.
## Official sources
- [Terraform CLI documentation](https://developer.hashicorp.com/terraform/cli)
- [Terraform CLI documentation source repository](https://github.com/hashicorp/terraform)
验证记录与官方证据
CLI Finder 分开记录文档检查和真实执行。未执行过的安装、帮助、退出码与输出不能标为 Verified。