mcpField
T
terramate-best-practices

terramate-best-practices

github.com/terramate-io云与 DevOps35353 次安装38 周前更新
代码仓库

关于 terramate-best-practices

面向 Terramate CLI、Cloud 和 Catalyst 用户的最佳实践指南，按优先级覆盖堆栈管理、编排、代码生成及 CI/CD 等主题。规则文件提供说明与正反示例，适用于配置和工作流设计。

主要功能

  1. 01涵盖 CLI、Cloud 与 Catalyst
  2. 02按优先级组织规则
  3. 03指导堆栈编排与依赖管理
  4. 04提供代码生成模式
  5. 05涵盖 CI/CD 工作流
  6. 06包含正反示例

适用场景

  1. 01组织 Terramate 堆栈
  2. 02编排跨堆栈命令
  3. 03生成可复用配置
  4. 04设置 CI/CD 与部署工作流

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/terramate-best-practices确认已加载。

包含的文件

除 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

详细介绍

Terramate 最佳实践

由 Terramate 维护的 Terramate CLI、Cloud 和 Catalyst 综合指南。包含有关堆栈管理、编排、代码生成、Cloud 集成以及 Catalyst 组件/包的最佳实践和使用模式。

适用场景

在以下情况下参考这些指南：

  • 创建和组织 Terramate 堆栈
  • 跨多个堆栈编排命令
  • 使用代码生成保持配置 DRY
  • 与 Terramate Cloud 集成以实现可观测性
  • 创建 Catalyst 组件和包
  • 使用 Terramate 设置 CI/CD 工作流
  • 管理堆栈依赖关系和执行顺序

按优先级划分的规则类别

优先级类别影响前缀
1CLI 基础严重cli-
2CLI 编排高cli-orchestration-
3CLI 代码生成高cli-codegen-
4CLI 配置中高cli-config-
5Terramate Cloud中高cloud-
6Terramate Catalyst中catalyst-
7CI/CD 集成中cicd-
8高级模式低中advanced-

快速参考

1. CLI 基础（严重）
  • cli-stack-structure - 使用清晰的目录结构组织堆栈
  • cli-stack-config - 使用恰当的 stack 块配置堆栈
  • cli-stack-metadata - 使用元数据识别和筛选堆栈
2. CLI 编排（高）
  • cli-orchestration-run - 高效地跨堆栈运行命令
  • cli-orchestration-change-detection - 使用变更检测限制执行范围
  • cli-orchestration-parallel - 利用并行执行处理相互独立的堆栈
  • cli-orchestration-dependencies - 管理堆栈依赖关系和执行顺序
3. CLI 代码生成（高）
  • cli-codegen-hcl - 使用 generate_hcl 生成 DRY Terraform 代码
  • cli-codegen-file - 使用 generate_file 实现文件生成模式
  • cli-codegen-provider - 动态生成 provider 配置
4. CLI 配置（中高）
  • cli-config-globals - 使用 globals 在多个堆栈间共享配置
  • cli-config-lets - 使用 lets 计算堆栈本地值
  • cli-config-metadata - 利用元数据获取堆栈信息
5. Terramate Cloud（中高）
  • cloud-integration - 设置 Cloud 连接和身份验证
  • cloud-drift-management - 配置漂移检测和协调
  • cloud-observability - 使用 Cloud 仪表板查看堆栈
6. Terramate Catalyst（中）
  • catalyst-components - 创建可复用的组件蓝图
  • catalyst-bundles - 定义用于组件组合的包
  • catalyst-instantiation - 正确实例化包
7. CI/CD 集成（中）
  • cicd-github-actions - 设置 GitHub Actions 工作流
  • cicd-preview-workflows - 为 PR 创建预览工作流
  • cicd-deployment-workflows - 配置部署自动化
8. 高级模式（低中）
  • advanced-workflows - 创建复杂的多步骤工作流
  • advanced-codegen-patterns - 高级代码生成技术

使用方法

阅读各个规则文件，了解详细说明和代码示例：

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

每个规则文件都包含：

  • 简要说明其重要性
  • 错误/反模式示例及说明
  • 正确/最佳实践示例及说明
  • 补充背景信息和参考资料

完整编译文档

如需包含所有展开规则的完整指南，请查看：AGENTS.md

评论

支持 Markdown