Codex CLI — 终端里的AI编码助手
Codex CLI 是 OpenAI 推出的终端 AI 编码助手,支持自然语言交互、代码生成、审查与提交。以下速查表覆盖日常使用中最常用的命令与配置。
安装与启动 {#installation}
### 一键安装脚本
``bash
curl -fsSL https://codex.sh/install | sh
`
### 通过 npm 安装
`bash
npm install -g @openai/codex
`
### 通过 Homebrew 安装 (macOS)
`bash
brew install --cask codex
`
### 验证安装
`bash
codex --version
`
### 启动交互模式
`bash
codex
`
### 启动 Web 界面
`bash
codex app
`
### 单次提问
`bash
codex "写一个 Python 斐波那契函数"
`
### 从 GitHub Release 下载
`bash
# 访问 https://github.com/openai/codex/releases 下载对应平台二进制
`
会话管理 {#chat-sessions}
### 查看帮助
`bash
/help
`
### 清空会话
`bash
/clear
`
### 查看差异
`bash
/diff
`
### 撤销更改
`bash
/undo
`
### 退出
`bash
/exit
`
### 指定模型
`bash
codex --model o4-mini
`
代码开发 {#code-development}
### 代码审查
`bash
/review
`
### 自动修复
`bash
/fix
`
### 运行测试
`bash
/test
`
### 提交代码
`bash
/commit
`
### 生成测试
`bash
codex "为 utils.py 中的函数生成 pytest 测试"
`
### 重构代码
`bash
codex "重构 main.py,将数据库逻辑分离到单独的模块"
`
### 文档生成
`bash
codex "为 project/ 目录下的所有公共函数生成 Google 风格文档字符串"
`
配置与环境 {#configuration}
### CODEX.md 项目配置
`markdown
# .codex 配置 — 在项目根目录创建 CODEX.md
constInstructions
- 使用 TypeScript 严格模式
- 所有函数都需要 JSDoc 注释
- 优先使用 而非 let
Context
项目是一个 Next.js 14 App Router 应用,使用 Prisma ORM。 `### API Key 认证
`bash
export OPENAI_API_KEY="sk-xxxx"
codex
`### ChatGPT 登录
`bash
codex app
# 在打开的浏览器中登录 ChatGPT 账号
`### 查看版本
`bash
codex --version
`### 配置文件位置
`bash
# macOS: ~/Library/Application Support/codex/
# Linux: ~/.config/codex/
# 环境变量: CODEX_DIR
``
安装启动(9)
| 命令 | 难度 | ||
|---|---|---|---|
curl -fsSL https://codex.sh/install | sh一键安装脚本 | 基础 | curl -fsSL https://codex.sh/install | sh | |
npm install -g @openai/codex通过 npm 全局安装 | 基础 | npm install -g @openai/codex | |
brew install --cask codex通过 Homebrew 安装(macOS) | 基础 | brew install --cask codex | |
codex启动交互式会话 | 基础 | codex | |
codex app启动 Web 用户界面 | 基础 | codex app | |
codex <prompt>一次性提示,直接获取回答 | 基础 | codex "Write a Python Fibonacci function" | |
codex --version查看安装版本 | 基础 | codex --version | |
curl -L -o codex https://github.com/openai/codex/releases/latest/download/codex-<platform>从 GitHub Release 下载二进制 | 中级 | curl -L -o codex https://github.com/openai/codex/releases/latest/download/codex-linux-x64 && chmod +x codex | |
codex doctor运行诊断检查,验证环境与配置 | 基础 | codex doctor |
会话管理(5)
| 命令 | 难度 | ||
|---|---|---|---|
/help查看帮助信息 | 基础 | /help | |
/clear清空当前会话上下文 | 基础 | /clear | |
/diff查看当前变更的差异 | 中级 | /diff | |
/undo撤销最近的更改 | 中级 | /undo | |
/exit退出交互式会话 | 基础 | /exit |
代码开发(13)
| 命令 | 难度 | ||
|---|---|---|---|
/review对当前代码变更进行审查 | 中级 | /review | |
/fix自动修复代码中的问题 | 中级 | /fix | |
/test运行测试 | 中级 | /test | |
/commit生成提交信息并执行 git commit | 高级 | /commit | |
codex "为 utils.py 生成 pytest 测试"生成测试用例 | 中级 | codex "Generate pytest tests for utils.py" | |
codex "重构 main.py,分离数据库逻辑"重构代码结构 | 高级 | codex "Refactor main.py to extract database logic" | |
codex "为 project/ 生成文档字符串"自动生成代码文档 | 中级 | codex "Generate docstrings for all public functions in project/" | |
codex fork创建当前项目的分支副本用于独立开发 | 中级 | codex fork | |
codex fork-reset重置 fork 分支状态,丢弃所有本地变更 | 中级 | codex fork-reset | |
codex pr-create基于当前变更创建 Pull Request | 高级 | codex pr-create | |
codex review对当前代码变更进行 AI 审查并给出建议 | 中级 | codex review | |
codex test运行项目的测试套件 | 中级 | codex test | |
codex explain解释指定文件或代码段的功能与逻辑 | 基础 | codex explain "Explain the authentication flow in src/auth.ts" |
配置环境(5)
| 命令 | 难度 | ||
|---|---|---|---|
codex --model o4-mini指定使用特定模型 | 中级 | codex --model o4-mini | |
export OPENAI_API_KEY=sk-xxx && codex使用 API Key 认证 | 基础 | export OPENAI_API_KEY="sk-xxx" && codex | |
CODEX.md项目级配置文件(项目根目录) | 高级 | # Create CODEX.md in your project root with instructions and context | |
codex --model o3使用 o3 模型运行 | 中级 | codex --model o3 | |
codex config show查看当前 Codex CLI 配置 | 基础 | codex config show |