# 使用 Homebrew, MacPorts, Nix, chocolatey, scoop, winget 安装 terraform-docs

查看 terraform-docs 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。

## 安装

```sh
sudo av install brew:terraform-docs
```

其他安装命令:

### macOS

- Homebrew (100%):

```sh
brew install terraform-docs
```

  证据: local Homebrew formula metadata

- MacPorts (94%):

```sh
sudo port install terraform-docs
```

  证据: MacPorts ports tree: devel/terraform-docs/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1

### Linux

- Nix (92%):

```sh
nix profile install nixpkgs#terraform-docs
```

  证据: nixpkgs package indexes: pkgs/by-name/te/terraform-docs/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

### Windows

- Chocolatey (92%):

```sh
choco install Terraform-Docs
```

  证据: Chocolatey community package catalog: Terraform-Docs from http://community.chocolatey.org/api/v2/Packages?$filter=IsLatestVersion&$select=Id&$top=1000&$skiptoken='11','termius'

- Scoop (92%):

```sh
scoop install main/terraform-docs
```

  证据: Scoop official bucket manifest trees: bucket/terraform-docs.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1

- winget (92%):

```sh
winget install --id Terraform-docs.Terraform-docs -e
```

  证据: Windows Package Manager source index: Terraform-docs.Terraform-docs from https://cdn.winget.microsoft.com/cache/source.msix

## 软件包事实

- **软件包键:** brew:terraform-docs
- **软件包管理器:** Homebrew
- **版本:** 0.24.0
- **来源摘要:** Tool to generate documentation from Terraform modules
- **主页:** <https://terraform-docs.io/>
- **仓库:** <https://github.com/terraform-docs/terraform-docs>
- **最后更新:** 2026-05-11T00:44:30Z
- **已生成:** 2026-08-03T19:37:03+00:00

## 可执行文件

- terraform-docs (别名)

## 安装行为

- Bottle: 不可用

## 版本和新鲜度

- 页面生成时间: 2026-08-03
- 管理器版本: 0.24.0
## 项目历史与用法

terraform-docs is a Terraform module documentation generator. It reads module inputs, outputs, providers, requirements, and related metadata, then renders that information into Markdown, AsciiDoc, JSON, YAML, XML, TOML, or other output formats for README files and automation workflows.

### 项目历史

The terraform-docs/terraform-docs repository was created on GitHub in June 2016, during the period when Terraform modules were becoming a common unit of infrastructure reuse. Its own README describes the project as a utility to generate documentation from Terraform modules in various output formats, and the dedicated terraform-docs.io documentation site grew into the primary user guide.

The project published v0.0.1 in June 2016 and continued as a Go CLI distributed through GitHub releases, Homebrew, Scoop, Chocolatey, Docker images, and `go install`. Later releases added a formal YAML configuration file, recursive module support, output injection, and richer formatter behavior, turning the tool from a README helper into a standard module-maintenance step.

### 采用历史

terraform-docs became widely adopted because Terraform modules need documentation that stays synchronized with code. The official README documents direct binary use, Docker use, a GitHub Action, and a pre-commit hook, which reflects its common adoption path in teams that gate infrastructure pull requests on generated README changes.

The package-manager footprint is broad for a Terraform adjunct CLI: the input package facts list Homebrew, Chocolatey, MacPorts, Nix, Scoop, and winget packaging. That breadth is consistent with a tool used by both local developers and CI systems rather than only by one language ecosystem.

### 使用方式

The usual workflow is to run `terraform-docs` against a module directory and write or inject generated documentation into README.md. The README example uses `terraform-docs markdown table --output-file README.md --output-mode inject /path/to/module`, while the configuration guide documents `.terraform-docs.yml` discovery from the module root, `.config` subdirectories, the current directory, and `$HOME/.tfdocs.d/`.

In package-manager culture, terraform-docs is often installed as a single binary and pinned in pre-commit or CI. Its value is not only the rendered docs, but the reproducibility: maintainers can regenerate module docs from source and detect drift during review.

### 为什么软件包爱好者会关心

terraform-docs is significant because it sits at the boundary between infrastructure-as-code and documentation-as-build-artifact. It gives Terraform module authors the kind of generated reference material that language package maintainers expect from API-doc tools, but in a standalone CLI that system package managers can distribute.

For Homebrew and other package-manager users, it is a classic small Go tool with high leverage: one executable, no service dependency, and obvious CI/pre-commit use. That makes it a common companion to Terraform, tflint, checkov, and other infrastructure review tools.

### 时间线

- 2016: GitHub repository created.
- 2016: v0.0.1 released.
- 2017: v0.1.0 and v0.3.0 released.
- 2020: Configuration options documented as available since v0.10.0.
- 2021: `.config` lookup paths documented as available since v0.15.0.
- 2026: v0.24.0 listed as the latest GitHub release during research.

### Related projects

- The official README documents a companion terraform-docs GitHub Action and pre-commit hook integration. It also fits into the wider Terraform module ecosystem, where generated README sections are commonly checked alongside Terraform source.

### 来源

- <https://api.github.com/repos/terraform-docs/terraform-docs>
- <https://github.com/terraform-docs/terraform-docs#readme>
- <https://github.com/terraform-docs/terraform-docs/releases>
- <https://terraform-docs.io/>
- <https://terraform-docs.io/user-guide/configuration/>
- source_facts.package-manager


## 安全说明

没有找到 terraform-docs 的匹配本地密钥处理 manifest。Nucleus 软件包元数据仍在此发布，以便未来覆盖拥有稳定的软件包 URL。



## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: <module-root>/.terraform-docs.yml, <module-root>/.config/.terraform-docs.yml, ./.terraform-docs.yml, ./.config/.terraform-docs.yml, ~/.tfdocs.d/.terraform-docs.yml
## 其他软件包管理器记录

- Nix - terraform-docs: normalized package name match | nixpkgs package indexes: pkgs/by-name/te/terraform-docs/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
- MacPorts - terraform-docs: normalized package name match | MacPorts ports tree: devel/terraform-docs/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1
- Chocolatey - Terraform-Docs: normalized package name match | Chocolatey community package catalog: Terraform-Docs from http://community.chocolatey.org/api/v2/Packages?$filter=IsLatestVersion&$select=Id&$top=1000&$skiptoken='11','termius'
- Scoop - main/terraform-docs: normalized package name match | Scoop official bucket manifest trees: bucket/terraform-docs.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1
- winget - Terraform-docs.Terraform-docs: normalized package name match | Windows Package Manager source index: Terraform-docs.Terraform-docs from https://cdn.winget.microsoft.com/cache/source.msix


## Combined YAML source

View the package source record on GitHub. [combined/terraform-docs.yml](https://github.com/mxcl/pkgdb/blob/main/combined/terraform-docs.yml)


## 来源

- pkg.so package database
- Geiger risk classifier
- curated configuration and credential file locations
- curated package history
- pkgdb category and tag curation
- external package-manager database matches
- cross-ecosystem install command graph