terraform-docs

Generate documentation from Terraform modules automatically

brewmacoslinux

Try with needOr install directly

About

Tool to generate documentation from Terraform modules

terraform-docs

Generate markdown documentation for a Terraform module in current directory$ terraform-docs markdown . > README.md

Generate JSON output of module documentation$ terraform-docs json ./module-path

Update existing README.md with auto-generated documentation$ terraform-docs markdown . --output-file README.md