https://deploy-preview-66--terraform-docs-live.netlify.app/reference/ Recent content in References on Hugo -- gohugo.io en-US https://deploy-preview-66--terraform-docs-live.netlify.app/reference/terraform-docs/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/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 help for terraform-docs --hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --lockfile read . https://deploy-preview-66--terraform-docs-live.netlify.app/reference/asciidoc/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/asciidoc/ 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 --hide-empty hide empty sections (default false) --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 ". https://deploy-preview-66--terraform-docs-live.netlify.app/reference/asciidoc-document/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/asciidoc-document/ Synopsis Generate AsciiDoc document of inputs and outputs. terraform-docs asciidoc document [PATH] [flags] Options -h, --help help for document Inherited Options --anchor create anchor links (default true) -c, --config string config file name (default ".terraform-docs.yml") --default show Default column or section (default true) --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") --hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --hide-empty hide empty sections (default false) --indent int indention level of AsciiDoc sections [1, 2, 3, 4, 5] (default 2) --lockfile read . https://deploy-preview-66--terraform-docs-live.netlify.app/reference/asciidoc-table/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/asciidoc-table/ Synopsis Generate AsciiDoc tables of inputs and outputs. terraform-docs asciidoc table [PATH] [flags] Options -h, --help help for table Inherited Options --anchor create anchor links (default true) -c, --config string config file name (default ".terraform-docs.yml") --default show Default column or section (default true) --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") --hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --hide-empty hide empty sections (default false) --indent int indention level of AsciiDoc sections [1, 2, 3, 4, 5] (default 2) --lockfile read . https://deploy-preview-66--terraform-docs-live.netlify.app/reference/json/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/json/ Synopsis Generate JSON of inputs and outputs. terraform-docs json [PATH] [flags] Options --escape escape special characters (default true) -h, --help help for json Inherited 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") --hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --lockfile read . https://deploy-preview-66--terraform-docs-live.netlify.app/reference/markdown/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/markdown/ Synopsis Generate Markdown of inputs and outputs. terraform-docs markdown [PATH] [flags] Options --anchor create anchor links (default true) --atx-closed close ATX style headers --default show Default column or section (default true) --escape escape special characters (default true) -h, --help help for markdown --hide-empty hide empty sections (default false) --html use HTML tags in generated output (default true) --indent int indention level of Markdown 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 ". https://deploy-preview-66--terraform-docs-live.netlify.app/reference/markdown-document/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/markdown-document/ Synopsis Generate Markdown document of inputs and outputs. terraform-docs markdown document [PATH] [flags] Options -h, --help help for document Inherited Options --anchor create anchor links (default true) --atx-closed close ATX style headers -c, --config string config file name (default ".terraform-docs.yml") --default show Default column or section (default true) --escape escape special characters (default true) --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. https://deploy-preview-66--terraform-docs-live.netlify.app/reference/markdown-table/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/markdown-table/ Synopsis Generate Markdown tables of inputs and outputs. terraform-docs markdown table [PATH] [flags] Options -h, --help help for table Inherited Options --anchor create anchor links (default true) --atx-closed close ATX style headers -c, --config string config file name (default ".terraform-docs.yml") --default show Default column or section (default true) --escape escape special characters (default true) --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. https://deploy-preview-66--terraform-docs-live.netlify.app/reference/pretty/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/pretty/ Synopsis Generate colorized pretty of inputs and outputs. terraform-docs pretty [PATH] [flags] Options --color colorize printed result (default true) -h, --help help for pretty Inherited 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") --hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --lockfile read . https://deploy-preview-66--terraform-docs-live.netlify.app/reference/tfvars/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/reference/tfvars/ Synopsis Generate terraform.tfvars of inputs. Options -h, --help help for tfvars Inherited 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") --hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources] --lockfile read .terraform.lock.hcl if exist (default true) --output-check 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 "<!