terraform-docs
Synopsis
A utility to generate documentation from Terraform modules in various output formats.
terraform-docs [PATH] [flags]
Options
-c, --config string config file name (default ".terraform-docs.yml")
--footer-from string relative path of a file to read footer from (default "")
--header-from string relative path of a file to read header from (default "main.tf")
-h, --help[=true|false] help for terraform-docs
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
--lockfile[=true|false] read .terraform.lock.hcl if exist (default true)
--output-check[=true|false] check if content of output file is up to date (default false)
--output-file string file path to insert output into (default "")
--output-mode string output to file method [inject, replace] (default "inject")
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
--output-values[=true|false] inject output values into outputs (default false)
--output-values-from string inject output values from file into outputs (default "")
--read-comments[=true|false] use comments as description when description is empty (default true)
--recursive[=true|false] update submodules recursively (default false)
--recursive-exclude strings exclude directories from recursive update
--recursive-include-main[=true|false] include the main module (default true)
--recursive-path string submodules path to recursively update (default "modules")
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
--sort[=true|false] sort items (default true)
--sort-by string sort items by criteria [name, required, type] (default "name")