mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
3d39a94e39
Two new flags are added: '--default bool' and '--type bool' to control the visibility of Default and Type columns and section respectively in Markdown and AsciiDoc. Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
1.9 KiB
1.9 KiB
title, description, menu, weight, toc
| title | description | menu | weight | toc | ||||
|---|---|---|---|---|---|---|---|---|
| asciidoc | Generate AsciiDoc of inputs and outputs. |
|
951 | true |
Synopsis
Generate AsciiDoc of inputs and outputs.
terraform-docs asciidoc [PATH] [flags]
Options
--anchor create anchor links (default true)
--default show Default column or section (default true)
-h, --help help for asciidoc
--indent int indention level of AsciiDoc sections [1, 2, 3, 4, 5] (default 2)
--required show Required column or section (default true)
--sensitive show Sensitive column or section (default true)
--type show Type column or section (default true)
Inherited 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")
--hide strings hide section [header, inputs, modules, outputs, providers, requirements, resources]
--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, modules, outputs, providers, requirements, resources]
--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)
Subcommands
- [terraform-docs asciidoc document]({{< ref "asciidoc-document" >}})
- [terraform-docs asciidoc table]({{< ref "asciidoc-table" >}})