terraform-documentation-generatorlisted
Install: claude install-skill Backura/fastagent-plugins
# Terraform Documentation Generator
This skill helps generate and maintain Terraform module documentation using terraform-docs.
## When to Use
Use this skill when:
- Creating README.md for a new module
- Updating documentation after module changes
- Generating input/output reference tables automatically
- Ensuring consistent documentation across modules
## Using terraform-docs
### Installation
```bash
# macOS
brew install terraform-docs
# Linux
curl -sSLo ./terraform-docs.tar.gz https://terraform-docs.io/dl/latest/terraform-docs-linux-amd64.tar.gz
tar -xzf terraform-docs.tar.gz
chmod +x terraform-docs
mv terraform-docs /usr/local/bin/
# Or use Go
go install github.com/terraform-docs/terraform-docs@latest
```
### Basic Usage
```bash
# Generate markdown documentation
terraform-docs markdown table . > README.md
# Preview without writing
terraform-docs markdown table .
# Generate for specific directory
terraform-docs markdown table ./modules/vpc > ./modules/vpc/README.md
```
### Configuration File
Create `.terraform-docs.yml` in module root for consistent formatting:
```yaml
formatter: "markdown table"
header-from: main.tf
sections:
show:
- header
- requirements
- providers
- inputs
- outputs
- resources
content: |-
{{ .Header }}
## Usage
```hcl
module "example" {
source = "./modules/example"
# Add your example here
}
```
{{ .Requirements }}
{{ .Providers }}
{{ .Inputs }}
{{ .Outputs }}
{{ .Re