Terraform docs. Terraform docs solve this problem, and I’ll show you how easy it is to use and automate it with pre-commit hooks or GitHub Actions. Apr 3, 2025 · This is where Terraform-docs, an open-source and easy-to-use tool, comes in. # or an absolute path $ terraform-docs -c /path/to/parent/folder/. # so does this, absolute path $ terraform-docs markdown table --output-file /path/to/module/docs/README. This is a convenient way to share the configuration amongst teammates, CI, or other toolings. Configure the provider with your AWS credentials, and you can immediately begin creating and managing infrastructure in a safe, repeatable way. Explore Terraform product documentation, tutorials, and examples. ├── docs │ └── README. 0. tf # this works, relative path $ terraform-docs markdown table --output-file . yml module-a/ # executing from child $ cd module-a/ $ terraform-docs -c . terraform-docs Generate Terraform modules documentation in various formats Get started Go to GitHub 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. This directory contains some documentation about the Terraform Core codebase, aimed at readers who are interested in making code contributions. Check out all available formats. © terraform-docs Authors 2023. Shows all resource types. If you're looking for information on using Terraform, please instead refer to the main Terraform CLI documentation. Learn how Terraform compares to other tools and services. Use the navigation to the left to read about the available data sources. Feb 19, 2025 · What is terraform-docs? terraform-docs is a powerful command-line tool that automatically generates comprehensive documentation for your Terraform modules. Extend terraform-docs by Plugin and build your own formatter. yml file and it cannot be used with CLI arguments $ pwd /path/to/module $ tree . md . yml # executing from parent $ terraform-docs -c . Popular use cases and related documentation you can use to create Terraform configurations and workflows. /. /docs/README. . if the plugin file name is different than the example above, terraform-docs won’t be able to to pick it up nor register it properly you can only use plugin thorough . terraform-docs Generate Terraform modules documentation in various formats Get started Go to GitHub 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. md ├── └── main. terraform-docs. The terraform-docs configuration file uses the yaml format in order to override any default behaviors. tf ├── └── . Design your Terraform workflows for scale. terraform-docs primary use-case is to be utilized as a standalone binary, but some parts of it is also available publicly and can be imported in your project as a library. Edit on GitHub. yml . A utility to generate documentation from Terraform modules in various output formats If you encounter the error terraform-docs: command not found after installation then you may need to either add that directory to your $PATH as shown [here] or do a manual installation by cloning the repo and run make build from the repository which will put terraform-docs in: Generate documentation from Terraform modules in various output formats. Jan 22, 2026 · Find reference documentation for deploying resources through Bicep, Azure Resource Manager templates and Terraform AzAPI provider. Use the navigation on the left to explore the available resources, or start with our Get Started tutorials to learn the fundamentals. . Documentation distributed under CC-BY-4. Edit on GitHub Popular use cases and related documentation you can use to create Terraform configurations and workflows. Automate document generation in pull requests with GitHub Action. Read more about terraform-docs GitHub Action and its configuration and examples. Markdown, AsciiDoc, JSON, and more. Describe infrastructure on various providers with Terraform's configuration language. The terraform provider provides access to outputs from the Terraform state of shared infrastructure. ├── module-b │ └── main. Edit on GitHub terraform-docs Generate Terraform modules documentation in various formats Get started Go to GitHub 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. mwmg83, 0kzzx, 3naw, cyvpg3, 8qctn, bygla, cntk, gu97y, kiv8, klbkk,