A utility to generate documentation from Terraform modules in various output formats
A utility to generate documentation from Terraform modules in various output formats
--header-from string relative path of a file to read header from (default "main.tf")
-h, --help help for terraform-docs
--no-header do not show module header
--no-inputs do not show inputs
--no-outputs do not show outputs
--no-providers do not show providers
--no-requirements do not show module requirements
--no-sort do no sort items
--output-values inject output values into outputs
--output-values-from string inject output values from file into outputs
--sort-by-required sort items by name and print required ones first
--sort-inputs-by-required [deprecated] use '--sort-by-required' instead
--with-aggregate-type-defaults [deprecated] print default values of aggregate types
- terraform-docs json - Generate JSON of inputs and outputs
- terraform-docs markdown - Generate Markdown of inputs and outputs
- terraform-docs markdown document - Generate Markdown document of inputs and outputs
- terraform-docs markdown table - Generate Markdown tables of inputs and outputs
- terraform-docs pretty - Generate colorized pretty of inputs and outputs
- terraform-docs tfvars - Generate terraform.tfvars of inputs
- terraform-docs tfvars hcl - Generate HCL format of terraform.tfvars of inputs
- terraform-docs tfvars json - Generate JSON format of terraform.tfvars of inputs
- terraform-docs xml - Generate XML of inputs and outputs
- terraform-docs yaml - Generate YAML of inputs and outputs