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
    • Ignore Resources to be Generated
    • 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
      • Ignore Resources to be Generated
      • 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

    CLI Flag 'false' value

    Boolean flags can only take arguments via --flag=[true|false] or for short names (if available) -f=[true|false]. You cannot use --flag [true|false] nor can you use the shorthand -f [true|false] as it will result in the following error:

    Error: accepts 1 arg(s), received 2
    

    Example:

    # disable reading .terraform.lock.hcl
    $ terraform-docs markdown --lockfile=false /path/to/module
    

    Edit on GitHub

    Configuration File →
    • © terraform-docs Authors 2023. Documentation distributed under CC-BY-4.0.
    • GitHub
    • Slack