What is terraform-docs
A utility to generate documentation from Terraform modules in various output formats.
terraform-docs json ./my-terraform-module # generate json terraform-docs markdown ./my-terraform-module # generate markdown table terraform-docs markdown table ./my-terraform-module # generate markdown table terraform-docs markdown document ./my-terraform-module # generate markdown document terraform-docs pretty ./my-terraform-module # generate colorized pretty terraform-docs tfvars hcl ./my-terraform-module # generate hcl format of terraform.tfvars terraform-docs tfvars json ./my-terraform-module # generate json format of terraform.tfvars terraform-docs xml ./my-terraform-module # generate xml terraform-docs yaml ./my-terraform-module # generate yaml
The latest version can be installed using
GO111MODULE="on" go get email@example.com
If you are a Mac OS X user, you can use Homebrew:
brew install terraform-docs
Windows users can install using Chocolatey:
choco install terraform-docs
NOTE: please use the latest go to do this, we use 1.14 but ideally go 1.13.5 or greater.
This will put
$(go env GOPATH)/bin. 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
$(go env GOPATH)/src/github.com/segmentio/terraform-docs/bin/$(uname | tr '[:upper:]' '[:lower:]')-amd64/terraform-docs
Stable binaries are also available on the releases page. To install, download the binary for your platform from "Assets" and place this into your
curl -Lo ./terraform-docs https://github.com/segmentio/terraform-docs/releases/download/v0.9.1/terraform-docs-v0.9.1-$(uname | tr '[:upper:]' '[:lower:]')-amd64 chmod +x ./terraform-docs mv ./terraform-docs /some-dir-in-your-PATH/terraform-docs
NOTE: Windows releases are in
The code completion for
zsh can be installed using:
Note: Shell auto-completion is not available for Windows users.
terraform-docs completion bash > ~/.terraform-docs-completion source ~/.terraform-docs-completion # or simply the one-liner below source <(terraform-docs completion bash)
terraform-docs completion zsh > /usr/local/share/zsh/site-functions/_terraform-docs autoload -U compinit && compinit
To make this change permenant, the above commands can be added to your
- Read Contributing Guide before submitting a pull request.
- Building: not written yet
- Releasing: not written yet
Visit ./docs for all documentation.
This project is no longer maintained by Segment. Instead, Martin Etmajer from GetCloudnative and Khosrow Moossavi from CloudOps are maintaining the project with help from these awesome contributors. Note that maintainers are unaffiliated with Segment.
Copyright (c) 2018 The terraform-docs Authors.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
There is no documentation for this package.
Package tfconfig is a helper library that does careful, shallow parsing of Terraform modules to provide access to high-level metadata while remaining broadly compatible with configurations targeting various different Terraform versions.
|Package tfconfig is a helper library that does careful, shallow parsing of Terraform modules to provide access to high-level metadata while remaining broadly compatible with configurations targeting various different Terraform versions.|
Package print provides a specific definition of a printer Format
|Package print provides a specific definition of a printer Format|
Package tfconf is the representation of a Terraform Module
|Package tfconf is the representation of a Terraform Module|
Package tmpl provides templating functionality
|Package tmpl provides templating functionality|