Codex 使用指南

搜索全站

输入关键词开始搜索。

页面更新:事实核验:

插件工作流

Compound Engineering plugin

EveryInc 的 Compound Engineering plugin 提供一组工程流程 skills。它保留 Codex Desktop 的线程、权限、diff 和验证,再把需求澄清、计划、执行、简化、审查和知识沉淀串成一套可重复的流程。

是什么

它是什么

这个仓库提供 Compound Engineering 插件:用一组 /ce-* skills 把工程任务从“随手改”变成“先澄清、再计划、再执行、再审查、再沉淀”。Codex 通用 skill 用 $skill-name mention;本页保留的 /ce-* 是该插件自己定义的 slash 命令,不应机械改写,实际命令以上游当前 README 为准。在 Codex Desktop 里,它适合多步骤功能、复杂 bug、PR 前审查和团队知识复用。

官方来源:EveryInc GitHub repo Codex Desktop:custom marketplace 安装 经验建议:先小任务验证,再交给长流程

安装

在 Codex Desktop 里安装

  1. 打开 Plugins在 Codex Desktop 侧边栏进入 Plugins。
  2. 添加 marketplace选择 Add / Add plugin marketplace。
  3. 填写来源Source 填 EveryInc/compound-engineering-plugin,Git ref 填 main,Sparse paths 留空。
  4. 安装并重启添加后选择 Compound Engineering,安装 compound-engineering,然后重启 Codex。

仓库入口:(外部链接)everyinc/compound-engineering-plugin。

设置

第一次进入项目后先跑什么

安装后,在目标仓库的新线程里先运行 /ce-setup。它会检查 repo-local 配置、可用工具和本机设置,帮助确认插件已加载,也能避免把机器配置误写进仓库。

/ce-setup

项目方向还不清楚时,用 /ce-strategy 建立或维护 STRATEGY.md。如果只是一个明确任务,不要为了流程完整而强行创建策略文件。

核心循环

核心七步怎么用

1. /ce-ideate发现并筛选值得探索的方向不要过早收敛成方案证据:候选、basis、淘汰理由
2. /ce-brainstorm把选中方向澄清为需求不要直接写代码证据:范围、用户目标、验收
3. /ce-plan把需求转成实现计划不要把风险藏进执行阶段证据:文件、步骤、验证
4. /ce-work按计划执行实现不要扩大写域证据:diff、测试、日志
5. /ce-simplify-code收紧刚写出的代码不要提前抽象证据:更小 diff、更清楚路径
6. /ce-code-review按计划审查实现不要只看样式问题证据:风险、缺测、修复项
7. /ce-compound把经验写入可复用文档不要记录一次性噪声证据:docs/solutions/ 里的结论

统一计划

Product Contract 和实施计划写在同一份文档

/ce-ideate 先筛选有依据的候选方向;选中 survivor 后,/ce-brainstorm 把用户、范围、验收、非目标和失败条件写成轻量 Product Contract。确认后,/ce-plan 在同一份计划中补充文件、依赖、U-ID、测试场景和 Definition of Done。不要另起一份 PRD,让两个事实源慢慢分叉。

Product Contract用户目标、范围、非目标、验收由用户或产品负责人确认未确认就回到 brainstorm
Implementation plan文件、依赖、U-ID、验证合同由主线程补齐并审阅 readiness不 ready 就继续规划
Issues / lanes从已确认计划派生,不另写需求按依赖和不重叠写域执行完整团队路径见 团队协作规范

选择

常见情况选哪个 skill

还不知道做什么

用 /ce-ideate,让它从代码、问题和候选方向里筛出值得进入 brainstorm 的任务。

这是 bug

用 /ce-debug,先复现和定位根因,再修复和准备审查。

在评估外部方案

用 /ce-pov,给出项目上下文里的采用、拒绝或 spike 判断。

刚做完一批代码

用 /ce-simplify-code 后再 review,避免把临时实现直接推给审查。

想全自动交付

/lfg 只适合需求已经澄清、分支/PR/验证/推送边界明确且有人值守审查的任务;一行粗需求不要直接交给它。严禁在无人值守的 Scheduled tasks 中运行 /lfg,或运行任何会自动 commit、push、打开 PR、反复修复 CI 的 skill。使用 protected branch 和最小权限,并由人 review、merge。

提示词(Prompts)

可复制输入

/ce-ideate
主题:后台任务可靠性。
目标:从代码、历史问题和外部先例中筛选值得继续探索的方向。
要求:给每个入选方向标明 basis、代价和淘汰其他候选的理由。
/ce-brainstorm
目标:让后台任务重试更安全。
背景:现在重复 webhook 偶尔创建重复记录。
边界:先只讨论需求和验收,不改代码。
/ce-plan
基于刚才的 brainstorm 输出,生成实现计划。
要求:列出要读的文件、最小修改点、验证命令和停止条件。
/ce-debug
结账 webhook 偶尔重复创建 invoice。
请先复现或定位根因;没有证据时不要猜测修复。

边界

使用边界

  • 先读项目规则让 Codex 读取 AGENTS.md、README 和相关源码,再进入 CE 流程。
  • 写清楚验收每个长流程都要有测试、构建、页面检查、PR check 或人工验收标准。
  • 外部写操作先确认提交、推送、开 PR、改 issue、改设计稿或触发部署前,先说明目标和证据。
  • 不要把流程当结果跑过一个 skill 不等于完成;最终仍要看 diff、验证和用户可检查的输出。

真实实例

真实实例:历史案例

历史案例公开仓库证据

本指南的“高 stars skills 仓库介绍”经过 requirements-only brainstorm、同一份计划的实施补全、LFG 交付、PR #1、静态验证和默认分支合并。这里引用的是公开仓库记录,不把流程名称当成完成证据。

请求

把四个第三方 skills 仓库放在一页,说明能力、使用方式、示例和边界,并配入一致插图。

先读与角色

主线程读取项目规则、四个上游 README、页面模式和检查器;实现与审阅按不重叠写域分工,Git 集成留在主线程。

边界

只发布普通读者优先、自动化读者其次的一页;第三方扩展不能冒充 OpenAI 官方能力,内部过程文档不提交。

验证证据

make check、图片和锚点检查、diff review;提交 44643ae 经 PR #1 合并为 55d11e7。

重要恢复与结果

发布前收紧 staging,排除忽略的过程记录;PR 合并到该仓库实际默认分支 master,随后抽样公开页面。

失败停止

上游事实无法确认、图片缺失、链接或检查失败、脱敏边界变化,或没有明确 push/PR 授权时停止。