Codex 使用指南

搜索全站

输入关键词开始搜索。

页面更新:事实核验:

任务手册

日常任务 workflow

日常任务不能只用一句“做一下”带过。在 Codex Desktop 里,Codex 会读仓库、改文件、跑命令,也可能误解边界。比较稳妥的做法是:开一个清晰线程,补充上下文,限定范围,审批必要操作,最后检查验证证据。

核心循环

日常任务的最小可靠闭环

这套流程适用于解释错误、修失败测试、更新文档、调整页面、检查 PR 和清理小 bug。不要一上来就让 Codex “全部优化一下”。

说明任务

写清当前现象、目标结果、相关路径和不想碰的范围。最好附上失败日志、截图、URL 或测试名。

让 Codex 读上下文

要求先读 AGENTS.md、README、相关源码、测试和日志。没有读上下文之前,不要让它直接大改。

小范围执行

一次只解决一个可验证问题。改文件前应知道预计会改哪些文件,避免顺手重构和无关格式化。

验证和收口

让 Codex 跑最窄测试或构建,解释结果;如果不能跑,要说明原因和剩余风险。

flowchart LR A["说清任务"] --> B["读上下文"] B --> C["限定改动范围"] C --> D["执行最小 diff"] D --> E["运行最窄验证"] E --> F["报告证据和风险"]
这张图对应日常任务闭环:任务输入、上下文读取、范围控制、执行、验证、收口。

Desktop 日常流程

在桌面版里实际怎么操作

Desktop 方便的地方在于,你可以把页面反馈、文件修改、终端验证和权限审批放进同一个可追踪的任务线程。

把问题贴进线程

包括当前 URL、截图描述、失败命令、目标读者、相关路径。不要只说“这里不对”。

要求先读规则

让 Codex 先读 AGENTS.md 和目标文件,再说明准备改哪些地方。

逐个批准动作

启动本地服务、联网查询、安装依赖、git push 都应先说明原因和影响范围。

用浏览器反馈迭代

如果页面仍不对,把 in-app browser 当前 URL 和问题区域发回线程,让 Codex 针对同一个 diff 继续修。

最后看证据

要求最终回答包含命令、页面抽样、commit、公开链接和未验证风险;没有证据就继续追问。

常见任务

五类高频日常任务

新手可以从这些模板开始;进阶用户可以把稳定的部分沉淀进 AGENTS.md 或 skill。

读代码并解释

适合刚接手仓库、看不懂模块边界、需要快速建立 mental model。要求 Codex 引用真实文件和函数,不要泛泛解释。

请只读分析这个仓库的登录流程。
先读 AGENTS.md、README 和 auth 相关源码。
输出:入口文件、核心函数、数据流、风险点。
不要改文件。

修失败测试

适合已经有明确红灯的场景。给出测试命令和失败片段,让 Codex 先定位根因,再做最小修复。

请修复这个失败测试。
失败命令:npm test -- checkout
范围:只改 checkout 相关代码和测试。
要求:先解释根因,再改最小 diff。

修改网页或文档

适合样式、内容、导航、README、指南页。要说明目标读者和验收方式,尤其是需要浏览器验证时。

我在 Codex Desktop 浏览器里看到 daily-workflow 页面内容太少。
请更新 daily-workflow 页面。
目标读者:第一次使用 Codex 的中文用户。
验收:页面有完整流程、示例、检查清单。
完成后本地静态服务抽样访问。

审查当前 diff

让 Codex 站在 reviewer 视角查 bug、遗漏测试、破坏兼容和文档缺口。只读 review 时要明确“不改文件”。

请 review 当前 git diff。
重点:行为回归、缺失测试、权限/安全风险。
输出:按严重程度排序的 findings。
不要改文件。

提交和发布

适合你已经确认改动方向,想让 Codex 负责测试、commit、push、Pages 或 PR 状态确认。一定要要求最终链接和验证证据。

请提交并推送这次网页修改。
提交前:git diff --check,抽样访问关键页面。
提交信息:Improve daily workflow guide
推送后:确认 GitHub Pages built。

Prompt 质量

坏请求和好请求的差别

Codex 做得好不好,很大程度取决于任务边界。坏请求通常省略上下文、范围、验收和风险;好请求会让 Codex 先读、判断,再小步执行。

不要这样写

