Codex 使用指南

搜索全站

输入关键词开始搜索。

页面更新:事实核验:

任务

任务路径总览

本指南默认你主要使用 Codex Desktop。先用桌面版把任务闭环跑通,再判断是否需要 Goal、subagent、skills 或自动化。任务页重点讲怎么做,不展开术语解释。

1 / 选择

先选工作面,再写任务

先按范围、风险和协作人数选入口。短小、低风险、单文件任务直接进入五阶段循环,不需要 Issue 或 Worktree;多文件、高风险或多人写入任务升级到 团队工程流程。

短小 / 低风险 / 单文件Desktop 直接循环固定一个写域最窄验证后签发 receipt
页面 / 视觉Desktop + in-app browser先给页面与目标状态URL、截图或页面抽样
代码 / 测试Desktop + integrated terminal保留失败日志与边界最窄测试、构建或 diff
多文件 / 高风险 / 多人写入升级团队工程流程Issue、依赖与互斥写域Worktree、PR、独立 review、CI
稳定重复任务Scheduled tasks + 隔离环境定义停止条件运行记录与异常 receipt

2 / 实践

同一任务,小步练到可验收

prompt ladder 针对同一个真实任务逐步补齐上下文、边界和验收,不要中途换成更容易的演示任务。每一步只做当前最小改动,完成后立即检查 diff 和局部行为。

1. 现象

指出当前页面、仓库或失败命令,以及实际发生了什么。

2. 合同

补齐目标、允许写域、禁区和可以接受的行为变化。

3. 最小执行

先读约束,只改最小范围;不因验证困难而换成演示任务。

4. 验收请求

明确要运行的测试、页面检查或外部状态核对,再进入证据门。

V1:只有愿望

帮我优化任务页。

缺少现象、写域和完成标准,Codex 只能猜。

V2:补上下文与边界

在 workflows.html 增加任务闭环。
只改这个页面,不改 CSS 和导航。
先读 AGENTS.md 与现有页面结构。

同一个任务变得可执行,但还不能证明完成。

V3:补验收证据

沿用上面的范围。
验收:五个阶段各有唯一锚点并按顺序出现;
项目已有的验证命令通过(例如 npm test 或 make check);桌面和 390px 页面无溢出。
失败时保留错误并进入 blocked receipt。

同一个任务现在有可复核的 done / blocked 条件。

Prompt 骨架

统一案例模板

背景:
我正在 Codex Desktop 里处理 [项目/论文/网页]。
当前页面/仓库是:[当前已打开的仓库或仓库内相对路径]。
当前问题是:[具体现象]。

目标:
请完成 [可验收结果]。

范围:
- 可以改:[文件/目录/页面]
- 不要改:[禁区/外部接口/已有用户改动]

要求:
- 先读 AGENTS.md、README 和相关源码
- 改动前说明你准备改哪里
- 需要联网、启动服务或推送前先说明理由
- 完成后运行最窄验证

验收:
- [测试/构建/页面访问/截图/commit/push]
- 最终报告列出改动、验证、风险和未完成项

反例

坏 prompt 怎么修

反例可以帮助找出缺失的边界。每次修改 prompt,都补上范围、验收、验证和停止条件。

“帮我优化项目”

改成:说明目标页面/目录、目标读者、允许改的文件、验收命令和不碰的边界。

“直接推送”

改成:先报告 diff 和验证结果,再说明推送目标和公开页面抽样方式。

“开 subagent 并行做”

改成:列出每个写域、等待点、输出合同、集成负责人和冲突处理方式。

3 / 证据

证据通过,才算 accepted

实现摘要本身不是验收证据。先按任务合同收集对应证据,再由用户、reviewer 或既定自动门判定 accepted;未 accepted 的任务不能进入 done。

代码测试测试或构建命令退出码与关键结果覆盖实际改动路径
页面证据目标 URL截图或关键页面抽样核对响应式与目标状态
PR / CIPR 链接或标识review dispositionCI checks 全部满足合同
人工验收验收人和对象明确 accepted / rejected保留条件或反馈

Accepted

合同中的必需证据齐全且结论通过,进入 receipt,记录 done。

Not accepted

证据失败、缺失或无法执行,进入 recovery;不得用“代码已写”替代验证。

4 / 恢复

先分类失败,再决定回路

验证失败先保留原命令、错误和已确认事实,再区分实现问题与外部 blocker。恢复动作必须仍服务于原任务合同。

实现失败行为、断言或 diff 与合同冲突定位最小失败切片并修复回 practice,重跑原验收
环境失败瞬时服务、端口或临时资源问题确认幂等后有限重试仍失败则 blocked receipt
缺失依赖缺包、服务、数据或磁盘资源不伪造降级结果,列解锁条件handoff 或 blocked receipt
权限拒绝缺少审批或外部写入 grant停止越权动作blocked receipt
来源不确定事实无法由可信来源支持停止发布该主张或降级为演示handoff 或 blocked receipt
产品待决验收口径冲突或需求待裁决不自行猜测产品决定回负责人或 blocked receipt

5 / 回执

用两种终态收口

receipt 是本指南推荐的任务收口实践,不是 Codex 原生 UI 功能。本指南把它分为 done 或 blocked;两者都应列出 changed scope、behavior_changed、验证证据、风险或阻塞,以及明确下一步。

Done receipt

changed scope:实际改动文件或页面;behavior_changed:用户可观察变化;验证证据:accepted 的命令、URL、截图、PR/CI 或人工结论;风险:剩余风险;下一步:发布、观察或无需动作。

Blocked receipt

changed scope:已完成与未完成边界;behavior_changed:当前是否已有行为变化;验证证据:已通过与无法执行项;阻塞:权限、依赖、来源或产品决定;下一步:责任人和解锁条件。

真实实例

真实实例:从一句反馈选择任务路径

用户在 Codex Desktop 的浏览器里说“每个内容都加一个真实的实例”。这个请求涉及多个页面,需要发布,也可能多人写入,因此从 choose 阶段升级到 团队工程流程,但仍使用同一份验收合同直到 receipt。

1. Request

给主要内容加入真实实例,让读者能照着完成任务。

2. Context to inspect

AGENTS.md、现有页面与导航、案例模式、静态检查和发布说明。

3. Allowed change

只改批准的 HTML、案例索引和必要检查;不改共享样式、公共导航或无关 dirty 文件。

4. Validation evidence

语义负向测试、全站链接/锚点检查、diff review、浏览器与公开页面抽样。

5. Final report

列 changed scope、behavior_changed、证据、PR/发布状态、剩余风险与未执行项。

6. Failure stop

来源或脱敏不足、写域扩大、验证失败、外部写入未授权,或公开页面无法确认时停止并给 blocked receipt。

路径选择:
1. choose:确认多文件范围并升级团队流程
2. practice:在同一任务上逐页小步修改
3. evidence:运行静态检查并抽样公开 URL
4. recover:失败时按实现问题或发布 blocker 分类
5. receipt:仅在证据 accepted 后记录 done,否则记录 blocked