Skip to content

Latest commit

 

History

History
55 lines (48 loc) · 2.56 KB

terraform-docs.md

File metadata and controls

55 lines (48 loc) · 2.56 KB
Raw
title description menu weight toc
terraform-docs
A utility to generate documentation from Terraform modules in various output formats.
docs
parent
reference
950
true

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 [footer, header, inputs, modules, outputs, providers, requirements, resources]
      --hide-all                    hide all sections (default false)
      --output-file string          File in module directory 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               inject output values into outputs (default false)
      --output-values-from string   inject output values from file into outputs (default "")
      --show strings                show section [footer, 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]({{< ref "asciidoc" >}})
    • [terraform-docs asciidoc document]({{< ref "asciidoc-document" >}})
    • [terraform-docs asciidoc table]({{< ref "asciidoc-table" >}})
  • [terraform-docs json]({{< ref "json" >}})
  • [terraform-docs markdown]({{< ref "markdown" >}})
    • [terraform-docs markdown document]({{< ref "markdown-document" >}})
    • [terraform-docs markdown table]({{< ref "markdown-table" >}})
  • [terraform-docs pretty]({{< ref "pretty" >}})
  • [terraform-docs tfvars]({{< ref "tfvars" >}})
    • [terraform-docs tfvars hcl]({{< ref "tfvars-hcl" >}})
    • [terraform-docs tfvars json]({{< ref "tfvars-json" >}})
  • [terraform-docs toml]({{< ref "toml" >}})
  • [terraform-docs xml]({{< ref "xml" >}})
  • [terraform-docs yaml]({{< ref "yaml" >}})