terraform-docs terraform-docs

terraform-docs terraform-docs

    • Introduction
    • Installation
      • content
      • footer-from
      • formatter
      • header-from
      • output
      • output-values
      • recursive
      • sections
      • settings
      • sort
      • version
    • CLI Flag 'false' value
    • Configuration File
    • Visibility of Sections
    • Insert Output To File
    • Include Examples
    • Recursive Submodules
    • Generate terraform.tfvars
    • GitHub Action
    • pre-commit Hooks
    • Plugins
    • Contributing
    • terraform-docs
      • asciidoc
        • asciidoc document
        • asciidoc table
      • json
      • markdown
        • markdown document
        • markdown table
      • pretty
      • tfvars
        • tfvars hcl
        • tfvars json
      • toml
      • xml
      • yaml

Socials

  • GitHub

    • GitHub
      • Introduction
      • Installation
        • content
        • footer-from
        • formatter
        • header-from
        • output
        • output-values
        • recursive
        • sections
        • settings
        • sort
        • version
      • CLI Flag 'false' value
      • Configuration File
      • Visibility of Sections
      • Insert Output To File
      • Include Examples
      • Recursive Submodules
      • Generate terraform.tfvars
      • GitHub Action
      • pre-commit Hooks
      • Plugins
      • Contributing
      • terraform-docs
        • asciidoc
          • asciidoc document
          • asciidoc table
        • json
        • markdown
          • markdown document
          • markdown table
        • pretty
        • tfvars
          • tfvars hcl
          • tfvars json
        • toml
        • xml
        • yaml

    Generate terraform.tfvars

    Since v0.9.0

    You can generate terraform.tfvars in both hcl and json format by executing the following, respectively:

    terraform-docs tfvars hcl /path/to/module
    
    terraform-docs tfvars json /path/to/module
    
    Required input variables will be "" (empty) in HCL and null in JSON format.

    Edit on GitHub

    ← Recursive Submodules
    GitHub Action →
    • © terraform-docs Authors 2023. Documentation distributed under CC-BY-4.0.
    • GitHub
    • Slack