# terraform-docs/terraform-docs

Generate documentation from Terraform modules in various output formats

Repository: https://github.com/terraform-docs/terraform-docs
Canonical: https://ross.abutalabs.com/products/terraform-docs
Homepage: https://terraform-docs.io
Language: Go
License: MIT
License Family: permissive
Topics: terraform, terraform-docs, terraform-modules, documentation, generator, golang
Last push: 2026-08-03T06:52:24+00:00

## Health v2 (maintenance only)
Score: 83/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 95, release rhythm 59, longevity 100
- inputs: {"age_days": 3734, "days_push": 30, "days_rel": 115, "gap_med": 116, "n_releases_24m": 6}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4814, forks 601 (observed 2026-08-28T04:09:00.312916+00:00)

## What it is
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
- artifact type: cli-tool
- maturity: stable
- function: documentation, cli, developer-tools
- domain: infrastructure-as-code, developer-tools, documentation
- platform: windows, bsd, cli, go
- tags: terraform, terraform-modules, doc-generator, markdown, ci-friendly, infrastructure-as-code, devops, linux, macos, docker

## Member repositories
- terraform-docs/terraform-docs (main) score 83

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:00.312916+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:18:34.979113+00:00, confidence not recorded.
  - readme: https://github.com/terraform-docs/terraform-docs (fetched 2026-08-28T04:09:00.312916+00:00, sha 68d4fb207489)
  - homepage: https://terraform-docs.io (fetched 2026-08-29T09:01:41.310281+00:00, sha 4c7d6d8cae50)
  - site_page: https://terraform-docs.io/user-guide/installation (fetched 2026-08-29T09:01:41.319256+00:00, sha 229c0948af17)
  - site_page: https://terraform-docs.io/reference/terraform-docs (fetched 2026-08-29T09:01:41.321359+00:00, sha 8a43f0072598)
- Data as of 2026-08-30T08:39:29.467469+00:00.