工作流示例
以下是 Codex 在 IDE 插件、CLI 和云端三种接入方式下的典型开发场景,每个场景包含适用时机、操作步骤、示例提示词和验证方式。
1. 理解代码库
适用场景:新人入职、接手遗留服务、理解通信协议
IDE 方式
打开相关文件,选中代码,然后询问:
解释这段代码的请求处理流程:
- 每个模块的职责是什么?
- 数据在哪里被验证?
- 可能的潜在陷阱有哪些?
CLI 方式
使用 @ 路径补全附加文件:
@src/api/handler.ts @src/types/request.ts
详细解释这个 API 的 schema、请求/响应流以及向后兼容性注意点
2. 修复 Bug
适用场景:复现并解决失败行为
CLI 紧凑循环
提供完整上下文,让 Codex 本地复现并修复:
复现步骤:在结账页面点击"提交订单",控制台报 TypeError: Cannot read property 'price' of undefined
相关文件:src/checkout/OrderSummary.tsx, src/store/cartSlice.ts
约束:只修改最必要的代码,不重构
请:本地复现 → 定位根因 → 提出补丁 → 运行 npm test 验证
IDE 方式
打开疑似文件及其调用方,然后:
定位这个 Bug 并解释如何在 UI 中验证修复效果
3. 编写测试
适用场景:为特定函数添加测试覆盖
IDE 选区方式
选中目标函数的代码行,使用"Add to Codex Thread",然后:
为选中的函数编写单元测试,遵循项目现有的测试约定,
覆盖:正常路径 + 边界情况 + 错误处理
CLI 方式
为 src/utils/formatCurrency.ts 中的 formatCurrency 函数编写测试:
- 正常输入(整数、小数、大数)
- 边界情况(0、负数、NaN)
- 格式约定与现有测试文件一致
4. 从截图构建原型
适用场景:从设计稿快速生成可运行原型
CLI 图像输入方式
codex -i mockup.png "基于这个截图实现 UI:
- 使用 React + Tailwind CSS
- 添加必要的路由
- 包含 README 说明如何运行"
IDE 拖放方式
拖放截图到 Codex 面板:
按这个设计实现 UI,匹配项目现有的组件样式和路由约定
5. 迭代 UI 实时预览
适用场景:快速的设计→代码反馈循环
步骤:
- 在独立终端启动开发服务器:
npm run dev - 向 Codex 发出小范围、聚焦的样式修改请求
- 在浏览器中实时查看效果
- 满意后提交,不满意则撤销
提示
每次修改后告知 Codex 你做了哪些手动修改,避免被覆盖。
6. 委托重构到云端
适用场景:并行运行的长时间重构任务
本地规划阶段
使用 $plan skill 生成重构计划:
- 解决循环依赖问题
- 按功能分离职责
- 提升可测试性
先给计划,我确认后再实施
云端执行阶段
切换到云端环境,按里程碑顺序实现,每步骤审查 Diff 后再进行下一步,最终创建 PR。
7. 代码审查
CLI 方式
/review
可选择添加聚焦说明:
/review 重点关注边界情况处理和安全漏洞
GitHub 集成
在 PR 中评论:
@codex review
或定制审查重点:
@codex review 检查是否有安全回归问题
8. 更新文档
IDE/CLI 方式
打开或提及文档文件:
更新 docs/api.md,反映最新的 /users 端点变更:
- 更新请求/响应示例
- 验证所有内部链接仍然有效
- 保持与现有文档风格一致
上下文管理提示
| 接入方式 | 添加上下文的方法 |
|---|---|
| IDE 插件 | 自动包含打开的文件和选中内容 |
| CLI | 使用 @ 路径补全或 /mention 命令 |
| 云端 | 可沿用本地规划阶段的线程上下文 |
| 图像 | 两种接口均支持拖放(IDE 需按住 Shift) |