# Install terraform-docs

Tool to generate documentation from Terraform modules. Version 0.24.0 via Homebrew; verified 2026-05-11.

## Install

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

Additional install commands:

### macOS

- Homebrew (100%):

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

  Evidence: local Homebrew formula metadata

- MacPorts (94%):

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

  Evidence: 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
```

  Evidence: 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
```

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

- Scoop (92%):

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

  Evidence: 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
```

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

## Package Facts

- **Package key:** brew:terraform-docs
- **Package manager:** Homebrew
- **Package manager URL:** <https://formulae.brew.sh/formula/terraform-docs>
- **Version:** 0.24.0
- **Source summary:** Tool to generate documentation from Terraform modules
- **Homepage:** <https://terraform-docs.io/>
- **Repository:** <https://github.com/terraform-docs/terraform-docs>
- **Upstream docs:** <https://terraform-docs.io/>
- **License:** MIT
- **Source archive:** <https://github.com/terraform-docs/terraform-docs/archive/refs/tags/v0.24.0.tar.gz>
- **Last updated:** 2026-05-11T00:44:30Z
- **Generated:** 2026-06-10T07:18:26+00:00

## Executables

- terraform-docs (cli)
- terraform-docs (alias)

## Build Dependencies

- go

## Install Behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-06-10
- Package-manager version: 0.24.0
- Package-manager updated: 2026-05-11
- Local data status: ok
- Upstream repository: https://github.com/terraform-docs/terraform-docs
- Upstream latest detected: v0.24.0 (current)

## Notes de sécurité

no executable entrypoint in the package index.

- **Geiger risk:** green / low
- no executable entrypoint in the package index

## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** terraform-docs
- **Version Scheme:** 0
- **Revision:** 0
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** stable

## Other Package-Manager Records

- 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','temurin11'
- 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


## Related Links

- [Cloud CLI packages](https://www.automicvault.com/fr/pkg/cloud-clis/) - Belongs to a cloud or infrastructure command family.
- [Terminal utility packages](https://www.automicvault.com/fr/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://www.automicvault.com/fr/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://www.automicvault.com/fr/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [go](https://www.automicvault.com/fr/pkg/brew/go/) - Build dependency declared by Homebrew.
- [sourcekitten](https://www.automicvault.com/fr/pkg/brew/sourcekitten/) - Shares av.db curated category or tags: cli, developer-tools, documentation, documentation-generator, markdown.
- [tf-summarize](https://www.automicvault.com/fr/pkg/brew/tf-summarize/) - Shares av.db curated category or tags: cli, developer-tools, infrastructure-as-code, terraform.
- [helm-docs](https://www.automicvault.com/fr/pkg/brew/helm-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation, documentation-generator, markdown.
- [iam-policy-json-to-terraform](https://www.automicvault.com/fr/pkg/brew/iam-policy-json-to-terraform/) - Shares av.db curated category or tags: cli, developer-tools, infrastructure-as-code, terraform.
- [swagger2markup-cli](https://www.automicvault.com/fr/pkg/brew/swagger2markup-cli/) - Shares av.db curated category or tags: asciidoc, cli, developer-tools, documentation, markdown.
- [tfautomv](https://www.automicvault.com/fr/pkg/brew/tfautomv/) - Shares av.db curated category or tags: cli, developer-tools, infrastructure-as-code, terraform.
- [tfclean](https://www.automicvault.com/fr/pkg/brew/tfclean/) - Shares av.db curated category or tags: cli, developer-tools, infrastructure-as-code, terraform.
- [tf-profile](https://www.automicvault.com/fr/pkg/brew/tf-profile/) - Shares av.db curated category or tags: cli, developer-tools, infrastructure-as-code, terraform.
- [terraform-module-versions](https://www.automicvault.com/fr/pkg/brew/terraform-module-versions/) - Package names and metadata indicate a similar tool family. Shared terms: cli, code, developer, developer-tools, infrastructure.

## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- package version freshness
- av.db category and tag curation
- package relationship graph
- external package-manager database matches
- cross-ecosystem install command graph