terramate-best-practices
Terramate CLI, Cloud, and Catalyst best practices and usage guides. This skill should be used when working with Terramate stacks, orchestration, code generation, Cloud integration, or Catalyst components and bundles.
What this skill does
# 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`
Related in Cloud & DevOps
appbuilder-action-scaffolder
IncludedCreate, implement, deploy, and debug Adobe Runtime actions with consistent layout, validation, and error handling. Use this skill whenever the user needs to add actions to an App Builder project, understand action structure (params, response format, web/raw actions), configure actions in the manifest, use App Builder SDKs (State, Files, Events, database), deploy and invoke actions via CLI, debug action issues, or implement patterns such as webhook receivers, custom event providers, journaling consumers, large payload redirects, action sequence pipelines, and Asset Compute workers. Also trigger when users mention serverless functions in Adobe context, action logging, IMS authentication for actions, or cron-style scheduled actions.
orchestrating-datacloud
IncludedSalesforce Data Cloud product orchestrator for connect→prepare→harmonize→segment→act workflows. Use this skill when the user needs a multi-step Data Cloud pipeline, cross-phase troubleshooting, or data space and data kit management. TRIGGER when: user needs a multi-step Data Cloud pipeline, asks to set up or troubleshoot Data Cloud across phases, manages data spaces or data kits, or wants a cross-phase sf data360 workflow. DO NOT TRIGGER when: work is isolated to a single phase (use the matching phase-specific skill), the task is STDM/session tracing/parquet telemetry (use observing-agentforce), standard CRM SOQL (use querying-soql), or Apex implementation (use generating-apex).
github-project-automation
IncludedAutomate GitHub repository setup with CI/CD workflows, issue templates, Dependabot, and CodeQL security scanning. Includes 12 production-tested workflows and prevents 18 errors: YAML syntax, action pinning, and configuration. Use when: setting up GitHub Actions CI/CD, creating issue/PR templates, enabling Dependabot or CodeQL scanning, deploying to Cloudflare Workers, implementing matrix testing, or troubleshooting YAML indentation, action version pinning, secrets syntax, runner versions, or CodeQL configuration. Keywords: github actions, github workflow, ci/cd, issue templates, pull request templates, dependabot, codeql, security scanning, yaml syntax, github automation, repository setup, workflow templates, github actions matrix, secrets management, branch protection, codeowners, github projects, continuous integration, continuous deployment, workflow syntax error, action version pinning, runner version, github context, yaml indentation error
sf-datacloud
IncludedSalesforce Data Cloud product orchestrator for connect→prepare→harmonize→segment→act workflows. TRIGGER when: user needs a multi-step Data Cloud pipeline, asks to set up or troubleshoot Data Cloud across phases, manages data spaces or data kits, or wants a cross-phase `sf data360` workflow. DO NOT TRIGGER when: work is isolated to a single phase (use the matching sf-datacloud-* skill), the task is STDM/session tracing/parquet telemetry (use sf-ai-agentforce-observability), standard CRM SOQL (use sf-soql), or Apex implementation (use sf-apex).
fabric-cli
IncludedUse this skill for Fabric.so CLI workflows with the `fabric` terminal command: diagnose/install/login, search or browse a Fabric library, save notes/links/files, create folders, ask the Fabric AI assistant, manage tasks/workspaces, generate shell completion, check subscription usage, produce JSON output, and use Fabric as persistent agent memory. Do not use for Microsoft Fabric/Azure/Power BI `fab`, Daniel Miessler's Fabric framework, Python Fabric SSH, Fabric.js, or textile/fashion fabric.
lark
IncludedLark/Feishu CLI skills: lark-cli operations for docs, markdown, sheets, base, calendar, im, mail, task, okr, drive, wiki, slides, whiteboard, apps, approval, attendance, contact, vc, minutes, event. Use when the user needs to operate Lark/Feishu resources via lark-cli, send messages, manage documents, spreadsheets, calendars, tasks, OKRs, deploy web pages, or any Feishu/Lark workspace operations.