mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
8c531b6544
As of `v0.13.0` flags `--show-all` and `--hide-all` are deprecated in
favor of explicit use of `--show` and `--hide`. In other words when
`--show <section>` is used, only `<section>` will be shown. If you want
to show multiple sections and hide the rest you can specify multiple
`--show` flags. The same logic is also applied to `--hide`.
# show 'inputs' and hide everything else
$ terraform-docs --show inputs <formatter>
# show 'inputs' and show 'outputs' and hide everything else
$ terraform-docs --show inputs --show outputs <formatter>
# hide 'header' and show everything else
$ terraform-docs --hide header <formatter>
# hide 'header' and hide 'providers' and show everything else
$ terraform-docs --hide header --hide providers <formatter>
Note: Using `--show` or `--hide` CLI flag will completely override the
values from `.terraform-docs.yml`. Example:
$ cat .terraform-docs.yml
sections:
show:
- inputs
- outputs
# example 1: this will only show 'providers'
$ terraform-docs --show providers .
# example 2: this will hide 'inputs' and hide 'providers' and show everything else
$ terraform-docs --hide inputs --hide providers .
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
3.2 KiB
3.2 KiB
title, description, menu, weight, toc
| title | description | menu | weight | toc | ||||
|---|---|---|---|---|---|---|---|---|
| tfvars hcl | Generate HCL format of terraform.tfvars of inputs. |
|
960 | true |
Synopsis
Generate HCL format of terraform.tfvars of inputs.
terraform-docs tfvars hcl [PATH] [flags]
Options
--description show Descriptions on variables
-h, --help help for hcl
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 [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
--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 [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
--sort sort items (default true)
--sort-by string sort items by criteria [name, required, type] (default "name")
Example
Given the examples module:
terraform-docs tfvars hcl --footer-from footer.md ./examples/
generates the following output:
bool-1 = true
bool-2 = false
bool-3 = true
bool_default_false = false
input-with-code-block = [
"name rack:location"
]
input-with-pipe = "v1"
input_with_underscores = ""
list-1 = [
"a",
"b",
"c"
]
list-2 = ""
list-3 = []
list_default_empty = []
long_type = {
"bar": {
"bar": "bar",
"foo": "bar"
},
"buzz": [
"fizz",
"buzz"
],
"fizz": [],
"foo": {
"bar": "foo",
"foo": "foo"
},
"name": "hello"
}
map-1 = {
"a": 1,
"b": 2,
"c": 3
}
map-2 = ""
map-3 = {}
no-escape-default-value = "VALUE_WITH_UNDERSCORE"
number-1 = 42
number-2 = ""
number-3 = "19"
number-4 = 15.75
number_default_zero = 0
object_default_empty = {}
string-1 = "bar"
string-2 = ""
string-3 = ""
string-special-chars = "\\.<>[]{}_-"
string_default_empty = ""
string_default_null = ""
string_no_default = ""
unquoted = ""
with-url = ""