terraform-docs for Mac 版
从 Terraform 模块生成文档的工具
terraform-docs 是什么
terraform-docs 是一个从 Terraform 模块自动生成文档的工具,支持多种输出格式。它的核心作用是把模块里的变量、输出、提供者等信息整理成可读的文档,省去手动维护 README 的麻烦。你可以直接运行二进制文件生成文档,也能通过 Docker 容器挂载目录来使用,或者接入 GitHub Actions 和 pre-commit 钩子,让文档在每次提交时自动保持同步。配置方面,它支持用 YAML 文件(默认 .terraform-docs.yml)进行定制,还能通过内容模板进一步调整生成结果的样式。这个工具适合需要长期维护 Terraform 模块的团队和个人,尤其是希望文档跟代码一起版本化、避免文档落后的开发者。
如何安装 terraform-docs
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
最近一次更新为 2026-11-12,当前版本 v0.25.1,共记录最近 10 个版本。
| 版本 | 发布日期 | 类型 | 大小 | macOS | Windows | Linux |
|---|---|---|---|---|---|---|
| v0.25.1 | 2026-11-12 | 稳定版 | 6.7 MB | 下载 | 下载 | 下载 |
| v0.24.0 | 2026-05-10 | 稳定版 | 6.4 MB | 下载 | 下载 | 下载 |
| v0.23.0 | 2026-05-06 | 稳定版 | 6.4 MB | 下载 | 下载 | 下载 |
| v0.22.0 | 2026-04-07 | 稳定版 | 6.4 MB | 下载 | 下载 | 下载 |
| v0.21.0 | 2025-12-12 | 稳定版 | 6.4 MB | 下载 | 下载 | 下载 |
| v0.20.0 | 2025-04-04 | 稳定版 | 6.1 MB | 下载 | 下载 | 下载 |
| v0.19.0 | 2024-09-18 | 稳定版 | 6.0 MB | 下载 | 下载 | 下载 |
| v0.18.0 | 2024-05-30 | 稳定版 | 5.8 MB | 下载 | 下载 | 下载 |
| v0.25.1-rc2 | 2026-11-12 | 预发布 | 6.7 MB | 下载 | 下载 | 下载 |
| v0.25.1-rc1 | 2026-11-12 | 预发布 | 6.7 MB | 下载 | 下载 | 下载 |
数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。
二进制包支持平台
Homebrew 官方提供的预编译包(bottle)覆盖:
- Apple 芯片 · 最新 macOS
- Apple 芯片 · macOS 26 Tahoe
- Apple 芯片 · macOS 15 Sequoia
- Linux · ARM64
- Linux · x86_64
⚠️ 未提供 Intel Mac 的预编译包,Intel 机型需要通过 brew install --build-from-source 从源码编译。
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| terraform-docs | v0.25.1 | MIT | 命令行 | 5,322 |
| terragrunt | v1.2.2 | MIT | 命令行 | 5,097 |
| tfenv | v3.2.2 | MIT | 命令行 | 6,437 |
| opentofu | v1.13.9 | MPL-2.0 | 命令行 | 14,347 |
DevOps 与云服务中的类似应用
terragrunt
Terragrunt 是一个灵活的编排工具,用来让用 OpenTofu/Terraform 编写的基础设施即代码具备规模化能力。tfenv
tfenv 是一个受 rbenv 启发的 Terraform 版本管理工具,用来在同一台机器上安装、切换和管理多个 Terraform 版本。opentofu
OpenTofu 是一个开源的基础设施管理工具,用于安全、高效地构建、变更和版本化基础设施。它既能管理现有的主流服务提供商,也支持自定义的内部解决方案。tenv
tenv 是一个用 Go 编写的版本管理工具,面向 OpenTofu、Terraform、Terragrunt、Terramate 和 Atmos 这几款基…tfmigrate
tfmigrate 是一个面向 GitOps 工作流的 Terraform / OpenTofu state 迁移工具。awscli
AWS CLI 是亚马逊云服务的统一命令行接口,让用户通过终端直接管理和操作 AWS 资源。所属分类:DevOps 与云服务、命令行工具