terramate-best-practices

Name: terramate-best-practices
Author: terramate-io

github.com/terramate-ioCloud & DevOps35353 installsUpdated 38w ago

About terramate-best-practices

A best-practices guide for users of Terramate CLI, Cloud, and Catalyst. Its prioritized rules cover stack management, orchestration, code generation, and CI/CD, with explanations and contrasting examples for configuration and workflow design.

Key features

01Covers CLI, Cloud, and Catalyst
02Rules organized by priority
03Stack orchestration and dependencies
04Code generation patterns
05CI/CD workflow guidance
06Explanations with contrasting examples

Use cases

01Organizing Terramate stacks
02Orchestrating commands across stacks
03Generating reusable configuration
04Setting up CI/CD and deployment workflows

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/terramate-io/agent-skills --skill terramate-best-practices

After installing, type/terramate-best-practicesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

AGENTS.md

rules/

catalyst-bundles.md

catalyst-components.md

cicd-github-actions.md

cli-codegen-file.md

cli-codegen-hcl.md

cli-codegen-provider.md

cli-config-globals.md

cli-orchestration-change-detection.md

cli-orchestration-dependencies.md

cli-orchestration-parallel.md

cli-orchestration-run.md

cli-stack-config.md

cli-stack-metadata.md

cli-stack-structure.md

cloud-drift-management.md

cloud-integration.md

Details

From the project README

Terramate Best Practices

Comprehensive guide for Terramate CLI, Cloud, and Catalyst, maintained by Terramate. Contains best practices and usage patterns for stack management, orchestration, code generation, Cloud integration, and Catalyst components/bundles.

When to Apply

Reference these guidelines when:

Creating and organizing Terramate stacks
Orchestrating commands across multiple stacks
Using code generation to keep configurations DRY
Integrating with Terramate Cloud for observability
Creating Catalyst components and bundles
Setting up CI/CD workflows with Terramate
Managing stack dependencies and execution order

Rule Categories by Priority

Priority	Category	Impact	Prefix
1	CLI Fundamentals	CRITICAL	`cli-`
2	CLI Orchestration	HIGH	`cli-orchestration-`
3	CLI Code Generation	HIGH	`cli-codegen-`
4	CLI Configuration	MEDIUM-HIGH	`cli-config-`
5	Terramate Cloud	MEDIUM-HIGH	`cloud-`
6	Terramate Catalyst	MEDIUM	`catalyst-`
7	CI/CD Integration	MEDIUM	`cicd-`
8	Advanced Patterns	LOW-MEDIUM	`advanced-`

Quick Reference

1. CLI Fundamentals (CRITICAL)

cli-stack-structure - Organize stacks with clear directory structure
cli-stack-config - Configure stacks with proper stack blocks
cli-stack-metadata - Use metadata for stack identification and filtering

2. CLI Orchestration (HIGH)

cli-orchestration-run - Run commands across stacks efficiently
cli-orchestration-change-detection - Use change detection to limit execution scope
cli-orchestration-parallel - Leverage parallel execution for independent stacks
cli-orchestration-dependencies - Manage stack dependencies and execution order

3. CLI Code Generation (HIGH)

cli-codegen-hcl - Use generate_hcl for DRY Terraform code
cli-codegen-file - Use generate_file for file generation patterns
cli-codegen-provider - Generate provider configurations dynamically

4. CLI Configuration (MEDIUM-HIGH)

cli-config-globals - Use globals for shared configuration across stacks
cli-config-lets - Use lets for stack-local computed values
cli-config-metadata - Leverage metadata for stack information

5. Terramate Cloud (MEDIUM-HIGH)

cloud-integration - Set up Cloud connection and authentication
cloud-drift-management - Configure drift detection and reconciliation
cloud-observability - Use Cloud dashboard for stack visibility

6. Terramate Catalyst (MEDIUM)

catalyst-components - Create reusable component blueprints
catalyst-bundles - Define bundles for component composition
catalyst-instantiation - Instantiate bundles correctly

7. CI/CD Integration (MEDIUM)

cicd-github-actions - Set up GitHub Actions workflows
cicd-preview-workflows - Create preview workflows for PRs
cicd-deployment-workflows - Configure deployment automation

8. Advanced Patterns (LOW-MEDIUM)

advanced-workflows - Create complex multi-step workflows
advanced-codegen-patterns - Advanced code generation techniques

How to Use

Read individual rule files for detailed explanations and code examples:

rules/cli-stack-structure.md
rules/cli-orchestration-run.md
rules/cli-codegen-hcl.md
rules/cloud-integration.md
rules/catalyst-components.md

Each rule file contains:

Brief explanation of why it matters
Incorrect/anti-pattern example with explanation
Correct/best practice example with explanation
Additional context and references

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md

Comments

Markdown supported

Details

Author: terramate-io
Repository: terramate-io/agent-skills
Category: Cloud & DevOps
Installs: 353
GitHub stars: 35

Report

More skills

All skills

lark-apps

open.feishu.cn

732.0k

Develop and host Miaoda (Spark/Miaoda) apps: app creation, local full-stack development, cloud generation and iteration, creative design (UI mockups / interactive prototypes / wireframes / landing pages / dashboards / slide decks / visual exploration), integration of AI-related capabilities, Feishu platform capabilities, or other external capabilities; log/Trace/monitoring metric/PV/UV queries; environment variable management; app collaborators and collaboration permissions; app roles and members; and automation triggers (scheduled / record changes / Webhook / Feishu approvals). Use when users want to develop or create a system, tool, platform, or app; develop locally or in the cloud, modify, deploy, publish, launch, or get a shareable link; create a page or website with HTML and deploy it to Miaoda; design, create a mockup, prototype, wireframe, PPT, deck, or visual exploration; or mention Miaoda/Spark/Miaoda apps (links like `/app/app_xxx` or `/page/<token>`, runtime domains like *.aiforce.cloud), app databases, app file storage, open API Keys, visibility, app collaborators/developer permissions, app roles/role members, production logs, API request volume, error volume, latency, traffic, environment variables, or setting up automation tasks, scheduled triggers, or approval-triggered automation for Miaoda apps. Not for regular cloud drive file uploads (lark-drive), Feishu document editing (lark-doc), or native slide creation (lark-slides).

azure-prepare

github.com/microsoft

571.7k

Prepare azd-based Azure projects for deployment: generates azure.yaml, infrastructure (Bicep/Terraform), and Dockerfiles for the Azure Developer CLI (azd) workflow. USE ONLY when the user explicitly wants to use azd as the deployment tool, or the project already has an azure.yaml file. DO NOT USE FOR: non-azd deployments, Python App Service code-only deploys (use python-appservice-deploy), or cross-cloud migration (use azure-cloud-migrate). WHEN: prepare app for azd, create azure.yaml, set up azd infrastructure, modernize app for Azure with azd, deploy with azd, function app, timer trigger, service bus trigger, event-driven function, managed identity, generate Bicep, generate Terraform, create and deploy to Azure.

wizard

github.com/mattpocock

571.5k

Generate an interactive bash wizard that walks a human through steps only they can perform. Use when provisioning infrastructure, setting up credentials or CI secrets, walking an unfamiliar third-party dashboard, or running a one-off migration or cutover. Don't invoke this for steps the agent can perform itself.

azure-ai

github.com/microsoft

571.2k

Use for Azure AI: Search, Speech, OpenAI, Document Intelligence. Helps with search, vector/hybrid search, speech-to-text, text-to-speech, transcription, OCR. WHEN: AI Search, query search, vector search, hybrid search, semantic search, speech-to-text, text-to-speech, transcribe, OCR, convert text to speech.