terraform-docs/terraform-docs

Health v2 · maintenance only

Adoption not part of the score

4814 stars · 601 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

terraform-docs is a CLI utility that generates documentation from Terraform modules in various output formats such as Markdown, AsciiDoc, JSON, and pretty text. It extracts inputs, outputs, providers, and resources from Terraform code and can inject generated docs into README files, including via a GitHub Action for CI automation.

Use cases

• generate README documentation for a Terraform module
• document terraform module inputs and outputs automatically
• inject terraform docs into markdown file in CI
• output terraform module docs as or asciidoc
• keep terraform module documentation up to date in pull requests
• recursively generate docs for terraform submodules

When to choose

• you maintain Terraform modules and want auto-generated, consistent documentation
• you want CI-friendly doc generation with output checking and injection into READMEs
• you need multiple output formats (Markdown, AsciiDoc, JSON) or plugin-based custom formatters

When to avoid

• you need documentation for non-Terraform infrastructure code
• you want hand-authored, free-form architecture docs rather than extracted module metadata

Facets

cli-tool · maturity stable

documentation cli developer-tools infrastructure-as-code developer-tools documentation windows bsd cli go terraform terraform-modules doc-generator markdown ci-friendly infrastructure-as-code devops linux macos docker

Member repositories

For agents

markdown · JSON · MCP: product_card(name="terraform-docs/terraform-docs")