https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/ Recent content in User-guides on Hugo -- gohugo.io en-US https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/introduction/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/introduction/ terraform-docs is a utility to generate documentation from Terraform modules in various output formats. Configuration You can also have consistent execution through a .terraform-docs.yml file. Once you set it up and configured it, every time you or your teammates want to regenerate documentation (manually, through a pre-commit hook, or as part of a CI pipeline) all you need to do is run terraform-docs /module/path. Read all about configuration. Formats One of the most popular format is markdown table, which is a very good fit for generating README of module. https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/installation/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/installation/ terraform-docs is available on Linux, macOS, Windows, and FreeBSD platforms. Homebrew If you are a macOS user, you can use Homebrew. brew install terraform-docs or brew install terraform-docs/tap/terraform-docs Windows If you are a Windows user: Scoop You can use Scoop. scoop bucket add terraform-docs https://github.com/terraform-docs/scoop-bucket scoop install terraform-docs Chocolatey or you can use Chocolatey. choco install terraform-docs Docker terraform-docs can be run as a container by mounting a directory with . https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/ The terraform-docs configuration file uses the yaml format in order to override any default behaviors. This is a convenient way to share the configuration amongst teammates, CI, or other toolings. terraform-docs will locate any available configuration file without needing to explicitly pass the --config flag. The default name of the configuration file is .terraform-docs.yml. The path order for locating it is: root of module directory .config/ folder at root of module directory (since v0. https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/content/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/content/ Since v0.14.0 Generated content can be customized further away with content in configuration. If the content is empty the default order of sections is used. Compatible formatters for customized content are asciidoc and markdown. content will be ignored for other formatters. content is a Go template with following additional variables: {{ .Header }} {{ .Footer }} {{ .Inputs }} {{ .Modules }} {{ .Outputs }} {{ . https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/footer-from/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/footer-from/ Since v0.12.0 Relative path to a file to extract footer for the generated output from. Supported file formats are .adoc, .md, .tf, .tofu, and .txt. The whole file content is being extracted as module footer when extracting from .adoc, .md, or .txt. To extract footer from .tf or .tofu file you need to use following javascript, c, or java like multi-line comment. /** * # Footer * * Everything in this comment block will get extracted. https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/formatter/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/formatter/ Since v0.10.0 The following options are supported out of the box by terraform-docs and can be used for FORMATTER_NAME: asciidoc reference asciidoc document reference asciidoc table reference json reference markdown reference markdown document reference markdown table reference pretty reference tfvars hcl reference tfvars json reference toml reference xml reference yaml reference Short version of formatters can also be used: adoc instead of asciidoc md instead of markdown doc instead of document tbl instead of table You need to pass name of a plugin as formatter in order to be able to use the plugin. https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/header-from/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/header-from/ Since v0.10.0 Relative path to a file to extract header for the generated output from. Supported file formats are .adoc, .md, .tf, .tofu, and .txt. The whole file content is being extracted as module header when extracting from .adoc, .md, or .txt. To extract header from .tf or .tofu file you need to use following javascript, c, or java like multi-line comment. /** * # Main title * * Everything in this comment block will get extracted. https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/output/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/output/ Since v0.12.0 Save generated output to a file, if output.file is not empty. output.file can be relative to module root or an absolute path. Saving behavior can be controlled by output.mode: inject (default) Partially replace the output-file content with generated output. This creates the output-file if it doesn’t exist, otherwise it appends to output-file if it doesn’t have surrounding comments. replace https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/output-values/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/output-values/ Since v0.10.0 Optional value field can be added to Outputs section which contains the current value of an output variable as it is found in state via terraform output. Options Available options with their default values. output-values:enabled:falsefrom:""Examples First generate output values file in JSON format: $ pwd /path/to/module $ terraform output --json > output_values.json and then use the following to render them in the generated output: https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/recursive/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/user-guide/configuration/recursive/ Since v0.16.0 Documentation for main module and its submodules can be generated all in one execution using recursive config. It can be enabled with recursive.enabled: true. Path to find submodules can be configured with recursive.path (defaults to modules). Generating documentation recursively is allowed only with output.file set. Each submodule can also have their own .terraform-docs.yml config file, to override configuration from root module. Options Available options with their default values.