skill CX Codex

provider-docs — Claude Code skill: what it does, how to install

Q: How do I install provider-docs in Claude Code?

Run `npx skills add hashicorp/agent-skills --skill provider-docs -a claude-code`. The skill file is placed at `~/.claude/skills/provider-docs/SKILL.md`.

Q: What are the rules for HCL examples in provider documentation?

Store each example as an independent file in the `examples/` directory and reference it with `tffile`. Examples must omit `terraform`, `provider`, and `output` blocks.

Guides Terraform provider documentation workflows for the Terraform Registry. It coordinates schema descriptions, docs templates, and tfplugindocs generation.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓

npx skills add hashicorp/agent-skills --skill provider-docs -a claude-code

Open on GitHub

What provider-docs does

This skill directs how to write and maintain documentation for Terraform providers. The process starts in Go schema descriptions for arguments and computed attributes, then moves to templates in the docs/ directory. Output markdown is generated with tfplugindocs through go generate or the standalone CLI command. Every generated page gets verified against current provider code.

Strict formatting rules apply to HCL snippets. Sample configurations belong in the examples/ folder, isolated to one scenario per file and imported via tffile. They cannot include terraform, provider, or output blocks. When documenting actions introduced in Terraform v1.14.0+, templates must link action and action_trigger lifecycle wiring without attribute sections. Ignoring these details causes broken rendering in the public Registry.

Publication requires specific release metadata. The root folder must hold terraform-registry-manifest.json, and release tags must follow semantic versioning with a v prefix such as v1.2.3 from the default branch. Missing manifest files or non-standard branch tags prevent the Registry from parsing doc updates.

What it helps with

structure docs templates for new provider resources and functions
align Go schema attribute descriptions with generated registry pages
clean HCL examples of disallowed provider and terraform blocks
run tfplugindocs generation across provider schema changes
verify registry manifest and release tag formatting before publishing

Example prompts for the agent

Update provider documentation templates for our new data source and run tfplugindocs
Audit HCL snippets in the examples directory against Terraform Registry requirements
Set up an action template with action_trigger lifecycle wiring for Terraform v1.14.0+

How to install provider-docs

1Skills CLI (Vercel)

npx skills add hashicorp/agent-skills --skill provider-docs -a claude-code

2Manually: put the files in place

~/.claude/skills/provider-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/provider-docs/

1Skills CLI (Vercel)

npx skills add hashicorp/agent-skills --skill provider-docs -a codex

2Manually: put the files in place

.agents/skills/provider-docs/SKILL.md

For all projects use ~/.agents/skills/

1Skills CLI (Vercel)

npx skills add hashicorp/agent-skills --skill provider-docs -a cursor

2Manually: put the files in place

.cursor/skills/provider-docs/SKILL.md

Cursor also reads .agents/skills/ and .claude/skills/

1GitHub CLI

gh skill install hashicorp/agent-skills provider-docs

2Manually: put the files in place

.github/skills/provider-docs/SKILL.md

1Skills CLI (Vercel)

npx skills add hashicorp/agent-skills --skill provider-docs -a gemini-cli

2Platform CLI

gemini skills install https://github.com/hashicorp/agent-skills --path plugins/terraform/skills/provider-docs

Manually: put the files in place

.devin/skills/provider-docs/SKILL.md

The legacy .windsurf/skills/ path still works

Skills CLI (Vercel)

npx skills add hashicorp/agent-skills --skill provider-docs -a opencode

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about provider-docs

How do I install provider-docs in Claude Code?

Run npx skills add hashicorp/agent-skills --skill provider-docs -a claude-code. The skill file is placed at ~/.claude/skills/provider-docs/SKILL.md.

What does provider-docs do?

It walks agents through crafting provider docs, writing schema descriptions, maintaining templates, and running tfplugindocs for Terraform Registry.

What are the rules for HCL examples in provider documentation?

Store each example as an independent file in the examples/ directory and reference it with tffile. Examples must omit terraform, provider, and output blocks.

terraform-skill Anton Babenko Guides Terraform and OpenTofu refactoring, state migrations, and CI workflows. Diagnoses risks like identity churn and blast radius before generating HCL. CX Codex +1 7,400installs terraform-validator akin-ozer Runs terraform fmt, validate, tflint and checkov over your .tf files, then writes a report with the findings. CX Codex +1 640installs terraform-generator akin-ozer This skill writes Terraform configs: resources, modules, providers, variables and outputs. Useful when you want infrastructure as code without hand-writing HCL. CX Codex +1 639installs terraform-patterns Alireza Rezvani Analyzes Terraform code for anti-patterns and scaffolds structured modules. Useful when hardening state backends or fixing security misconfigurations. 617installs infisical-terraform Infisical Walks your agent through the Infisical Terraform provider: provider auth, ephemeral secrets that stay out of state, and OIDC for Terraform Cloud. CX Codex +1 478installs terraform official HashiCorp Adds the Terraform MCP server to Claude, so the agent can work with Terraform configs and Infrastructure as Code without leaving the chat. ★ 44,635repo stars

From the same set16

new-terraform-provider A skill that walks the agent through bootstrapping a Terraform provider on the Plugin Framework, from directory layout to a passing build. CX Codex +1 3,900installs run-acceptance-tests Runs and investigates Terraform provider acceptance tests with the TestAcc prefix. Use it for missing environment variables, failed runs, or tests that pass when they should not. CX Codex +1 3,700installs provider-test-patterns A skill that guides acceptance testing for Terraform providers using terraform-plugin-testing and the Plugin Framework. CX Codex +1 3,300installs azure-verified-modules A skill that carries the Azure Verified Modules requirements, so your agent can write and review Terraform modules that pass AVM certification. CX Codex +1 3,300installs aws-ami-builder A skill that walks your agent through building Amazon Machine Images with Packer and the amazon-ebs builder — template, source AMI filters, build commands. CX Codex +1 3,200installs push-to-registry Teaches AI assistants how to register Packer build details in HCP. Useful for tracking machine image lifecycles and linking artifacts directly to Terraform. CX Codex +1 3,000installs windows-builder A skill for building Windows images with Packer over WinRM and PowerShell provisioners. Useful for Windows AMIs, Azure images and VMware templates. CX Codex +1 2,700installs terraform-policy Creates and tests Terraform Policy files, and converts Sentinel rules into Terraform Policy. Use it when policy files or their test cases need changes. CX Codex +1 1,500installs