文档中心
Codex CLI 常用命令详解(含示例)
整理 Codex CLI 最常用命令与典型使用场景,附可直接复制的示例。
这篇文档只讲“高频命令 + 实际用途”,避免冗余信息。
说明:不同版本命令细节可能有差异,执行前建议先跑 codex --help 进行确认。
0. 接入与成本优先阅读
如果你准备在真实项目里高频使用命令,建议先看这三篇:
1. 环境确认命令
codex --version
codex --help
用途:确认 CLI 已安装、命令可执行,并查看当前版本支持的参数。
2. 项目理解命令
codex run "summarize this repository in Chinese"
用途:快速得到仓库结构、核心模块和风险点概览,适合接手新项目时使用。
3. 方案规划命令
codex run "propose a minimal safe refactor plan for module X"
用途:在改代码前先拿到计划,明确改动边界和回滚点。
4. 可执行输出命令
codex run "output exact shell commands and file edits"
用途:要求模型输出可执行步骤,而不是泛泛建议。
5. 历史会话恢复命令
codex resume
用途:恢复之前的对话上下文,继续未完成任务。
6. 推荐命令组合(实战)
按下面顺序执行,通常能稳定完成一个小需求:
codex run "summarize this repository in Chinese"codex run "propose a minimal safe refactor plan for module X"codex run "output exact shell commands and file edits"codex run "write a conventional commit message and changelog summary"
7. 常见误区
- 一次命令塞太多目标,输出会发散。
- 没有限制改动范围,容易超出预期。
- 不要求回滚与验证步骤,落地风险高。
建议:每次只处理一个需求,并要求明确输出格式。