在 Claude Code 安装 Compound Engineering 插件并运行 /ce-setup 完成仓库初始化
【免费下载链接】compound-engineering-pluginOfficial Compound Engineering plugin for Claude Code, Codex, Cursor, and more项目地址: https://gitcode.com/GitHub_Trending/ev/compound-engineering-plugin
这篇文章面向刚接触 Compound Engineering 插件的开发者:在 Claude Code 中安装这个包含 35 个 AI 编码技能的插件,然后在你要使用它的项目里运行/ce-setup,完成仓库本地的初始化——确认可选工具可用性、刷新配置示例文件、按需创建.compound-engineering/config.yaml、并把本地覆盖文件和 scratch 目录纳入 gitignore。安装不需要 Bun(Bun 只用于仓库开发和 converter 维护),目标项目需要是一个 git 仓库:/ce-setup在 git 仓库之外只会报告能力并停止,不会写入任何文件。
在 Claude Code 中安装插件
在 Claude Code 会话中依次执行两条斜杠命令(来自 README):
/plugin marketplace add EveryInc/compound-engineering-plugin /plugin install compound-engineering第一条命令把 Compound Engineering 加入插件市场,第二条安装compound-engineering插件。两条命令都针对 Claude Code 的/plugin管理入口,没有额外的构建步骤。
如果之后需要升级插件,注意顺序:先刷新缓存的市场,再更新插件,否则单独运行/plugin update会一直停在旧版本(见 升级说明):
/plugin marketplace update compound-engineering-plugin /plugin update compound-engineering运行 /ce-setup 做仓库初始化
安装完成后,在任意项目的 Claude Code 会话中运行:
/ce-setupce-setup是一个诊断与配置工具,定位是"健康检查 + 仓库本地配置助手"(见 ce-setup 指南)。它有几个边界需要事先了解:
- 它只在你显式调用时运行(技能声明了
disable-model-invocation: true),聊天中谈论 setup 不会触发它。 - 它不批量安装插件依赖,也不更新插件本身。缺失的可选工具只作为"可选能力"被报告,并打印对应的安装命令,由你决定装不装。
- 它不会静默自动配置:每个会修改用户文件的动作都会先询问、给出预览,经你批准后才执行。
它会检查和修改什么
健康检查(Diagnose 阶段)覆盖:插件版本(宿主暴露时)、可选工具能力、项目配置状态、工件根目录(artifact root)、CE Work 实现引擎配置块。
之后的修复动作分为两类(见 repo-fixes 参考):
自动执行(无需批准):
- 用内置模板刷新仓库中的
.compound-engineering/config.example.yaml(在 git 仓库内总是执行)。
逐项征求批准:
- 如果
.compound-engineering/config.yaml不存在,询问是否创建。创建的文件全部以注释形式提供可选团队默认值,"你只启用需要的部分";它从不覆盖已有的config.yaml或config.local.yaml,也从不创建config.local.yaml。 - 如果
config.local.yaml已存在且未被 gitignore,提议在.gitignore追加.compound-engineering/*.local.yaml。 - 提议把
.context/compound-engineering/(CE scratch 目录)加入.gitignore,无论该目录是否已存在。 - 如果仓库有根级 agent 指令文件(
AGENTS.md、CLAUDE.md或等价文件),提议在其中加入指向<root>/solutions/知识库的说明和固定的 compounding 指令;没有这类文件时跳过该步,setup 不会创建它。 - 修复无效的 CE Work 实现引擎配置块、遗留的路由键和无效的
docs_root。 - 如检测到废弃的
compound-engineering.local.md,经批准后删除。
读懂健康报告
运行过程中会先打印Compound Engineering -- checking your environment...,然后输出诊断报告。下面是文档给出的示例结果(示例结果,实际输出取决于你机器上安装了哪些工具):
Optional capabilities 3/5 🟢 agent-browser -- browser testing and dogfood QA 🟢 gh -- GitHub PR, issue, and review workflows 🟡 ast-grep -- unavailable: syntax-aware structural code search brew install -q ast-grep五个可选工具及其对应的工作流:
| 工具 | 用途 |
|---|---|
agent-browser | 浏览器测试与 dogfood QA |
gh | GitHub PR、issue、review 工作流 |
jq | shell 工作流中的 JSON 检查 |
ast-grep | 语法感知的结构性代码搜索 |
ffmpeg | Riffrec 分析的媒体切片与截图提取 |
🟢表示工具在 PATH 上,🟡表示不可用并附带安装命令。缺工具不算 setup 失败——大多数工作流根本不会碰到ffmpeg或ast-grep,所以按文档建议只为实际使用的工作流安装。报告还会列出 Project config 各项状态(config.yaml是否存在、local 覆盖是否被 gitignore、example 配置是否最新)以及解析出的工件根:默认docs/,或config.yaml中有效的docs_root,并注明由哪个配置层提供。
报告末尾的判定行有两种形态(来自 check-health 脚本):
✅ Project config healthy. Optional capabilities available: 3/5或
⚠️ 1 project issue(s) found. Optional capabilities available: 3/5config.yaml缺失只作为"尚无仓库配置"被报告(skip),不计为项目问题;真正计入project issue的包括:废弃的compound-engineering.local.md存在、local 配置未被安全 gitignore、example 配置缺失或过期、CE Work 引擎块不可用或无效、docs_root无效、以及已退役的配置键(如plan_use_fable,提示改用plan_model)。
完成后的结果验证
全部流程结束后,/ce-setup输出这样一段摘要(格式来自 SKILL.md Phase 3,尖括号内为实际内容):
✅ Compound Engineering setup complete Fixed: <fixes applied, or none> Skipped: <fixes declined, or none> Optional: <missing optional tools, or all available> Run `/ce-setup` anytime to re-check.可以据此核对初始化是否完成:
- 批准创建配置后,仓库里出现
.compound-engineering/config.yaml(全注释模板); .compound-engineering/config.example.yaml已与内置模板一致(报告中显示 "Example config is current");- 工件根一行确认了 CE 工件将写入的位置(默认
docs/); - 摘要中
Fixed/Skipped列出了本次实际应用和拒绝的修复项。
摘要末尾打印了调用方式,/ce-setup不是流水线阶段,任何时候重跑即可复检;插件升级后建议重跑以刷新 example 配置并诊断退役或格式错误的设置。
两个配置文件怎么分工
初始化之后,仓库里有两套配置层(见 configuration 文档),理解它们可以避免常见困惑:
.compound-engineering/config.yaml:提交到仓库的团队默认值。所有设置都是可选的,注释掉的示例行只是文档,不是生效值。.compound-engineering/config.local.yaml:每份 checkout 的个人覆盖,按键覆盖仓库文件(普通键先读 local 再读 repo,第一个生效值获胜)。setup 从不创建它;若它存在,建议保持不入库(setup 可帮忙加 gitignore 条目)。- 两个文件里都不要放凭据、CLI 命令或宿主参数。
- 特例:
docs_root(把 CE 工件根从docs/迁移到其他仓库内目录)只从config.yaml读取,写在config.local.yaml里会被忽略。它是 fail-closed 的——值无效(绝对路径、../逃逸、指向仓库根或.git/内等)时 CE 工件写入直接报错停止,不会静默回落到docs/。/ce-setup能检测并协助修复这种情况。
边界与已知限制
- 在 git 仓库外运行
/ce-setup:只报告能力并停止,不写任何文件。这是预期行为,切到项目目录里再跑。 - 不批量安装依赖:想一次性装齐所有可选工具不是它的设计目标;报告里给出的安装命令只针对你实际用到的工作流。
- 升级插件 ≠ 重跑 setup:更新插件本身用宿主插件管理器(Claude Code 即上面的
/plugin marketplace update+/plugin update两条命令,顺序不能反),/ce-setup不负责这件事。 - 若健康报告标出
docs_root无效,在修复前 CE 工件不会写入任何位置——按报告给出的具体原因(绝对路径、路径逃逸、非目录等)修正或移除该键,然后重跑/ce-setup确认工件根已解析。
下一步
仓库初始化完成后,README 给出的标准循环是从一个粗略想法到已评审代码的完整路径:
/ce-brainstorm make background job retries safer /ce-plan /ce-work /ce-simplify-code /ce-code-review /ce-compound也可以把特性描述丢给/lfg让 agent 无人值守地跑完整条流水线。每个技能的完整说明在 docs/guides 的技能目录中,每项设置的取值与优先级参考 configuration 文档。
【免费下载链接】compound-engineering-pluginOfficial Compound Engineering plugin for Claude Code, Codex, Cursor, and more项目地址: https://gitcode.com/GitHub_Trending/ev/compound-engineering-plugin
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考