skills.rest
danievanzyl
danievanzylCOMMUNITY
Explore all skills by this author →
GitHub

tf-remote-state-outputs

Scan Terraform .tf files and generate REMOTE_STATE_OUTPUTS.md grouped by source file.

1|Updated Mar 9, 2026
Search Tags:#automation#documentation#terraform#code-analysis#remote-state#outputs
One-click install
npx skills add https://github.com/danievanzyl/code-skills --skill tf-remote-state-outputs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tf-remote-state-outputs
Source: https://github.com/danievanzyl/code-skills/tree/main/skills/tf-remote-state-outputs
Command: npx skills add https://github.com/danievanzyl/code-skills --skill tf-remote-state-outputs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill scans Terraform repositories to identify every output block and generate a centralized REMOTE_STATE_OUTPUTS.md, giving teams a clear inventory of what a project exports for remote state consumers.

Core Features & Use Cases

  • Identify all output blocks across .tf files and extract their name, value expression, and optional description.
  • Group outputs by source file, derive project name and state location from backend configuration, and maintain an up-to-date documentation file.
  • Use case: onboarding a new Terraform project, auditing exported values, or sharing outputs with consuming modules.

Quick Start

Run this skill at the repository root to generate or update REMOTE_STATE_OUTPUTS.md for your Terraform project.

Frequently Asked Questions about tf-remote-state-outputs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document Terraform outputs for remote state consumers?▼

Terraform remote state outputs are exported values defined in output blocks that consuming modules or projects can reference. You document them by generating a REMOTE_STATE_OUTPUTS.md file that inventories each output's name, value expression, and source file.

How do I generate a Terraform output inventory from multiple .tf files?▼

You generate a Terraform output inventory by scanning all .tf files, extracting output blocks, grouping them alphabetically by source file, and overwriting a REMOTE_STATE_OUTPUTS.md file to reflect the current repository state.

Can I extract the backend project name and state location when documenting Terraform outputs?▼

Yes, you can derive the project name and state location by scanning backend blocks within the .tf files. This configuration information is then included alongside the grouped Terraform outputs in the generated documentation.

Does this Terraform output documentation tool capture sensitive values?▼

Yes, the Terraform output documentation captures a sensitive flag when applicable. It extracts the output name, value expression, description, and sensitive flag from each block to ensure secure values are explicitly marked in the inventory.

What is the best way to maintain an up-to-date inventory of exported Terraform outputs?▼

The best way to maintain an up-to-date inventory of exported Terraform outputs is to run an automated scan at the repository root that overwrites the REMOTE_STATE_OUTPUTS.md file, ensuring the documentation reflects the current repository state.

Related Skills

Explore More Software Engineering Skills→
Cloudgeni-aiCloudgeni-ai
47

checkov

Detect security and compliance violations in Terraform with Checkov scans.

Official
Intermediate
blocknaviblocknavi
1

convex-component-authoring

Create self-contained Convex components with isolated schemas and exports.

Official
Intermediate
lidge-junlidge-jun
5

terraform-style-guide

Generate Terraform HCL code following HashiCorp style conventions.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced