terraform-style-guide

Standardize Terraform configurations with naming, documentation, and version pinning.

5|Updated Apr 29, 2023
One-click install
npx skills add https://github.com/n4vysh/dotfiles --skill terraform-style-guide-n4vysh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: terraform-style-guide
Source: https://github.com/n4vysh/dotfiles/tree/main/home/dot_agents/skills/terraform-style-guide
Command: npx skills add https://github.com/n4vysh/dotfiles --skill terraform-style-guide-n4vysh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Terraform code often lacks consistency across teams, leading to confusion, errors, and maintenance challenges. This guide defines a shared standard to keep infrastructure-as-code readable, secure, and easy to review.

Core Features & Use Cases

  • Standardized file structure and organization for Terraform configurations.
  • Clear naming conventions, descriptive variable and output definitions, and explicit version pinning.
  • Security-conscious defaults and recommendations captured in SECURITY.md to reduce misconfigurations.

Quick Start

Apply the Terraform Style Guide to align your existing projects with HashiCorp's official conventions.

Frequently Asked Questions about terraform-style-guide

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

FAQPage Schema
What are standard Terraform naming conventions for variables and outputs?

Standard Terraform naming conventions require explicit descriptions for all variables and outputs, clear file organization, and explicit version pinning to ensure infrastructure-as-code remains readable, secure, and easy to review across teams.

How do I enforce infrastructure-as-code coding standards across multiple Terraform projects?

You enforce coding standards by applying a shared Terraform style guide that standardizes file structure, integrates security considerations from SECURITY.md, and mandates explicit version pinning to reduce misconfigurations across teams.

Does this Terraform style guide align with official HashiCorp conventions?

Yes, this Terraform style guide aligns existing projects with HashiCorp's official conventions by enforcing standardized file structure, clear naming conventions, and descriptive variable and output definitions to maintain consistency.

How do I structure a SECURITY.md file for Terraform configurations?

Structuring a SECURITY.md for Terraform involves capturing security-conscious defaults and recommendations to reduce misconfigurations, ensuring security considerations are explicitly integrated into your infrastructure-as-code review process.

Why does my Terraform code lack consistency across different teams?

Terraform code lacks consistency across teams without a shared style guide, leading to confusion and maintenance challenges. Applying standardized file organization, explicit version pinning, and naming conventions resolves this infrastructure-as-code fragmentation.