实战教程
Codex CLI 实战教程:从需求到落地的完整工作流
一篇完整的 Codex CLI 实战教程:需求拆解、方案生成、改动执行、质量验证与提交说明,适合个人与团队复用。
这篇教程不是“演示命令”,而是给你一套可以在真实项目里反复使用的流程。
目标:用 Codex CLI 完成一次标准开发闭环。
闭环包括:
- 理清需求与边界
- 生成可执行方案
- 输出可落地改动
- 做结果验证与提交说明
开始前先看(接入与成本)
为了减少返工,建议先确认接入链路和预算边界:
适用场景
- 接手旧代码,需要快速理解结构
- 有明确需求,需要安全改动
- 团队希望把 AI 辅助流程标准化
开始前准备
请先确保:
codex --version可执行- 当前仓库能正常运行和测试
- 你已明确本次改动边界(模块/文件范围)
第一步:需求拆解(先定边界)
先让模型给你“可执行计划”,而不是直接输出代码。
codex run "analyze this requirement and output a 5-step implementation plan with risks"
你要检查这份输出是否包含:
- 目标与非目标
- 影响模块与文件
- 风险点与回滚点
- 验证标准
如果这一步不清晰,后面大概率返工。
第二步:项目理解(补全上下文)
codex run "summarize this repository in Chinese and list critical dependencies"
你要拿到:
- 模块关系图(至少文本结构)
- 关键依赖与调用链
- 改动可能波及的边界
实践建议:让它把“不会动的文件”也列出来,避免误改。
第三步:生成改动方案(先小后大)
codex run "propose a minimal safe refactor plan for module X with rollback notes"
高质量方案应包含:
- 最小可行改动路径
- 每步对应的验证方式
- 失败时的回滚方案
原则:先小范围跑通,再扩大改动。
第四步:输出可执行命令与变更
codex run "output exact shell commands and file edits only"
建议你要求模型固定输出结构:
- Step N:执行命令
- 预期输出
- 验证命令
- 回滚命令
这样你在终端里可以按步骤执行,不会丢上下文。
第五步:质量验证(必须做)
最少做三层验证:
- 功能验证:核心功能是否符合需求
- 回归验证:旧功能是否被影响
- 代码验证:格式、测试、静态检查是否通过
可让模型先给出验证清单:
codex run "generate a verification checklist for this change"
第六步:生成提交说明与复盘
codex run "write conventional commit message + changelog + risk summary"
你最终应该得到:
- 可直接用于提交的 commit message
- 本次改动摘要
- 风险说明和后续优化建议
一套可复用的提示词模板
模板 A:计划优先
你是资深工程师。请先输出分步计划,不要直接写代码。每步包含:目标、影响文件、风险、验证、回滚。
模板 B:执行优先
请只输出可执行命令和文件改动,按 Step 1/2/3 编号,不要输出泛化解释。
模板 C:验证优先
请根据本次改动生成验证清单,分为功能、回归、性能三个部分。
实战中最常见的失败点
- 一次提问目标过多,导致输出失焦
- 未限制文件范围,改动超出预期
- 没有要求回滚步骤,出错后无法快速恢复
- 跳过验证直接提交
落地建议(团队)
- 把高质量提示词沉淀到团队文档。
- 固定“计划→执行→验证→提交”四段流程。
- 每次复盘保留可复用模板,持续优化。