terraform-docs
A utility to generate documentation from Terraform modules in various output formats.
What is terraform-docs?
terraform-docs is a command-line utility that automatically generates documentation for Terraform modules. It extracts information from .tf files—such as variables, outputs, providers, and resources—and formats it into structured documentation. This solves the problem of outdated or missing documentation in infrastructure-as-code projects by keeping docs in sync with the actual Terraform configuration.
Terraform developers and DevOps engineers who manage infrastructure-as-code and need to maintain accurate, up-to-date module documentation for their teams or public modules.
Developers choose terraform-docs because it automates a tedious manual process, supports multiple output formats and integrations (like pre-commit hooks and GitHub Actions), and offers extensive customization through configuration files and plugins, making it highly adaptable to different documentation standards.
Overview
Generate documentation from Terraform modules in various output formats
Use Cases
Best For
- Automatically generating README files for Terraform modules
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
