terraform-doc-generator
OfficialAuto-generate Terraform module docs with examples.
AuthorGuicedEE
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Terraform module documentation is often manual, inconsistent, and time-consuming to maintain. This skill automates the generation of complete README.md files by extracting variables, outputs, resources, and provider requirements to produce a polished, consistent document.
Core Features & Use Cases
- Auto-generate a comprehensive README.md for Terraform modules, including sections for usage, inputs, outputs, requirements, providers, and resources.
- Parse Terraform files (main.tf, variables.tf, outputs.tf, versions.tf) to surface metadata and produce accurate tables and examples.
- Support a range of module structures and provide ready-to-edit example content for quick start and onboarding.
Quick Start
Run the generator against your Terraform module to produce a complete README.md with sections for inputs, outputs, requirements, and usage examples.
Dependency Matrix
Required Modules
None requiredComponents
scripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: terraform-doc-generator Download link: https://github.com/GuicedEE/ai-rules/archive/main.zip#terraform-doc-generator Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.