terraform-docs ☆
« Back to VersTracker
Description:
Tool to generate documentation from Terraform modules
Type: Formula  |  Tracked Since: Dec 28, 2025
Links: Homepage  |  formulae.brew.sh
Category: Devops
Tags: terraform devops documentation infrastructure-as-code cli
Install: brew install terraform-docs
About:
terraform-docs is a command-line tool that automatically generates documentation for Terraform modules. It parses variable, output, and resource definitions to produce structured outputs like Markdown, JSON, or HTML. This streamlines infrastructure documentation, ensuring it stays in sync with code changes.
Key Features:
  • Supports multiple output formats (Markdown, JSON, HTML, Table)
  • Highly configurable via .terraform-docs.yml file
  • Integrates with CI/CD pipelines for automated doc generation
  • Extracts inputs, outputs, providers, and resources
Use Cases:
  • Generating README.md files for shared Terraform modules
  • Creating standardized documentation for infrastructure-as-code repositories
  • Automating documentation updates in GitHub Actions workflows
Alternatives:
  • Infracost – Focuses on cost estimation rather than documentation generation.
  • Terraform – Native CLI has basic 'terraform-docs' functionality but lacks advanced formatting and configurability.
Version History
Detected Version Rev Change Commit
Sep 12, 2025 4:09am 0 VERSION_BUMP 4d927704
Nov 10, 2024 3:04pm 0 VERSION_BUMP 503aa530
Sep 18, 2024 7:09pm 0 VERSION_BUMP 79355df0
« Back to VersTracker  |  Browse Packages  |  About