terraform-module-scaffold

Generate standardized Terraform module scaffolds with documentation, examples, and tests.

5|Updated Jul 6, 2025
One-click install
npx skills add https://github.com/GuicedEE/ai-rules --skill terraform-module-scaffold
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: terraform-module-scaffold
Source: https://github.com/GuicedEE/ai-rules/tree/main/skills/.curated/terraform-module-scaffold
Command: npx skills add https://github.com/GuicedEE/ai-rules --skill terraform-module-scaffold

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Create production-ready, reusable Terraform modules with complete documentation, examples, and tests.

Core Features & Use Cases

  • Generates a conventional module layout (versions.tf, variables.tf, outputs.tf, main.tf, README.md, examples, tests)
  • Templates documentation and example usage for multiple providers (azurerm, aws, google)
  • Enforces best practices like single-responsibility modules, validation, sensible defaults, and consistent naming

Quick Start

Run the scaffold-module.js script with appropriate flags to generate a complete Terraform module scaffold.

Frequently Asked Questions about terraform-module-scaffold

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

FAQPage Schema
How do I scaffold a production-ready Terraform module with standard file layouts?

Scaffold a production-ready Terraform module by generating a conventional repository layout including versions.tf, variables.tf, outputs.tf, main.tf, README.md, examples, and tests. This standardizes module development and enforces best practices like single-responsibility design and consistent naming across providers.

Can I generate Terraform module templates for multiple cloud providers like AWS and Azure?

Yes, you can generate Terraform module templates for multiple cloud providers including AWS, Azure, and Google Cloud. The scaffolding process templates documentation and example usage tailored to each specific provider while maintaining a standardized modular repository layout.

What files do I need to create a reusable Terraform module structure?

A reusable Terraform module structure requires versions.tf, variables.tf, outputs.tf, main.tf, README.md, examples, and tests. Generating these files together ensures complete documentation, validation, sensible defaults, and consistent naming conventions for infrastructure-as-code projects.

Does this Terraform module scaffolding approach enforce infrastructure-as-code best practices?

Yes, this Terraform module scaffolding approach enforces best practices by applying single-responsibility module design, input validation, sensible defaults, and consistent naming. It generates standardized templates that satisfy requirements for modular repository layouts across different infrastructure providers.

What's the best way to organize a Terraform module repository for production use?

The best way to organize a production-ready Terraform module repository is using a conventional layout with separate files for versions, variables, outputs, and main logic, alongside dedicated directories for examples and tests. This structure ensures reusability, maintainability, and complete documentation.