terraform-docs
A utility to generate documentation from Terraform modules in various output formats.
Overview
terraform-docs is a utility that generates documentation for Terraform modules. It inspects the module's variables, outputs, and other metadata and generates documentation in various formats like Markdown, JSON, and YAML. This helps to keep the documentation for your modules up-to-date and consistent.
✨ Key Features
- Generates documentation for Terraform modules
- Supports multiple output formats (Markdown, JSON, YAML, etc.)
- Customizable templates
- Can be run in a CI/CD pipeline
🎯 Key Differentiators
- Focus on a single task: generating documentation for Terraform modules.
- Highly customizable output formats and templates.
- Easy to integrate into automated workflows.
Unique Value: Automates the creation of documentation for Terraform modules, saving time and ensuring consistency.
🎯 Use Cases (3)
✅ Best For
- Using pre-commit hooks to automatically update module documentation on every commit.
💡 Check With Vendor
Verify these considerations match your specific requirements:
- Generating documentation for entire infrastructure projects (it's focused on modules).
💻 Platforms
✅ Offline Mode Available
🔌 Integrations
💰 Pricing
Free tier: Open source and free to use.
🔄 Similar Tools in Terraform Modules
Gruntwork
Provides a library of reusable, production-grade Terraform modules and DevOps expertise....
Cloud Posse
Offers a massive library of open-source Terraform modules and a framework for building production-gr...
terraform-aws-modules
Open-source Terraform modules for provisioning AWS resources....
Claranet
A managed services provider that publishes and maintains a collection of open-source Terraform modul...
compliance.tf
A private Terraform registry that validates and remediates modules to ensure they meet compliance st...
HashiCorp AWS Modules
A set of Terraform modules for AWS services, officially published and maintained by HashiCorp....