Generate Markdown of inputs and outputs
Generate Markdown of inputs and outputs
terraform-docs markdown [PATH] [flags]
-h, --help help for markdown
--indent int indention level of Markdown sections [1, 2, 3, 4, 5] (default 2)
--no-escape do not escape special characters
--no-required do not show "Required" column or section
--no-sensitive do not show "Sensitive" column or section
--header-from string relative path of a file to read header from (default "main.tf")
--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 markdown document - Generate Markdown document of inputs and outputs
- terraform-docs markdown table - Generate Markdown tables of inputs and outputs