帮我优化一下这个项目。

这个页面太丑了,改好看点。

测试挂了,修一下。

你自己看着办。

这些请求的问题是目标不可验收,范围过大,容易导致 Codex 猜需求、乱改文件或给出空泛总结。

推荐这样写

请修复 checkout 流程里的失败测试。

背景:
- 当前分支新增了优惠券逻辑
- 失败命令是 npm test -- checkout

范围:
- 可以改 checkout、coupon、对应测试
- 不要改 payment provider 接口

要求:
- 先读 AGENTS.md 和失败日志
- 改动前给 3 行短计划
- 完成后运行最窄测试

验收:
- 测试通过
- 最终说明改了什么、验证了什么、剩余风险

证据

验收不是“看起来完成了”

日常任务收尾时,最终回答应该让你判断结果是否真的可用。没有证据的“已完成”不算完成。

改动证据

列出关键文件、关键行为变化、没有改哪些范围。不要只说“优化了代码”。

验证证据

列出测试、构建、静态服务、页面访问、截图或线上状态。

风险证据

说明没跑的测试、依赖的外部状态、可能的兼容影响。

交付证据

给出 commit、PR、Pages URL、issue 链接或产物路径。

推荐 closeout 模板

这是本指南推荐实践,不是 Codex 原生 UI。字段与任务页的 receipt 保持一致:

changed scope:实际改动的文件、模块或页面
behavior_changed:用户可观察的行为变化;没有则写 false
validation evidence:测试、构建、URL、截图或人工检查结论
risk-or-blocker:剩余风险、未运行检查或当前阻塞
next step:发布、人工确认、继续修复或无需动作

失败模式

常见失败和补救

如果 Codex 偏离了方向,别继续追加模糊要求。指出偏差,重新限定范围。

改动太散

让 Codex 停下,列出当前 diff,解释每个文件为什么必要。无关改动应撤回或拆到后续任务。

没有读上下文

要求它回到 AGENTS.md、README、相关代码和测试。不要让它基于猜测继续写。

验证跑不通

区分代码失败、环境失败、依赖缺失和权限限制。最终报告里必须保留这个区别。

网页看起来不对

要求本地服务或公开 URL 抽样访问;如果有浏览器工具,再用截图检查排版和文本溢出。

解释太空泛

要求它引用文件路径、函数名、命令输出或页面 URL。没有引用就不能作为依据。

任务变长了

如果超过一个短回合、需要多个阶段或要发布,转入 Goal;如果能拆并行调查,再看 Subagents。

真实实例

真实实例:修复 checkout 失败测试

演示场景

这是一个可迁移到任意 Node/Express 商店的日常修复任务:测试 checkout 在空购物车时报错,Codex 先读失败日志,再只改结算模块。

输入

仓库 example-store,失败命令 npm test -- checkout,现象是空购物车仍尝试扣款。

Prompt

先读 AGENTS.md 和失败日志。
只改 src/checkout/ 下文件。
改动前说明根因。
完成后运行 npm test -- checkout 并报告 diff。

审批边界

允许读文件和跑测试;安装新依赖或改支付网关配置需先说明并等待批准。

可观察结果

测试由 fail 变 pass;diff 仅含 checkout 模块;报告列出改动文件和命令输出。

失败恢复

若根因指向 API 契约而非前端逻辑,停止改码,输出 blocked receipt 并建议补集成测试或 mock。

验证证据

终端测试输出、git diff --stat、相关函数路径引用;本项目没有该商店仓库的执行记录,因此标为演示场景。

真实实例

真实实例:把短页面扩成日常任务手册

这次 daily-workflow.html 原本只有几十个词。用户在 Desktop 浏览器里指出“内容太少”,Codex 按日常任务闭环完成了读上下文、改页面、验证和发布。

输入

坏输入是“内容太少”;修复后应写清当前页面、目标读者、要补的任务类型和验收方式。

先读

AGENTS.md、当前 HTML、README、相关官方资料和本机 skill 边界。

应动文件

日常任务页和必要导航;不顺手改无关样式或其它场景页。

验证

make check、git diff --check、关键标题抽样。

最终回答

列出改了哪些任务、跑了哪些检查、哪些风险还需要人工判断。

失败停止

页面结构不清、AGENTS 冲突、验证失败且没有窄修复时停止。