mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
52653b5107
* Fix: No longer crashes when there are special chars in a variable default * Do not escape chars everywhere * Cleanup go.mod
2.7 KiB
2.7 KiB
terraform-docs
A utility to generate documentation from Terraform modules in various output formats
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")
--header-from string relative path of a file to read header from (default "main.tf")
-h, --help help for terraform-docs
--hide strings hide section [header, inputs, outputs, providers, requirements]
--hide-all hide all sections (default false)
--output-values inject output values into outputs (default false)
--output-values-from string inject output values from file into outputs (default "")
--show strings show section [header, inputs, outputs, providers, requirements]
--show-all show all sections (default true)
--sort sort items (default true)
--sort-by-required sort items by name and print required ones first (default false)
--sort-by-type sort items by type of them (default false)
SEE ALSO
- terraform-docs asciidoc - Generate AsciiDoc of inputs and outputs
- terraform-docs asciidoc document - Generate AsciiDoc document of inputs and outputs
- terraform-docs asciidoc table - Generate AsciiDoc tables of inputs and outputs
- 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 toml - Generate TOML of inputs and outputs
- terraform-docs xml - Generate XML of inputs and outputs
- terraform-docs yaml - Generate YAML of inputs and outputs