Generate Terraform Module Inputs And Outputs Docs With Terraform Docs Before Review Drift Sets In

---
name: "Generate Terraform module inputs and outputs docs with terraform-docs before review drift sets in"
slug: "generate-terraform-module-inputs-and-outputs-docs-with-terraform-docs-before-review-drift-sets-in"
description: "Refresh Terraform module documentation from source so variables, outputs, and providers stay aligned with the code before review or release."
github_stars: 4753
verification: "security_reviewed"
source: "https://github.com/terraform-docs/terraform-docs"
author: "terraform-docs"
publisher_type: "open_source_project"
category: "CI/CD Integrations"
framework: "Multi-Framework"
tool_ecosystem:
  github_repo: "terraform-docs/terraform-docs"
  github_stars: 4753
---

# Generate Terraform module inputs and outputs docs with terraform-docs before review drift sets in

Refresh Terraform module documentation from source so variables, outputs, and providers stay aligned with the code before review or release.

## Prerequisites

Terraform module directory, terraform-docs CLI, optional README template or CI step

## Installation

Use the upstream install or setup path that matches your environment:
- brew install terraform-docs
- brew install terraform-docs/tap/terraform-docs
- go install github.com/terraform-docs/terraform-docs@v0.24.0
- the repo and run make build from the repository which will put terraform-docs in:

Requirements and caveats from upstream:
- ### Using docker
- **NOTE:** Docker tag latest refers to _latest_ stable released version and edge

Basic usage or getting-started notes:
- macOS users can install using [Homebrew]:
- bash
- or

- Source: https://github.com/terraform-docs/terraform-docs
- Extracted from upstream docs: https://raw.githubusercontent.com/terraform-docs/terraform-docs/HEAD/README.md

## Documentation

- https://terraform-docs.io

## Source

- [Agent Skill Exchange](https://agentskillexchange.com/skills/generate-terraform-module-inputs-and-outputs-docs-with-terraform-docs-before-review-drift-sets-in/)