02/28/2023 14:30 | Category: terraform

Tags: documentationgenerator

terraform documentation generator

When using Terraform it's great to have documentation on variables, resources, and outputs. It makes for a simple README.md addition that adds value to the folder housing your infrastructure - making things easier to understand at a glance.

A great tool that I've been introducted to is terraform-docs.

Example command usage

Note: the command below is append only so it will duplicate output on multiple executions

Terraform documentation command:

terraform-docs markdown table --sort-by required . >> README.md)