Codex 使用指南

搜索全站

输入关键词开始搜索。

页面更新:事实核验:

团队工程

团队协作规范

以 Codex Desktop 主线程为协作中枢:产品负责人批准合同,编排者维护统一计划,subagent 在隔离写域执行,独立 reviewer 只按验收合同审查。复杂任务走完整闭环;短小、低风险、单写域任务可以直接执行最窄验证,不必机械套用全流程。

团队流程

从 Idea 到 task receipt

先把产品问题变成合同,再把同一份合同逐层细化。下述 ce-brainstorm、ce-plan 等 CE 流程需要先安装 Compound Engineering;未安装时可沿用相同步骤,但不能假定命令可用。需要任务入口、长目标、Worktree 隔离、代理分工或指令层级时,分别参考 任务路径、Goal、Worktrees、Subagents 与 AGENTS.md。

flowchart TD A["Idea"] --> B["Matt-style grill"] B --> C["ce-brainstorm Product Contract"] C --> D["ce-plan 统一实施计划"] D --> E["Issues 与依赖图"] E --> F["Worktrees / subagents"] F --> G["PR + 独立 review + CI"] G --> H["经授权合并主分支"] H --> I["主分支 / 公开页面验证"] I --> J["task receipt"] C -->|驳回| B D -->|not ready| D E -->|依赖或写域重叠| E G -->|验证失败 / changes / CI red| F H -->|未授权| K["blocked receipt"] I -->|失败| K
团队协作主流程及失败回路。图形不可用时,紧邻下方的文字版提供完全等价的顺序与门禁。
1. Idea → grill先读证据并做 Matt-style grill开放问题不能带入实现Product Contract 驳回就回到 grill
2. Contract → plance-brainstorm 固化 Product Contractce-plan 细化同一份统一实施计划plan 不 ready 就留在 plan
3. Issues → lanes建立依赖图和互斥写域Worktree / subagent 只接明确 lane依赖或写域重叠就回 issue slicing
4. PR → review提交 PR、独立 review、运行 CIreviewer 记录合同、diff、disposition验证失败、changes 或 CI red 回 implementation
5. Merge → receipt获得授权后合并主分支更新基线并验证主分支/公开页面未授权或最终验证失败,输出 blocked receipt

角色与权限

用户、编排线程与执行线程

A2/A3/A4 是本指南的教学框架,不是 Codex 原生角色名。主要角色分别是用户、编排线程和执行线程;编排线程负责整合但不能替代用户的产品批准,执行线程提供实现或独立证据且不能越过写域自行发布。

用户(A2)

拥有产品意图、Product Contract、范围变化和最终合并授权;验收 receipt,并决定 blocked 项如何处理。

编排线程(A3)

维护唯一合同与统一计划,切 issue、分配写域、集成结果、处理 review disposition,并向用户报告可审计证据。

执行线程 / 独立 reviewer(A4)

在被分配的只读或隔离写域内工作。reviewer 必须未参与实现,且不共享被审 lane 的写域。

动作A2 用户 / 产品负责人A3 主线程 / 编排者A4 subagent / reviewer
Product Contract 批准批准、驳回或收窄基于 grill 起草并维护版本只提供证据与风险
计划 readiness确认产品验收口径补齐依赖、写域和验证后判定独立检查缺口,不自行放行
Issue定优先级与产品边界创建、切片、维护依赖图只执行被分配 issue
Worktree / branch批准超出既定合同的隔离需求按 lane 创建、登记、回收不得自行创建或切换
扩范围批准新版合同停止当前 lane 并申请变更停止并上报,不擅自扩写域
commit / push对外 push 需明确 grant可按合同 commit;push 仅在 grant 内禁止 commit/push,只返回文件与验证证据
PR授予目标仓库与 base 范围在有效 grant 内创建/更新不创建或更新 PR
review resolution裁决产品分歧逐项记录接受、修复或有据拒绝独立 reviewer 只给 disposition 建议
merge逐次明确授权仅在授权、review、CI 都满足时执行禁止合并
receipt验收或要求补证签发 done / blocked receipt提交本 lane 的证据与未验证项

外部写入 grant

grant 是提示词层面的授权约定,不能扩大 Desktop 的沙箱、审批、账号或组织权限。push、PR、评论、发布、merge 等外部写入还必须处于实际权限边界内,并写清 scope、目标 base、允许动作和到期条件;默认不会跨任务继承。

自动失效

scope、base、review 结论或 redaction 要求发生变化,原 grant 立即失效。A3 必须停下,重新展示影响并向 A2 申请授权。

Issue 分工

按依赖和写域组织并行

并行前先确认依赖允许并行、写域互不重叠,且集成点可以验证。多开线程本身不等于并行。

Contract lane 串行

schema、公开接口、共同数据模型等 contract 变更先完成并合并;所有下游都依赖这一基线。

独立 lanes 并行

在 contract 稳定后,互不重叠的 docs、frontend、test 可以进入不同 Worktree / subagent 并行执行。

更新基线

上游合并后,下游先更新 base,核对 diff 是否仍属于原 scope,再重跑本 lane 验证。

集成门

只有依赖满足、写域无重叠、验证和 review 通过的 lane 才能进入 PR 合并候选。

可并行示例

contract 先串行;其合并后,docs、frontend、test 各自拥有不重叠文件集合,可同时推进。

失败停止

测试失败回 implementation;写域重叠或依赖不清回 issue slicing;依赖暂不可满足则回退该 lane,或输出带 blocker、已验事实和解锁条件的 blocked receipt。

