如果已经准备使用 Codex 做真实代码项目,CLI 是比较直接的一种方式。
它和普通聊天最大的区别在于:Codex CLI 可以直接进入本地代码仓库,读取项目文件、分析代码关系,并根据任务继续修改和运行命令。
OpenAI 目前仍提供 Codex CLI,官方安装命令为:
npm i -g @openai/codex
安装后就可以在终端中启动 Codex。
下面按照第一次使用的顺序操作。
一、先检查Node.js环境
安装 Codex CLI 之前,可以先打开终端执行:
node -v
然后:
npm -v
如果两条命令都能正常显示版本号,说明 Node.js 和 npm 基本已经配置完成。
如果提示:
command not found
建议先处理 Node.js 环境,再安装 Codex。
二、安装Codex CLI
执行:
npm i -g @openai/codex
安装完成后,可以测试:
codex --version
如果能够显示版本信息,说明 CLI 已经可以正常调用。
OpenAI 目前也将 Codex CLI 与编辑器中的 Codex 作为主要代码工作入口之一。
三、不要直接在随便一个目录启动
第一次使用很容易犯一个错误:
打开终端以后直接输入:
codex
虽然 Codex 可以启动,但它所在的目录可能不是你的项目。
更推荐先进入代码仓库。
例如:
cd my-project
然后检查目录:
ls
Windows 也可以:
dir
正常情况下应该看到类似:
package.json
src
README.md
.git
确认位置正确以后,再运行:
codex
这样 Codex 分析的就是当前项目。
四、第一次先让Codex"只读不改"
进入项目后,不建议第一句话就写:
帮我优化整个项目
第一次最好先测试项目读取能力。
可以直接输入:
请先不要修改任何文件。
分析当前代码仓库,并告诉我:
1. 项目使用什么技术栈;
2. 入口文件在哪里;
3. src 下主要目录的作用;
4. 使用什么包管理器;
5. 当前有哪些测试命令。
如果 Codex 能够准确识别当前项目,就说明:
终端目录正确
+
Codex可以读取仓库
+
项目上下文已经建立
这一步非常适合作为首次连接测试。
五、第二步再让Codex定位一个小问题
确认读取正常后,可以继续:
检查当前项目中的 TypeScript 错误。
先列出错误文件和原因,
不要修改代码。
或者:
找出当前项目中所有调用 /api/user 的文件,
整理调用关系,
暂时不要改动。
这种任务可以测试 Codex 是否能够:
搜索文件
↓
跨文件分析
↓
理解调用关系
而不是只看当前打开的某一个文件。
六、确认分析正确后再修改
如果前面的分析没有问题,再给出明确修改范围。
例如:
现在只修复刚才找到的第一个 TypeScript 错误。
不要修改其他模块,
完成后告诉我修改了哪个文件。
建议尽量避免过于宽泛的指令。
比如:
全面优化代码
这种要求很难定义边界。
更好的方式是:
只修改 src/auth
只解决登录错误
不调整数据库结构
不改变现有接口格式
范围越清楚,结果越容易检查。
七、修改完成后检查Git Diff
如果项目使用 Git,可以让 Codex 修改完成以后查看变化。
自己也可以执行:
git status
再查看:
git diff
重点确认:
修改了哪些文件
有没有意外删除
有没有改动无关代码
配置文件是否被修改
Codex 可以参与代码修改,但最终合并之前仍然应该检查实际 Diff。
八、再运行项目原有测试
例如项目使用:
npm test
或者:
npm run build
可以让 Codex继续:
运行项目现有测试。
如果出现失败,
先分析原因,
不要通过删除测试来让它通过。
一个比较推荐的 Codex CLI 使用流程就是:
先分析
↓
确认范围
↓
修改代码
↓
运行测试
↓
检查Diff
比直接一次性让它完成大规模重构更加稳妥。
九、第一次使用最容易遇到的几个问题
Codex命令不存在
先检查:
codex --version
如果仍然找不到,通常需要检查 npm 全局安装路径或 Node.js 环境。
Codex分析错项目
先执行:
pwd
或查看当前目录,确认是否进入正确仓库。
一次修改文件太多
把指令改成:
先分析,不修改
然后缩小到具体目录或具体问题。
修改完成但不知道改了什么
使用:
git diff
统一查看实际代码变化。
十、可以准备一份项目规则
长期使用 Codex 时,可以在项目中准备明确的开发规则,例如:
# Project Rules
- 项目使用 TypeScript
- 修改后运行测试
- 不随意修改数据库结构
- 不删除已有接口兼容逻辑
- 大范围修改前先说明计划
- 不确定的代码先分析,不直接删除
这样以后处理任务时,不需要每次重新强调相同要求。
总结
第一次使用 Codex CLI,不需要一开始就研究很多高级功能。
先完成下面这条流程就足够:
安装CLI
↓
进入项目目录
↓
启动Codex
↓
只分析项目
↓
定位一个小问题
↓
修改
↓
测试
↓
检查Git Diff
官方目前仍支持通过终端和编辑器使用 Codex,并提供 npm i -g @openai/codex 作为 CLI 安装方式。
对于第一次接触 Codex 的开发者来说,最重要的并不是让它一次修改多少代码,而是先建立一个可检查的工作流程:
先读懂,再修改;修改以后,再测试。