Terraform-docs 安装指南：多平台详细教程

Terraform-docs 安装指南：多平台详细教程

terraform-docs Generate documentation from Terraform modules in various output formats 项目地址: https://gitcode.com/gh_mirrors/te/terraform-docs

前言

Terraform-docs 是一款优秀的 Terraform 文档生成工具，能够自动从 Terraform 代码中提取信息并生成规范的文档。本文将详细介绍在不同操作系统和环境下的安装方法，帮助开发者快速上手使用。

多平台安装方案

macOS 用户推荐方案

对于 macOS 用户，最简便的安装方式是通过 Homebrew 包管理器：

brew install terraform-docs

或者使用专门的 tap 源：

brew install terraform-docs/tap/terraform-docs

Homebrew 会自动处理依赖关系并配置环境变量，安装完成后即可在终端直接使用。

Windows 用户安装选项

Windows 平台提供了两种主流的包管理工具安装方式：

1. Scoop 安装方式：

scoop bucket add terraform-docs
scoop install terraform-docs

2. Chocolatey 安装方式：

choco install terraform-docs

两种方式都能自动完成安装和路径配置，用户可根据自己熟悉的包管理工具选择。

Docker 容器化运行方案

对于不想在本地安装的用户，可以使用 Docker 容器运行 terraform-docs：

docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.20.0 markdown /terraform-docs

如果需要将输出保存到文件：

docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.20.0 markdown /terraform-docs > doc.md

版本说明：

• latest 标签指向最新稳定版
• edge 标签指向主分支最新代码
• 具体版本号标签与官方发布版本一致

预编译二进制安装

对于需要直接使用二进制文件的用户：

1. 下载对应平台的压缩包
2. 解压并赋予执行权限
3. 移动到系统 PATH 包含的目录

示例命令：

curl -sSLo ./terraform-docs.tar.gz https://terraform-docs.io/dl/v0.20.0/terraform-docs-v0.20.0-$(uname)-amd64.tar.gz
tar -xzf terraform-docs.tar.gz
chmod +x terraform-docs
mv terraform-docs /usr/local/bin/terraform-docs

注意：Windows 平台请下载 ZIP 格式的压缩包。

Go 开发者安装方式

对于 Go 语言开发者，可以直接通过 go 命令安装：

Go 1.17+ 版本：

go install github.com/terraform-docs/terraform-docs@v0.20.0

Go 1.16 版本：

GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.20.0

版本兼容性说明：

• v0.9.1 及更早版本需要使用旧的模块命名空间
• 最低需要 Go 1.16 版本

安装后二进制文件位于 $(go env GOPATH)/bin 目录，请确保该目录在系统 PATH 环境变量中。

Shell 自动补全配置

为提升使用效率，可以配置 shell 自动补全功能：

Bash 配置

source <(terraform-docs completion bash)

Zsh 配置

terraform-docs completion zsh > /usr/local/share/zsh/site-functions/_terraform-docs
autoload -U compinit && compinit

Oh My Zsh 配置

terraform-docs completion zsh > ~/.oh-my-zsh/completions/_terraform-docs
omz reload

Fish 配置

terraform-docs completion fish > ~/.config/fish/completions/terraform-docs.fish

注意：Windows 平台不支持 shell 自动补全功能。

总结

本文详细介绍了 terraform-docs 在各种平台和环境下的安装方法，用户可以根据自己的使用场景选择最适合的安装方式。无论是开发环境还是 CI/CD 流水线，都能找到对应的部署方案。安装完成后，即可开始使用 terraform-docs 来自动生成 Terraform 模块的标准化文档。

terraform-docs Generate documentation from Terraform modules in various output formats 项目地址: https://gitcode.com/gh_mirrors/te/terraform-docs