独立审查

独立 reviewer 合同

独立 reviewer 必须没有实现该 lane,也不共享该 lane 的写域。其任务是验证约定,不是接管实现;即使换成独立线程,使用相同模型仍可能共享盲点,因此关键安全、数据、权限和发布变更必须由人类审查。

Acceptance contract记录要满足的行为、边界和验证固定 review 使用的 base / head合同变化即重新审查
Diff检查实际 diff 和生成产物核对无越界文件、无隐藏副作用不只依赖实现者摘要
Dispositionapprove / changes requested / blocked每项 finding 有证据和严重度A3 逐项记录 resolution

真实实例

真实实例:历史复合案例

历史复合案例中等脱敏

以下案例由多个可核验片段组成,用来说明完整协作合同;它不声称来自一次连续执行。内容保留工程证据类别,但不包含私人姓名、机器路径、主机或业务代码。

请求

在 Codex Desktop 中把团队工程规范做成可公开验证的指南页;保持导航和视觉模式,保护既有修改,只改批准的页面,并在授权后才发布。

先读

按层级读取全局、仓库根目录、目标目录的 AGENTS.md,再读 README、目标 HTML、共享样式、验证脚本与生成上下文;最近规则优先,生成上下文只作索引并检查漂移。

角色

A2 批准 Product Contract 与 merge;A3 维护统一计划和依赖图;A4 分别承担隔离实现、只读验证和独立 review。

边界 / 文件

写域仅含目标指南页。共享 CSS、脚本、导航结构、生成上下文和敏感路径均为只读;证书、环境文件与本地凭据不读取、不回显。

脏主保护

预检发现主工作区已有未提交修改,因此不清理、不覆盖、不借用该写域;实现转入登记过的隔离 Worktree,并保留原工作区状态证据。

完成 Goal

完整 Goal

Objective:
建立中文优先、Codex Desktop 优先的团队协作规范主页面,并可在主分支公开验证。

Scope:
- Include: 目标指南页内容、现有组件内的流程图与表格
- Exclude: 公共导航结构、共享 CSS/JS、生成上下文、敏感路径、既有脏修改

Acceptance:
- 团队流程、A2/A3/A4 权限、issue lanes、独立 review、历史复合案例齐全
- 所有失败门与授权边界可见,短小低风险任务有轻量路径

Validation:
- 静态站点检查通过
- diff 仅含目标页
- Mermaid 有邻接文字等价版;无 Mermaid 时仍可读
- PR review 与 CI 通过;合并后复验主分支和公开页面

Artifacts:
- 目标页面、PR、独立 review 记录、CI 结果、done 或 blocked task receipt

Stop Conditions:
- Product Contract 未批准、计划不 ready、写域重叠、敏感路径风险
- 验证失败、review changes、CI red、merge 未授权或主分支验证失败

分工

contract lane 先串行;合并后 docs、frontend、test 按不重叠写域并行。每个下游更新 base 后重跑验证,A3 只整合已满足依赖的结果。

验证证据

记录目标锚点、静态检查输出、仅目标页的 diff、无脚本渲染时的文字可读性、独立 reviewer disposition、PR checks 与合并后页面抽样。

独立 review

reviewer 未参与实现且无该 lane 写权限;固定 acceptance contract 与 diff,逐项给出 approve、changes requested 或 blocked,并记录 resolution。

重要恢复

历史片段证明主工作区既有修改必须保留。教学组合中的恢复规则是:若下游 base 过期,就停下更新基线、复核 scope 并重跑验证;仍失败则回 implementation,不把这一条件分支冒充已发生事件。

结果 / receipt

公开记录支持 PR、验证与默认分支合并已完成。教学组合另明确授权规则:push/创建 PR 的 grant 不覆盖 merge;只有在 review 与 CI 通过后展示最终证据并取得独立 merge 授权,才可合并和签发 receipt。

失败停止

任何合同驳回、计划缺口、依赖阻塞、越界写入、敏感信息风险、review changes、CI red、未授权 merge 或最终验证失败都停止;无法立即恢复时给 blocked receipt。

来源分类

可核验仓库片段:指令层级、生成上下文、dirty 检出、diff 与测试日志。可核验协作片段:issue 依赖、Worktree 登记、review disposition、PR/CI/merge 状态。教学性组合:为说明端到端合同而重排这些片段;不表示它们发生在同一任务或同一时间线上。

真实实例

真实实例:修复 API 429 限流

演示场景

工程团队常见任务:公开 REST API 在 burst 流量下返回 429。Codex 先澄清验收标准,再只改 rate limit 中间件和对应测试。

起始状态

集成测试 test_rate_limit_burst 失败;生产日志显示 429 过早触发;主分支已有无关 dirty 文件需排除在写域外。

Prompt

Objective: 修复 burst 场景 429,保持正常用户不受影响。
Scope: middleware/rate_limit.py 与 tests/integration/test_rate_limit_burst.py
Validation: pytest tests/integration/test_rate_limit_burst.py
Stop: 若需改数据库 schema 或公共 contract,先输出 blocked receipt。

审批边界

允许改 middleware 和测试;禁止改 billing、auth 或部署配置,除非用户追加 grant。

可观察结果

目标测试 pass;p95 延迟无显著回归;PR diff 仅含限流模块。

失败恢复

若 baseline 测试环境缺 Redis,停止并报告环境 blocker,不伪造通过结果。

验证证据

pytest 输出、diff stat、reviewer 对 contract 未变的确认;本项目没有该 API 仓库的执行记录,因此标为演示场景。