Terraform style guide

Applies HashiCorp's Terraform style conventions: standard file split, formatting, naming, typed variables, for_each over count, pinned versions and secrets kept out of state. Use when writing, reviewing or generating Terraform HCL.

DevOpsPack: HashiCorp skillslinkterraform-style-guide
Author
Source
hashicorp/agent-skills/plugins/terraform/skills/terraform-style-guide @ 5e30fa5
License
MPL-2.0

About this skill

What it does

The skill turns HashiCorp's Terraform style guide into rules for writing and reviewing HCL. Code goes into a standard file split: terraform.tf, providers.tf, main.tf, variables.tf, outputs.tf, locals.tf. Formatting means two-space indents, aligned equals signs, meta-arguments first and lifecycle last. Names are lowercase with underscores, singular, without the resource type, and main for a lone resource. Every variable needs type and description, every output a description; for_each is preferred over count, which stays for on/off resources. State, .terraform/ and plan files stay out of git; .terraform.lock.hcl goes in.

SECURITY.md in the folder adds hardening defaults (encryption at rest, private networking, least-privilege security groups, logging) and an order for secrets: the resource's own secrets-manager option first, such as manage_master_user_password on RDS; then an ephemeral resource feeding a write-only _wo attribute, from Terraform 1.11; a plain resource that leaves the secret in state only as a last resort.

It ends with a review checklist and terraform fmt -recursive plus terraform validate before a commit; tflint, checkov and tfsec are optional extras. Examples use the AWS provider.

When to use it, and when not

Use it when the agent writes a new configuration or module, or to check existing .tf files against HashiCorp's conventions.

It is a checklist, not a scanner: it reads neither plan nor state. Stacks, tests and policy files have their own skills in this pack.

How to run it

We do not copy this skill: its files are under MPL-2.0, a file-level copyleft licence outside the set we copy under. Install it from HashiCorp's repository with the button to the source: one skill via npx skills add hashicorp/agent-skills/plugins/terraform/skills/terraform-style-guide, or the whole terraform plugin with 16 skills, in Claude Code claude plugin marketplace add hashicorp/agent-skills and claude plugin install terraform@hashicorp. In Codex: codex plugin marketplace add hashicorp/agent-skills, then install terraform from /plugins and start a new session. In Claude Code, the plugin's skill may appear with a prefix, as /terraform:terraform-style-guide.

  • Claude Code: /terraform-style-guide, or ask for the skill by name.
  • Codex: $terraform-style-guide.
  • Cursor: type / in the Agent chat and pick terraform-style-guide.

Example: /terraform-style-guide Write a module for an S3 bucket with versioning and KMS encryption, split into the standard files.

How it differs from similar skills

Outside this pack the catalog has no Terraform skill. Kubernetes manifest review is the nearest in kind: an infrastructure checklist, but for K8s YAML, with a findings table and server-side dry runs. Azure Verified Modules for Terraform is a stricter MUST/SHOULD rule set for Azure modules seeking AVM certification, and Refactor Terraform into modules relies on this skill for the style of the modules it creates.

Install

This skill is not copied to the catalog: its licence allows a copy only under the same licence, and the catalog does not copy under such licences. Install it from the author's repository.

Open the source

Connect through AnyModel API

This skill runs on whatever model your agent uses. Point Claude Code, Codex or Cursor at AnyModel to run it on Claude, GPT, Gemini and more with one key — pay per token, no subscription.

More from the pack HashiCorp skills

Terraform tests

Writes and runs Terraform's native tests in .tftest.hcl files: run blocks, assertions, plan and apply modes, expect_failures, mock providers and CI pipelines. Use when adding tests to a Terraform module or fixing a failing terraform test.

Terraform Stacks

Writes Terraform Stacks configurations for HCP Terraform: components in .tfcomponent.hcl, deployments in .tfdeploy.hcl, OIDC identity tokens, auto-approve rules, linked Stacks and API monitoring. Use when building or debugging a Stack.

Refactor Terraform into modules

Splits a monolithic Terraform configuration into a reusable module with a typed interface, then migrates state with moved blocks or terraform state mv so nothing is recreated. Use when a root config has grown too large or repeats itself.

Terraform search and import

Finds existing cloud resources with Terraform Search queries in .tfquery.hcl, generates resource and import blocks, and falls back to manual import for unsupported types. Use when bringing hand-made infrastructure under Terraform.

Terraform policy files

Writes, converts and tests HCP Terraform policy files (.policy.hcl, .policytest.hcl), including Sentinel-to-tfpolicy conversion with a quality label per policy. Use when writing a new policy, porting Sentinel or debugging a policy test.

Azure Verified Modules for Terraform

Applies the 37 Azure Verified Modules requirements to Terraform modules: provider versions, sources, naming, variables, outputs, breaking changes and repository rules. Use when writing or reviewing an Azure module meant for AVM certification.

Terraform provider resources

Guides writing Terraform provider resources and data sources on the Plugin Framework: schema, CRUD, not-found handling, import, waiters for eventually consistent APIs and minimum tests. Use when adding, changing or reviewing a provider resource.

Terraform provider test patterns

Covers acceptance tests for Terraform providers with terraform-plugin-testing: test steps, state and plan checks, import, disappears and regression tests, sweepers and ephemeral resources. Use when writing, reviewing or debugging provider acceptance tests.

AWS AMIs with Packer

Builds Amazon Machine Images with Packer's amazon-ebs builder from a ready HCL template, with source filters, multi-region copies, credentials and fixes for common build errors. Use when creating a custom AMI for EC2.