diff --git a/README.md b/README.md index 780f245..0c514bf 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,69 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/EveryInc/compound-engineering-plugin) · [上游 README](https://github.com/EveryInc/compound-engineering-plugin/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + # Compound Engineering [![Build Status](https://github.com/EveryInc/compound-engineering-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/EveryInc/compound-engineering-plugin/actions/workflows/ci.yml) -AI skills that make each unit of engineering work easier than the last. +让每一次工程工作都比上一次更轻松的 AI 技能。 -## Philosophy +## 理念 -**Each unit of engineering work should make subsequent units easier -- not harder.** +**每一次工程工作都应让后续工作变得更轻松——而不是更困难。** -Traditional development accumulates technical debt. Every feature adds complexity. Every bug fix leaves behind a little more local knowledge that someone has to rediscover later. The codebase gets larger, the context gets harder to hold, and the next change becomes slower. +传统开发会累积技术债。每个功能都会增加复杂度。每次修 bug 都会留下一点本地知识,后来还得有人重新发现。代码库越来越大,上下文越来越难把握,下一次改动也就越来越慢。 -Compound engineering inverts this. 80% is in planning and review, 20% is in execution: +复合工程(Compound Engineering)扭转了这一局面。80% 花在规划与评审上,20% 花在执行上: -- Plan thoroughly before writing code with `/ce-brainstorm` and `/ce-plan` using one readiness-based plan artifact -- Review to catch issues and calibrate judgment with `/ce-code-review` and `/ce-doc-review` -- Codify knowledge so it is reusable with `/ce-compound` -- Keep quality high so future changes are easy +- 写代码前用 `/ce-brainstorm` 和 `/ce-plan` 充分规划,产出一份基于就绪度(readiness)的规划产物 +- 通过 `/ce-code-review` 和 `/ce-doc-review` 评审,发现问题并校准判断 +- 用 `/ce-compound` 将知识编码化,以便复用 +- 保持高质量,让后续改动更容易 -The point is not ceremony. The point is leverage. A good brainstorm makes the plan sharper. A good plan makes execution smaller. A good review catches the pattern, not just the bug. A good compound note means the next agent does not have to learn the same lesson from scratch. +重点不在形式,而在杠杆。好的头脑风暴能让计划更锐利。好的计划能让执行更小。好的评审能抓住模式,而不只是抓住 bug。好的复合笔记意味着下一个 agent 不必从零再学同一课。 -**Learn more** +**了解更多** -- [Skill documentation catalog](docs/skills/README.md) -- [Compound engineering: how Every codes with agents](https://every.to/chain-of-thought/compound-engineering-how-every-codes-with-agents) -- [The story behind compounding engineering](https://every.to/source-code/my-ai-had-already-fixed-the-code-before-i-saw-it) +- [技能文档目录](docs/skills/README.md) +- [复合工程:Every 如何用 agent 编码](https://every.to/chain-of-thought/compound-engineering-how-every-codes-with-agents) +- [复合工程背后的故事](https://every.to/source-code/my-ai-had-already-fixed-the-code-before-i-saw-it) -## Workflow +## 工作流 -The core loop is six steps: **brainstorm** the requirements, **plan** the implementation, **work** through the plan, **simplify** what you wrote, **review** the result, then **compound** the learning -- and repeat with better context. +核心循环共六步:**头脑风暴**(brainstorm)需求、**规划**(plan)实现、**执行**(work)计划、**简化**(simplify)所写内容、**评审**(review)结果,然后**复合**(compound)所学——并以更好的上下文重复。 -| Skill | Purpose | +| Skill | 用途 | |-------|---------| -| [`/ce-brainstorm`](docs/skills/ce-brainstorm.md) | Interactive Q&A to think through a feature or problem and write a requirements-only unified plan before planning | -| [`/ce-plan`](docs/skills/ce-plan.md) | Enrich feature ideas or requirements-only plans into implementation-ready plans | -| [`/ce-work`](docs/skills/ce-work.md) | Execute implementation-ready plans with worktrees and task tracking | -| [`/ce-simplify-code`](docs/skills/ce-simplify-code.md) | Refine the freshly written code for clarity and reuse before review | -| [`/ce-code-review`](docs/skills/ce-code-review.md) | Multi-agent review against the plan before merging | -| [`/ce-compound`](docs/skills/ce-compound.md) | Capture the learning into `docs/solutions/` so the next loop starts smarter | +| [`/ce-brainstorm`](docs/skills/ce-brainstorm.md) | 交互式问答,在规划前思考功能或问题,并撰写仅含需求的统一计划 | +| [`/ce-plan`](docs/skills/ce-plan.md) | 将功能想法或仅含需求的计划充实为可实施的规划 | +| [`/ce-work`](docs/skills/ce-work.md) | 使用 worktree 和任务跟踪执行可实施的规划 | +| [`/ce-simplify-code`](docs/skills/ce-simplify-code.md) | 在评审前精炼新写代码,提升清晰度与可复用性 | +| [`/ce-code-review`](docs/skills/ce-code-review.md) | 合并前对照计划进行多 agent 评审 | +| [`/ce-compound`](docs/skills/ce-compound.md) | 将所学沉淀到 `docs/solutions/`,让下一轮循环更聪明地开始 | -Each cycle compounds: `/ce-compound` writes learnings that the next `/ce-brainstorm` and `/ce-plan` read as grounding -- brainstorms sharpen plans, plans inform future plans, reviews catch more issues, patterns get documented. That return arrow is the whole point. +每一轮都会复合:`/ce-compound` 写下所学,供下一轮 `/ce-brainstorm` 和 `/ce-plan` 作为 grounding 读取——头脑风暴让计划更锐利,计划反哺未来计划,评审发现更多问题,模式被文档化。这条回馈箭头才是要点。 -### Additional skills +### 附加技能 -These sit around the loop or get reached for on demand -- not every cycle needs them. +它们围绕循环存在,或按需取用——并非每轮循环都需要。 -| Skill | When to reach for it | +| Skill | 何时使用 | |-------|---------| -| [`/ce-ideate`](docs/skills/ce-ideate.md) | *Before the loop*, when you don't yet know what to build -- generates and critically ranks grounded ideas, then routes the strongest one into `/ce-brainstorm` | -| [`/ce-strategy`](docs/skills/ce-strategy.md) | *Upstream anchor* -- creates and maintains `STRATEGY.md`, read as grounding by ideate, brainstorm, and plan so strategy choices flow into every feature | -| [`/ce-product-pulse`](docs/skills/ce-product-pulse.md) | *Outer loop* -- a time-windowed report on what users actually experienced (usage, performance, errors), saved to `docs/pulse-reports/`; its follow-ups feed back into ideation and brainstorming | -| [`/ce-debug`](docs/skills/ce-debug.md) | *Instead of brainstorm -> plan -> work* when the input is a bug rather than a feature -- reproduce, trace root cause, fix, then polish/review before PR handoff when warranted | -| [`/ce-pov`](docs/skills/ce-pov.md) | *On demand, before you commit* -- a decisive, project-grounded verdict on whether to adopt, switch to, or revisit an external technology, library, pattern, or platform; works cold or mid-session, and proposes the next step (`/ce-plan`, `/ce-brainstorm`, or a spike) from the verdict | -| [`/ce-explain`](docs/skills/ce-explain.md) | *On demand, to keep learning* -- turns a concept, a diff, an idea, or "what did I do this week?" into a dense, visual explainer written for you personally, with an optional check-in (predict-then-reveal for diffs, corrected exercises) that makes it stick | +| [`/ce-ideate`](docs/skills/ce-ideate.md) | *循环之前*,当你还不知道要构建什么时——生成并严格排序有依据的想法,然后将最强候选路由到 `/ce-brainstorm` | +| [`/ce-strategy`](docs/skills/ce-strategy.md) | *上游锚点*——创建并维护 `STRATEGY.md`,供 ideate、brainstorm 和 plan 作为 grounding 读取,使战略选择流入每个功能 | +| [`/ce-product-pulse`](docs/skills/ce-product-pulse.md) | *外环*——关于用户实际体验(使用、性能、错误)的按时间窗口报告,保存到 `docs/pulse-reports/`;其后续行动反馈到构思与头脑风暴 | +| [`/ce-debug`](docs/skills/ce-debug.md) | *替代 brainstorm -> plan -> work*,当输入是 bug 而非功能时——复现、追溯根因、修复,然后在适当时于 PR 交接前打磨/评审 | +| [`/ce-pov`](docs/skills/ce-pov.md) | *按需,在提交之前*——对是否采用、切换或重新审视外部技术、库、模式或平台给出果断、基于项目的裁决;可冷启动或会话中途使用,并根据裁决提出下一步(`/ce-plan`、`/ce-brainstorm`,或 spike) | +| [`/ce-explain`](docs/skills/ce-explain.md) | *按需,持续学习*——将概念、diff、想法或「我这周做了什么?」转化为为你个人撰写的密集可视化讲解,并可选加入巩固环节(diff 的预测-揭示、纠错练习) | -For the full catalog and how each skill chains together, see [docs/skills](docs/skills/README.md). The complete inventory is [below](#full-skill-inventory). +完整目录及各技能如何串联,见 [docs/skills](docs/skills/README.md)。完整清单见[下文](#full-skill-inventory)。 -## Quick Example +## 快速示例 -**Finding a direction** -- when you don't have a specific idea yet, ideate first, then carry the strongest survivor into the loop: +**寻找方向**——当你还没有具体想法时,先 ideate,再将最强幸存者带入循环: ```text /ce-ideate new drawing tools @@ -65,9 +71,9 @@ For the full catalog and how each skill chains together, see [docs/skills](docs/ /ce-ideate github issues # ground ideas in your open issues instead of a prompt ``` -`/ce-ideate` does the homework first (codebase, past learnings, prior art on the web, optionally your issue tracker), then hands you a ranked set of grounded candidates to take into `/ce-brainstorm`. +`/ce-ideate` 先做功课(代码库、过往所学、网上先例,可选你的 issue tracker),然后交给你一组有依据的排序候选,供带入 `/ce-brainstorm`。 -**Standard feature loop** -- turn a rough idea into shipped, reviewed code: +**标准功能循环**——将粗略想法变为已交付、已评审的代码: ```text /ce-brainstorm make background job retries safer @@ -78,16 +84,16 @@ For the full catalog and how each skill chains together, see [docs/skills](docs/ /ce-compound ``` -**Simplifying code** -- use it after fresh implementation work, or point it at code that keeps slowing changes down: +**简化代码**——在新实现之后使用,或指向持续拖慢改动的代码: ```text /ce-simplify-code /ce-simplify-code simplify the code in my most-churned file ``` -The first pass tightens recent branch changes before review. The targeted pass is useful when one file keeps absorbing unrelated fixes, follow-ups, or merge conflicts. +第一轮在评审前收紧近期分支改动。定向 pass 适用于某个文件不断吸收无关修复、后续跟进或合并冲突的情况。 -**Debugging a bug** -- when you start from broken behavior instead of a feature: +**调试 bug**——当你从异常行为而非功能出发时: ```text /ce-debug the checkout webhook sometimes creates duplicate invoices @@ -95,59 +101,59 @@ The first pass tightens recent branch changes before review. The targeted pass i /ce-compound ``` -**Autonomous** -- hand off a feature and let the agent run the whole pipeline: +**自主运行**——交接一个功能,让 agent 跑完整条流水线: ```text /ce-brainstorm describe the feature /lfg ``` -`/lfg` runs the loop hands-off: it plans, works through the plan, simplifies, runs code review and applies the fixes, runs browser tests, commits, pushes, opens a PR, then watches CI and repairs failures until it's green. Start it after `/ce-brainstorm` so it plans against real requirements rather than a one-line prompt. It's the autopilot version of the standard loop -- neat when you want to step away and come back to an open, green PR. +`/lfg` 免手操作跑完整循环:规划、执行计划、简化、运行代码评审并应用修复、运行浏览器测试、提交、推送、开 PR,然后盯 CI 并修复失败直至变绿。在 `/ce-brainstorm` 之后启动,以便对照真实需求规划,而非一行提示。它是标准循环的自动驾驶版——想暂时离开、回来时看到已打开且 CI 全绿的 PR 时很合适。 -## Getting Started +## 入门 -After installing, run `/ce-setup` in any project. It checks repo-local config, reports optional tool capabilities, and helps keep machine-local CE settings safely gitignored. +安装后,在任意项目中运行 `/ce-setup`。它会检查仓库本地配置、报告可选工具能力,并帮助将机器本地的 CE 设置安全地 gitignore。 -The `compound-engineering` plugin currently ships 30 skills and 0 standalone agents. Specialist review, research, and workflow behavior lives inside the owning skills as skill-local prompt assets. +`compound-engineering` 插件目前提供 30 个技能和 0 个独立 agent。专项评审、研究与工作流行为内置于所属技能,作为技能本地 prompt 资产。 -### Full Skill Inventory +### 完整技能清单 -| Skill | Purpose | +| Skill | 用途 | |-------|---------| -| [`/ce-strategy`](docs/skills/ce-strategy.md) | Create or maintain `STRATEGY.md` | -| [`/ce-ideate`](docs/skills/ce-ideate.md) | Generate and critically evaluate grounded ideas | -| [`/ce-pov`](docs/skills/ce-pov.md) | Form a decisive, project-grounded verdict on an external input | -| [`/ce-explain`](docs/skills/ce-explain.md) | Explain a concept, diff, idea, or window of your own work as a personal learning artifact | -| [`/ce-brainstorm`](docs/skills/ce-brainstorm.md) | Explore requirements and write a right-sized requirements doc | -| [`/ce-plan`](docs/skills/ce-plan.md) | Create structured implementation plans | -| [`/ce-work`](docs/skills/ce-work.md) | Execute implementation plans systematically | -| [`/ce-code-review`](docs/skills/ce-code-review.md) | Review code with skill-local reviewer personas | -| [`/ce-doc-review`](docs/skills/ce-doc-review.md) | Review requirements and plan documents | -| [`/ce-debug`](docs/skills/ce-debug.md) | Reproduce failures, trace root cause, fix bugs, and prepare non-trivial fixes for PR | -| [`/ce-compound`](docs/skills/ce-compound.md) | Document solved problems to compound team knowledge | -| [`/ce-compound-refresh`](docs/skills/ce-compound-refresh.md) | Refresh stale or drifting learnings | -| [`/ce-optimize`](docs/skills/ce-optimize.md) | Run iterative optimization loops | -| [`/ce-product-pulse`](docs/skills/ce-product-pulse.md) | Generate time-windowed product pulse reports | -| [`/ce-riffrec-feedback-analysis`](docs/skills/ce-riffrec-feedback-analysis.md) | Convert Riffrec recordings or notes into structured feedback | -| [`/ce-sweep`](docs/skills/ce-sweep.md) | Sweep feedback sources, track item lifecycles, and emit an `/lfg`-ready plan | -| [`/ce-resolve-pr-feedback`](docs/skills/ce-resolve-pr-feedback.md) | Resolve PR review feedback | -| [`/ce-commit`](docs/skills/ce-commit.md) | Create a git commit with a clear message | -| [`/ce-commit-push-pr`](docs/skills/ce-commit-push-pr.md) | Commit, push, and open a PR that teaches any concept the change newly introduces | -| [`/ce-babysit-pr`](docs/skills/ce-babysit-pr.md) | Watch an open PR and keep it moving toward merge, reacting to review comments and CI as they arrive | -| [`/ce-worktree`](docs/skills/ce-worktree.md) | Ensure work happens in an isolated git worktree | -| [`/ce-promote`](docs/skills/ce-promote.md) | Draft user-facing announcement copy | -| [`/ce-test-browser`](docs/skills/ce-test-browser.md) | Run browser tests on PR-affected pages | -| [`/ce-test-xcode`](docs/skills/ce-test-xcode.md) | Build and test iOS apps on simulator | -| [`/ce-setup`](docs/skills/ce-setup.md) | Diagnose optional tool capabilities and project config | -| [`/ce-simplify-code`](docs/skills/ce-simplify-code.md) | Simplify recent code changes | -| [`/ce-polish`](docs/skills/ce-polish.md) | Start a dev server and iterate on UX polish | -| [`/ce-proof`](docs/skills/ce-proof.md) | Create, edit, and share Proof documents | -| [`/ce-dogfood`](docs/skills/ce-dogfood.md) | Hands-off diff-scoped browser QA of the active branch, with autonomous fixes | -| [`/lfg`](docs/skills/lfg.md) | Full autonomous engineering workflow | +| [`/ce-strategy`](docs/skills/ce-strategy.md) | 创建或维护 `STRATEGY.md` | +| [`/ce-ideate`](docs/skills/ce-ideate.md) | 生成并严格评估有依据的想法 | +| [`/ce-pov`](docs/skills/ce-pov.md) | 对外部输入形成果断、基于项目的裁决 | +| [`/ce-explain`](docs/skills/ce-explain.md) | 将概念、diff、想法或你自己工作的一段窗口解释为你的个人学习产物 | +| [`/ce-brainstorm`](docs/skills/ce-brainstorm.md) | 探索需求并撰写体量合适的 requirements doc | +| [`/ce-plan`](docs/skills/ce-plan.md) | 创建结构化实施计划 | +| [`/ce-work`](docs/skills/ce-work.md) | 系统化执行实施计划 | +| [`/ce-code-review`](docs/skills/ce-code-review.md) | 使用技能本地评审者 persona 评审代码 | +| [`/ce-doc-review`](docs/skills/ce-doc-review.md) | 评审需求与计划文档 | +| [`/ce-debug`](docs/skills/ce-debug.md) | 复现失败、追溯根因、修复 bug,并为非平凡修复准备 PR | +| [`/ce-compound`](docs/skills/ce-compound.md) | 记录已解决问题以复合团队知识 | +| [`/ce-compound-refresh`](docs/skills/ce-compound-refresh.md) | 刷新陈旧或漂移的所学 | +| [`/ce-optimize`](docs/skills/ce-optimize.md) | 运行迭代优化循环 | +| [`/ce-product-pulse`](docs/skills/ce-product-pulse.md) | 生成按时间窗口的产品脉搏报告 | +| [`/ce-riffrec-feedback-analysis`](docs/skills/ce-riffrec-feedback-analysis.md) | 将 Riffrec 录音或笔记转化为结构化反馈 | +| [`/ce-sweep`](docs/skills/ce-sweep.md) | 扫描反馈来源、跟踪条目生命周期,并输出 `/lfg`-ready 计划 | +| [`/ce-resolve-pr-feedback`](docs/skills/ce-resolve-pr-feedback.md) | 处理 PR 评审反馈 | +| [`/ce-commit`](docs/skills/ce-commit.md) | 创建带清晰信息的 git commit | +| [`/ce-commit-push-pr`](docs/skills/ce-commit-push-pr.md) | 提交、推送并打开 PR,讲解变更新引入的任何概念 | +| [`/ce-babysit-pr`](docs/skills/ce-babysit-pr.md) | 盯守已打开的 PR 并推动其走向合并,随评审评论与 CI 到达而响应 | +| [`/ce-worktree`](docs/skills/ce-worktree.md) | 确保工作在隔离的 git worktree 中进行 | +| [`/ce-promote`](docs/skills/ce-promote.md) | 起草面向用户的公告文案 | +| [`/ce-test-browser`](docs/skills/ce-test-browser.md) | 对 PR 影响的页面运行浏览器测试 | +| [`/ce-test-xcode`](docs/skills/ce-test-xcode.md) | 在模拟器上构建并测试 iOS 应用 | +| [`/ce-setup`](docs/skills/ce-setup.md) | 诊断可选工具能力与项目配置 | +| [`/ce-simplify-code`](docs/skills/ce-simplify-code.md) | 简化近期代码改动 | +| [`/ce-polish`](docs/skills/ce-polish.md) | 启动开发服务器并迭代 UX 打磨 | +| [`/ce-proof`](docs/skills/ce-proof.md) | 创建、编辑并分享 Proof 文档 | +| [`/ce-dogfood`](docs/skills/ce-dogfood.md) | 对活跃分支进行免手操作的 diff 范围浏览器 QA,并自主修复 | +| [`/lfg`](docs/skills/lfg.md) | 完整自主工程工作流 --- -## Install +## 安装 ### Claude Code @@ -156,25 +162,25 @@ The `compound-engineering` plugin currently ships 30 skills and 0 standalone age /plugin install compound-engineering ``` -> **Already have Compound Engineering installed?** Compound Engineering moved to a root-native layout. You must refresh the marketplace *before* updating — see [Existing Installs](#existing-installs). Running `/plugin update` alone keeps you on the old version. +> **已经安装过 Compound Engineering?** Compound Engineering 已迁移为根目录原生(root-native)布局。更新前必须先刷新 marketplace — 参见[已有安装](#existing-installs)。仅运行 `/plugin update` 会让你停留在旧版本。 ### Cursor -In Cursor Agent chat, install from the plugin marketplace: +在 Cursor Agent 聊天中,从插件 marketplace 安装: ```text /add-plugin compound-engineering ``` -Or search for "compound engineering" in the plugin marketplace. +或在插件 marketplace 中搜索 "compound engineering"。 ### Codex App -Compound Engineering is not listed in Codex's built-in plugin marketplace yet. Add it as a custom marketplace: +Compound Engineering 尚未列入 Codex 内置插件 marketplace。请将其添加为自定义 marketplace: -1. In the Codex app, open **Plugins** from the sidebar. -2. Click **Add** / **Add plugin marketplace**. -3. Enter: +1. 在 Codex 应用中,从侧边栏打开 **Plugins**。 +2. 点击 **Add** / **Add plugin marketplace**。 +3. 填写: | Field | Value | | --- | --- | @@ -182,147 +188,147 @@ Compound Engineering is not listed in Codex's built-in plugin marketplace yet. A | Git ref | `main` | | Sparse paths | leave blank | -4. Click **Add marketplace**. -5. Select **Compound Engineering**, install **compound-engineering**, then restart Codex. +4. 点击 **Add marketplace**。 +5. 选择 **Compound Engineering**,安装 **compound-engineering**,然后重启 Codex。 -The Codex app install is self-contained for Compound Engineering. Specialist reviewer and research behavior lives inside the skills as local prompt assets; no separate custom-agent install step is required. +Codex 应用安装对 Compound Engineering 而言是自包含的。专家 reviewer 与研究行为内置于 skills 中,作为本地 prompt 资源;无需单独安装 custom-agent 步骤。 ### Codex CLI -Register the marketplace, then install the plugin. +注册 marketplace,然后安装插件。 -1. **Register the marketplace with Codex:** +1. **向 Codex 注册 marketplace:** ```bash codex plugin marketplace add EveryInc/compound-engineering-plugin ``` -2. **Install the plugin:** +2. **安装插件:** ```bash codex plugin add compound-engineering@compound-engineering-plugin ``` - You can also launch `codex`, run `/plugins`, find the **Compound Engineering** marketplace, select the **compound-engineering** plugin, and choose **Install**. Restart Codex after install completes. + 你也可以启动 `codex`,运行 `/plugins`,找到 **Compound Engineering** marketplace,选择 **compound-engineering** 插件,然后选择 **Install**。安装完成后重启 Codex。 -The native Codex plugin install is self-contained for Compound Engineering. Specialist reviewer and research behavior lives inside the skills as local prompt assets; no separate custom-agent install step is required. +原生 Codex 插件安装对 Compound Engineering 而言是自包含的。专家 reviewer 与研究行为内置于 skills 中,作为本地 prompt 资源;无需单独安装 custom-agent 步骤。 -For a non-default Codex profile, run every Codex-related step against the same `CODEX_HOME`. This example installs CE into a `work` profile: +对于非默认 Codex profile,请针对同一 `CODEX_HOME` 执行所有与 Codex 相关的步骤。以下示例将 CE 安装到 `work` profile: ```bash CODEX_HOME="$HOME/.codex/profiles/work" codex plugin marketplace add EveryInc/compound-engineering-plugin CODEX_HOME="$HOME/.codex/profiles/work" codex plugin add compound-engineering@compound-engineering-plugin ``` -The marketplace step only makes the plugin available; the plugin install is what activates the native CE skills for that profile. +marketplace 步骤仅使插件可用;插件安装才会为该 profile 激活原生 CE skills。 ### Kimi Code CLI -Kimi Code CLI can install Compound Engineering directly from this repository because the repo ships a native `.kimi-plugin/plugin.json` manifest: +Kimi Code CLI 可直接从本仓库安装 Compound Engineering,因为仓库提供了原生 `.kimi-plugin/plugin.json` manifest: ```text /plugins install https://github.com/EveryInc/compound-engineering-plugin ``` -You can also browse it through Kimi's custom marketplace flow: +你也可以通过 Kimi 的自定义 marketplace 流程浏览: ```text /plugins marketplace https://raw.githubusercontent.com/EveryInc/compound-engineering-plugin/main/.kimi-plugin/marketplace.json ``` -After installing or updating, run `/reload` or start a new Kimi session so the plugin skills are loaded. +安装或更新后,运行 `/reload` 或开启新的 Kimi 会话,以加载插件 skills。 ### Cline -Cline loads CE skills from on-demand `SKILL.md` directories. Enable **Settings -> Features -> Enable Skills** in the Cline extension, then link this repository's skills globally or per project: +Cline 从按需加载的 `SKILL.md` 目录中加载 CE skills。在 Cline 扩展中启用 **Settings -> Features -> Enable Skills**,然后将本仓库的 skills 全局或按项目链接: ```bash git clone https://github.com/EveryInc/compound-engineering-plugin ./compound-engineering-plugin/.cline/scripts/install-skills.sh --global ``` -Per-project install from a checkout: +从 checkout 按项目安装: ```bash ./compound-engineering-plugin/.cline/scripts/install-skills.sh --project ``` -Start a new Cline task after installing or updating skills. See [`.cline/INSTALL.md`](.cline/INSTALL.md) for pinning, local development, and uninstall steps. +安装或更新 skills 后,请开启新的 Cline 任务。有关固定版本、本地开发与卸载步骤,参见 [`.cline/INSTALL.md`](.cline/INSTALL.md)。 -### Grok Build CLI (`grok`) +### Grok Build CLI(`grok`) -xAI's [Grok Build CLI](https://x.ai/cli) (`grok`) installs Compound Engineering directly from this repository — the repo root is a valid Grok plugin (`grok` reads the existing Claude-compatible manifests, and the repo also ships a native `.grok-plugin/plugin.json`): +xAI 的 [Grok Build CLI](https://x.ai/cli) (`grok`) 可直接从本仓库安装 Compound Engineering — 仓库根目录是有效的 Grok 插件(`grok` 会读取现有的 Claude 兼容 manifest,仓库也提供了原生 `.grok-plugin/plugin.json`): ```bash grok plugin install EveryInc/compound-engineering-plugin ``` -This tracks the repository; run `grok plugin update` to pull the latest. To browse it as a marketplace source instead, the repo ships a native `.grok-plugin/marketplace.json`: +该方式跟踪仓库;运行 `grok plugin update` 可拉取最新版本。若要以 marketplace 源方式浏览,仓库提供了原生 `.grok-plugin/marketplace.json`: ```bash grok plugin marketplace add EveryInc/compound-engineering-plugin grok plugin install compound-engineering ``` -Both paths track the repository directly (no commit pin), so no Bun install step is needed. Add `--trust` to skip the install confirmation. `grok` stores config under `~/.grok`; start a new session after installing so the skills load. +两种路径都直接跟踪仓库(无 commit pin),因此无需 Bun 安装步骤。添加 `--trust` 可跳过安装确认。`grok` 将配置存储在 `~/.grok` 下;安装后请开启新会话以加载 skills。 -Compound Engineering is also being submitted to the official [xAI plugin marketplace](https://github.com/xai-org/plugin-marketplace); see [`docs/grok-marketplace-submission.md`](docs/grok-marketplace-submission.md) for the maintainer runbook. +Compound Engineering 也正在提交至官方 [xAI plugin marketplace](https://github.com/xai-org/plugin-marketplace); 维护者操作手册见 [`docs/grok-marketplace-submission.md`](docs/grok-marketplace-submission.md)。 ### Devin CLI -Devin CLI can install Compound Engineering directly from GitHub because the repo ships a native `.devin-plugin/plugin.json` manifest: +Devin CLI 可直接从 GitHub 安装 Compound Engineering,因为仓库提供了原生 `.devin-plugin/plugin.json` manifest: ```bash devin plugins install EveryInc/compound-engineering-plugin ``` -Verify the install and inspect the skills: +验证安装并检查 skills: ```bash devin plugins list devin plugins info compound-engineering ``` -Update to the latest version with `devin plugins update compound-engineering`. Plugins load at session start, so start a new Devin session after installing or updating for the skills to appear (as `/compound-engineering:` slash commands). +使用 `devin plugins update compound-engineering` 更新到最新版本。插件在会话启动时加载,因此安装或更新后请开启新的 Devin 会话,skills 才会出现(以 `/compound-engineering:` slash 命令形式)。 -A few skills declare Claude-style `allowed-tools` names that Devin does not map (for example `Bash`); those skills still work, but some of their actions ask for permission instead of running auto-approved. See [`docs/specs/devin.md`](docs/specs/devin.md) for details. +部分 skills 声明了 Devin 不映射的 Claude 风格 `allowed-tools` 名称(例如 `Bash`);这些 skills 仍可使用,但其部分操作会请求权限,而非自动批准执行。详情参见 [`docs/specs/devin.md`](docs/specs/devin.md)。 ### GitHub Copilot -For **VS Code Copilot Agent Plugins**: +对于 **VS Code Copilot Agent Plugins**: -1. Run `Chat: Install Plugin from Source` from the VS Code command palette -2. Use `EveryInc/compound-engineering-plugin` for the repo -3. Select `compound-engineering` when VS Code shows the plugins in this repository +1. 在 VS Code 命令面板中运行 `Chat: Install Plugin from Source` +2. 将 `EveryInc/compound-engineering-plugin` 用作仓库 +3. 当 VS Code 显示本仓库中的插件时,选择 `compound-engineering` -For **Copilot CLI**, use: +对于 **Copilot CLI**,使用: -Inside Copilot CLI: +在 Copilot CLI 内: ```text /plugin marketplace add EveryInc/compound-engineering-plugin /plugin install compound-engineering@compound-engineering-plugin ``` -From a shell with the `copilot` binary: +在已安装 `copilot` 二进制文件的 shell 中: ```bash copilot plugin marketplace add EveryInc/compound-engineering-plugin copilot plugin install compound-engineering@compound-engineering-plugin ``` -Copilot CLI reads the existing Claude-compatible plugin manifests, so no separate Bun install step is needed. +Copilot CLI 会读取现有的 Claude 兼容插件 manifest,因此无需单独的 Bun 安装步骤。 ### Factory Droid -From a shell with the `droid` binary: +在已安装 `droid` 二进制文件的 shell 中: ```bash droid plugin marketplace add https://github.com/EveryInc/compound-engineering-plugin droid plugin install compound-engineering@compound-engineering-plugin ``` -Droid uses `plugin@marketplace` plugin IDs; here `compound-engineering` is the plugin and `compound-engineering-plugin` is the marketplace name. Droid installs the existing Claude Code-compatible plugin and translates the format automatically, so no Bun install step is needed. +Droid 使用 `plugin@marketplace` 插件 ID;此处 `compound-engineering` 是插件,`compound-engineering-plugin` 是 marketplace 名称。Droid 会安装现有的 Claude Code 兼容插件,并在安装时自动转换格式,因此无需 Bun 安装步骤。 ### Qwen Code @@ -330,11 +336,11 @@ Droid uses `plugin@marketplace` plugin IDs; here `compound-engineering` is the p qwen extensions install EveryInc/compound-engineering-plugin:compound-engineering ``` -Qwen Code installs Claude Code-compatible plugins directly from GitHub and converts the plugin format during install, so no Bun install step is needed. +Qwen Code 可直接从 GitHub 安装 Claude Code 兼容插件,并在安装时转换插件格式,因此无需 Bun 安装步骤。 ### OpenCode -Add Compound Engineering to the `plugin` array in your global or project `opencode.json`: +在全局或项目级 `opencode.json` 的 `plugin` 数组中添加 Compound Engineering: ```json { @@ -342,23 +348,23 @@ Add Compound Engineering to the `plugin` array in your global or project `openco } ``` -Restart OpenCode after changing the config. The OpenCode plugin registers the Compound Engineering skills directory directly; no Bun installer or generated skill copy is required. See [`.opencode/INSTALL.md`](.opencode/INSTALL.md) for pinning examples. +修改配置后重启 OpenCode。OpenCode 插件会直接注册 Compound Engineering skills 目录;无需 Bun 安装器或生成的 skill 副本。固定版本示例参见 [`.opencode/INSTALL.md`](.opencode/INSTALL.md)。 ### Pi -Install Compound Engineering as a Pi package from this repository: +从本仓库将 Compound Engineering 安装为 Pi 包: ```bash pi install git:github.com/EveryInc/compound-engineering-plugin ``` -Required companion for CE workflows that dispatch reviewer, research, or implementation subagents: +对于会调度 reviewer、research 或 implementation 子代理(subagent)的 CE 工作流,所需配套组件: ```bash pi install npm:pi-subagents ``` -Recommended companion for richer blocking questions: +推荐搭配使用,以获得更丰富的阻断式提问体验: ```bash pi install npm:pi-ask-user @@ -366,28 +372,28 @@ pi install npm:pi-ask-user ### Antigravity CLI (`agy`) -Google has replaced the consumer Gemini CLI with [Antigravity CLI](https://antigravity.google) (`agy`), which still runs on Gemini models. Install Compound Engineering directly from GitHub — no clone step required: +Google 已用 [Antigravity CLI](https://antigravity.google) (`agy`) 取代面向消费者的 Gemini CLI,后者仍运行在 Gemini 模型上。可直接从 GitHub 安装 Compound Engineering —— 无需克隆步骤: ```bash agy plugin install https://github.com/EveryInc/compound-engineering-plugin ``` -Verify with `agy plugin list`. The repository root is the plugin package (`plugin.json` plus `skills/`). +使用 `agy plugin list` 进行验证。仓库根目录即为插件包(`plugin.json` 加上 `skills/`)。 -For a local checkout or pinned release: +若需本地检出或固定版本发布: ```bash git clone https://github.com/EveryInc/compound-engineering-plugin agy plugin install ./compound-engineering-plugin ``` -The bundled `.agy/` directory remains a compatibility entry point (`agy plugin install ./compound-engineering-plugin/.agy`). `agy` also loads `GEMINI.md` workspace context from the checkout. +捆绑的 `.agy/` 目录仍作为兼容性入口(`agy plugin install ./compound-engineering-plugin/.agy`)。`agy` 也会从该检出加载 `GEMINI.md` 工作区上下文。 -See [`.agy/INSTALL.md`](.agy/INSTALL.md) for pinning, local development, uninstall, and legacy Gemini import. +有关固定版本、本地开发、卸载及旧版 Gemini 导入,请参阅 [`.agy/INSTALL.md`](.agy/INSTALL.md)。 -### Existing Installs +### 已有安装 -Compound Engineering moved to a root-native, skills-only layout. An existing marketplace install keeps a **cached** marketplace snapshot that still points at the old `plugins/compound-engineering` path, so updating the plugin on its own reads that stale snapshot and leaves you on the previous version. Refresh the cached marketplace **first**, then update the plugin — order matters. +Compound Engineering 已迁移为根目录原生、仅含 skills 的布局。已有的 marketplace 安装会保留一份**缓存**的 marketplace 快照,该快照仍指向旧的 `plugins/compound-engineering` 路径,因此单独更新插件会读取这份过期快照,使你停留在旧版本。请先刷新缓存的 marketplace,再更新插件 —— 顺序很重要。 **Claude Code** @@ -403,15 +409,15 @@ codex plugin marketplace upgrade compound-engineering-plugin codex plugin add compound-engineering@compound-engineering-plugin ``` -There is no `codex plugin update`; re-running `add` reinstalls from the refreshed snapshot. For a non-default profile, run both commands against the same `CODEX_HOME`. +没有 `codex plugin update`;重新运行 `add` 会从刷新后的快照重新安装。若使用非默认 profile,请对同一 `CODEX_HOME` 执行上述两条命令。 **Codex App** -Refresh the marketplace from the **Plugins** panel (remove and re-add the `EveryInc/compound-engineering-plugin` marketplace if there is no refresh control), then reinstall **compound-engineering** and restart Codex. +从 **Plugins** 面板刷新 marketplace(若无刷新控件,则移除并重新添加 `EveryInc/compound-engineering-plugin` marketplace),然后重新安装 **compound-engineering** 并重启 Codex。 -If you configured a host with a direct path or sparse path under `plugins/compound-engineering`, edit or reinstall that source so it points at the repository root with no sparse path. +若你配置的主机使用了 `plugins/compound-engineering` 下的直接路径或 sparse path,请编辑或重新安装该源,使其指向仓库根目录且不设置 sparse path。 -If a previous Bun-installed copy is still shadowing native plugin skills, run the current cleanup command from a checkout of this repository: +若先前通过 Bun 安装的副本仍在覆盖原生插件 skills,请在本仓库的检出目录中运行当前的清理命令: ```bash git clone https://github.com/EveryInc/compound-engineering-plugin.git /tmp/compound-engineering-plugin-cleanup @@ -422,7 +428,7 @@ bun run cleanup --target all --- -## Local Development +## 本地开发 ```bash bun install @@ -430,9 +436,9 @@ bun test bun run release:validate ``` -### From your local checkout +### 从本地检出 -For active development, load this checkout directly in the harness you want to test. +进行活跃开发时,请在你希望测试的 harness 中直接加载此检出。 **Claude Code** @@ -442,13 +448,13 @@ claude --plugin-dir "$PWD" **Codex App** -In the app's **Add plugin marketplace** form, use this checkout as the source: +在应用的 **Add plugin marketplace** 表单中,将此检出作为源: | Field | Value | | --- | --- | | Source | `/path/to/compound-engineering-plugin` | -| Git ref | current branch, or leave blank for a local folder | -| Sparse paths | leave blank | +| Git ref | 当前分支,或本地文件夹留空 | +| Sparse paths | 留空 | **Codex CLI** @@ -457,17 +463,17 @@ codex plugin marketplace add "$PWD" codex plugin add compound-engineering@compound-engineering-plugin ``` -Use a separate `CODEX_HOME` when you want to keep local testing isolated from your normal Codex profile. The Codex marketplace entry points at the public Git plugin source so root-shaped plugin repos install correctly; use a temporary marketplace catalog with a `source.url` plus `ref` when testing unpublished plugin-content changes end to end. +若希望将本地测试与常规 Codex profile 隔离,请使用单独的 `CODEX_HOME`。Codex marketplace 条目指向公共 Git 插件源,以便根目录形态的插件仓库能正确安装;端到端测试未发布的插件内容变更时,请使用带有 `source.url` 和 `ref` 的临时 marketplace 目录。 **Kimi Code CLI** -Inside Kimi Code CLI: +在 Kimi Code CLI 内: ```text /plugins install /path/to/compound-engineering-plugin ``` -To test the local marketplace catalog instead, pass the catalog path: +若要测试本地 marketplace 目录,请传入目录路径: ```text /plugins marketplace /path/to/compound-engineering-plugin/.kimi-plugin/marketplace.json @@ -479,7 +485,7 @@ To test the local marketplace catalog instead, pass the catalog path: /path/to/compound-engineering-plugin/.cline/scripts/install-skills.sh --global ``` -Enable **Settings -> Features -> Enable Skills** in the Cline extension, then start a new task. +在 Cline 扩展中启用 **Settings -> Features -> Enable Skills**,然后启动新任务。 **Devin CLI** @@ -487,7 +493,7 @@ Enable **Settings -> Features -> Enable Skills** in the Cline extension, then st devin plugins install /path/to/compound-engineering-plugin ``` -Local installs are linked to the checkout rather than copied, so skill edits apply on the next Devin session without reinstalling. +本地安装会链接到检出目录而非复制,因此修改 skill 后无需重新安装,下次 Devin 会话即可生效。 **OpenCode** @@ -497,7 +503,7 @@ Local installs are linked to the checkout rather than copied, so skill edits app } ``` -Restart OpenCode after changing `opencode.json`. +修改 `opencode.json` 后请重启 OpenCode。 **Pi** @@ -512,42 +518,42 @@ agy plugin install "$PWD" agy plugin validate "$PWD" ``` -Or install the bundled `.agy/` entry point: +或安装捆绑的 `.agy/` 入口: ```bash agy plugin install "$PWD/.agy" ``` -See [`.agy/INSTALL.md`](.agy/INSTALL.md) for remote install and pinning examples. +有关远程安装与固定版本示例,请参阅 [`.agy/INSTALL.md`](.agy/INSTALL.md)。 -## Limitations +## 限制 -OpenCode and Pi use native package/plugin loading from this repository. The Bun CLI remains for repository development and converter maintenance, not normal installation. +OpenCode 和 Pi 使用本仓库的原生包/插件加载方式。Bun CLI 仍用于仓库开发与转换器维护,而非日常安装。 -Release versions are owned by release automation. Routine feature PRs should not hand-bump plugin or marketplace manifest versions. +发布版本由发布自动化管理。常规功能 PR 不应手动提升插件或 marketplace manifest 版本号。 -## FAQ +## 常见问题 -### Do I need Bun to install Compound Engineering? +### 安装 Compound Engineering 需要 Bun 吗? -No. Bun is only needed for repo development tasks and converter maintenance. +不需要。Bun 仅用于仓库开发任务和转换器维护。 -### Where do I see all available skills? +### 在哪里查看所有可用 skills? -The skill inventory is in this README, and the deeper skill catalog is in [`docs/skills/README.md`](docs/skills/README.md). Each skill's authoritative runtime spec lives in `skills//SKILL.md`. +skill 清单见本 README,更完整的 skill 目录见 [`docs/skills/README.md`](docs/skills/README.md)。每个 skill 的权威运行时规范位于 `skills//SKILL.md`。 -### Where is release history? +### 发布历史在哪里? -GitHub Releases are the canonical release-notes surface. The root [`CHANGELOG.md`](CHANGELOG.md) points to that history. +GitHub Releases 是正式的发布说明入口。根目录 [`CHANGELOG.md`](CHANGELOG.md) 指向该历史记录。 -## Contributing +## 贡献 -Contributions are welcome. Issues, bug reports, and pull requests all help make this better, and we genuinely appreciate them — bug reports especially. +欢迎贡献。Issue、缺陷报告和 Pull Request 都能让项目变得更好,我们由衷感谢 —— 尤其是缺陷报告。 -A note on what to expect: Compound Engineering is opinionated by design. It's maintained by [@kieranklaassen](https://github.com/kieranklaassen) and [@tmchow](https://github.com/tmchow), and its direction reflects a specific point of view about how AI-assisted engineering should work. So while we welcome help, we can't promise to accept every change — some proposals won't fit that vision even when they're good ideas on their own. +关于预期的一点说明:Compound Engineering 在设计上带有明确主张。它由 [@kieranklaassen](https://github.com/kieranklaassen) 和 [@tmchow](https://github.com/tmchow), 维护,其方向反映了对 AI 辅助工程应如何运作的特定观点。因此,虽然我们欢迎帮助,但无法承诺接受每一项变更 —— 有些提案即使本身是好主意,也可能不符合这一愿景。 -Open an issue or send a PR, and we'll fold in what moves the plugin in the right direction. We just want to be upfront that not everything will land. +欢迎提交 Issue 或 PR,我们会纳入能推动插件朝正确方向发展的内容。我们只是希望事先说明,并非所有内容都会被合并。 -## License +## 许可证 [MIT](LICENSE)