Codex CLI 入门教程:安装、配置与常用命令
Codex CLI 让你在终端里直接调用 Codex 处理项目任务。这篇教程带你从安装到跑通第一个任务。
- 一台装有 Node.js(建议 LTS 版本)的电脑
- 一个可用的账号与 API 凭证
- 基本的命令行使用经验
-
确认 Node 环境可用:
Terminal window node -v -
通过 npm 全局安装 CLI(具体包名以官方说明为准):
Terminal window npm install -g @openai/codex -
验证安装:
Terminal window codex --version
首次使用需要完成认证。一般通过环境变量提供密钥:
export OPENAI_API_KEY="你的密钥"跑通第一个任务
Section titled “跑通第一个任务”进入一个项目目录,用自然语言描述你的需求:
cd my-projectcodex "给 utils/date.js 里的 formatDate 函数补充单元测试"CLI 会读取相关文件、给出改动方案并在你授权后执行。建议配合 Git 使用,方便随时回滚:
git add -A && git commit -m "chore: 保存进度,准备让 Codex 修改"常用操作速查
Section titled “常用操作速查”- 查看帮助:
codex --help - 指定模型 / 参数:参考
--help中的对应选项 - 在交互模式中分步推进任务,逐步确认改动
- 让它先解释再动手:在描述里加上“先说明方案,我确认后再改”
高效使用建议
Section titled “高效使用建议”- 小步迭代:一次只让它做一件清晰的事,验证后再继续。
- 用版本控制兜底:每个改动前提交一次,出问题可快速恢复。
- 写清约束:说明技术栈、风格、不能改动的部分,参考 Prompt 写法指南。
- 审阅产出:把它的改动当作待 Review 的代码。
常见问题(FAQ)
Section titled “常见问题(FAQ)”安装后命令找不到怎么办?
Section titled “安装后命令找不到怎么办?”通常是全局 bin 目录不在 PATH 中。检查 npm 全局路径,并确认已加入环境变量。
提示认证失败?
Section titled “提示认证失败?”确认密钥正确、未过期,且环境变量在当前 shell 中已生效(可用 echo $OPENAI_API_KEY 验证)。
它会不会误删我的代码?
Section titled “它会不会误删我的代码?”在授权范围内操作,但仍建议全程使用 Git。养成“先提交再让 AI 改”的习惯最稳妥。