terraform-docs is a utility to generate documentation from Terraform modules in various output formats. The terraform-docs configuration file uses the yaml format in order to override any default behaviors. This is a convenient way to share the configuration amongst teammates, CI, or other toolings. Once you set it up and configured it, every time you or your teammates want to regenerate documentation (manually, through a pre-commit hook, or as part of a CI pipeline) all you need to do is run terraform-docs /module/path. One of the most popular format is markdown table, which is a very good fit for generating README of module. terraform-docs is available on Linux, macOS, Windows, and FreeBSD platforms. terraform-docs will locate any available configuration file without needing to explicitly pass the --config flag.
Features
- As of v0.13.0, --config flag accepts both relative and absolute paths
- terraform-docs is available on Linux, macOS, Windows, and FreeBSD platforms
- terraform-docs can be run as a container by mounting a directory
- Stable binaries are available on the GitHub Release page
- The latest version can be installed using go install
- You can use a config file with any arbitrary name