terraform-docs Documentation

website·Indexed Apr 11, 2026

terraform-docs generates documentation from Terraform modules in multiple formats including Markdown, AsciiDoc, JSON, TOML, XML, and YAML. The tool is configurable via .terraform-docs.yml or CLI flags, supporting features like recursive submodule generation, custom Go templates, footer/header extraction, and CI integration via GitHub Actions or pre-commit hooks. It requires Terraform >= 0.15 and supports version constraints for compatibility.