# Terraform Docs Inject

> Generate Terraform docs and inject them into terraform/README.md using terraform-docs markdown table output-mode inject. Use when the user asks to refresh, regenerate, or update Terraform documentation or README. Use when this capability is needed.

- Skill: `tomevault-io/terraform-docs-inject` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/terraform-docs-inject`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/terraform-docs-inject/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: DevOps & Infra
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/terraform-docs-inject

---


# Terraform Docs Inject

## Quick start

From the repository root:

```bash
cd terraform
terraform-docs markdown table --output-file README.md --output-mode inject .
```

## Workflow

1. Confirm a `terraform/` directory exists in the repository root — stop and report if not.
2. Check that `terraform-docs` is installed (`terraform-docs --version`). If not installed, stop and ask the user to install it before proceeding.
3. Run the command above exactly as written — do not change any arguments.
4. Report whether `terraform/README.md` was updated or was already up to date.

## Notes

- Injects content between existing `terraform-docs` markers in `terraform/README.md` — does not replace the whole file.
- Always run from the repository root so the relative path resolves correctly.

---
> Source: [craigspaterson/agent-skills](https://github.com/craigspaterson/agent-skills) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-15 -->

