Codex CLI 配置教程
Codex CLI 是一个强大的 AI 代码助手命令行工具,可以在终端中直接与 AI 对话,帮你写代码、调试问题、解释代码等。
简单说:在终端里和 AI 结对编程。
什么是 Codex CLI?
| 特性 | 说明 |
|---|---|
| 命令行交互 | 直接在终端中与 AI 对话 |
| 代码生成 | 根据需求生成代码片段 |
| 代码解释 | 解释复杂代码的逻辑 |
| 调试辅助 | 帮助定位和修复 bug |
| 多模型支持 | 支持 GPT、Claude 等多种模型 |
支持的模型
通过 LuckyAPI 中转,Codex CLI 可以使用多种前沿模型:
| 模型 | 说明 | 推荐场景 |
|---|---|---|
| gpt-5.4 | OpenAI 最新模型,推理能力强 | 主力模型(推荐) |
| gpt-5.3-codex-xhigh | 代码专精模型 | 编程任务 |
| claude-opus-4-6 | Claude 最强模型 | 复杂推理 |
| claude-sonnet-4-6 | 性价比之选 | 日常对话 |
系统要求
- Node.js: 16.0+
- npm: 7.0+
一键配置(推荐)
复制以下命令到终端运行,自动完成配置:
bash
curl -fsSL https://claude-zh.cn/scripts/codex-config.sh | bashpowershell
irm https://claude-zh.cn/scripts/codex-config.ps1 | iex脚本功能
一键配置脚本会自动:
- 检测 Node.js 安装状态
- 自动安装 Codex CLI(如未安装)
- 创建配置目录
~/.codex - 引导输入 LuckyAPI Key
- 生成
auth.json和config.toml配置文件 - 设置文件权限保护 API Key
注意
- 需要先安装 Node.js 16.0+
- 脚本会提示输入 LuckyAPI Key,请在 LuckyAPI 获取
- 默认使用 gpt-5.4 作为主力模型,推理强度设为 high
分步配置
如果你更喜欢手动操作,可以按以下步骤配置:
1. 安装 Codex CLI
Codex CLI 可以通过 npm 全局安装:
bash
# 使用 npm 全局安装
npm install -g @openai/codex
# 验证安装
codex --versionpowershell
# 使用 npm 全局安装
npm install -g @openai/codex
# 验证安装
codex --version安装提示
- 如果遇到权限问题,Linux/macOS 用户可能需要使用
sudo npm install -g @openai/codex - Windows 用户建议以管理员身份运行 PowerShell
- 安装完成后,可以在任意目录使用
codex命令 - 包名是
@openai/codex,不是codex-cli
2. 创建配置目录
bash
mkdir -p ~/.codexpowershell
New-Item -ItemType Directory -Path "$env:USERPROFILE\.codex" -Force3. 创建 auth.json
在 ~/.codex/ 目录下创建 auth.json 文件:
json
{
"OPENAI_API_KEY": "sk-你的密钥"
}3. 创建 config.toml
在 ~/.codex/ 目录下创建 config.toml 文件:
toml
model_provider = "luckyapi"
model = "gpt-5.4"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"
[model_providers.luckyapi]
name = "luckyapi"
base_url = "https://cn.luckyapi.chat/v1"
wire_api = "responses"配置说明
| 配置项 | 说明 |
|---|---|
model_provider | API 提供商,这里使用 luckyapi |
model | 使用的模型,默认 gpt-5.4 |
model_reasoning_effort | 推理强度,可选 low/medium/high |
disable_response_storage | 禁用响应存储,保护隐私 |
preferred_auth_method | 认证方式,使用 apikey |
base_url | API 基础 URL |
wire_api | API 协议类型 |
使用 Codex CLI
基本用法
bash
# 启动交互式对话
codex
# 直接提问
codex "如何在 Python 中读取 JSON 文件?"
# 生成代码
codex "写一个 React 组件,显示用户列表"
# 解释代码
codex explain main.py
# 调试代码
codex debug "为什么这段代码报错?"切换模型
在配置文件中修改 model 字段:
toml
# 使用 GPT-5.4
model = "gpt-5.4"
# 使用 Claude Opus 4.6
model = "claude-opus-4-6"
# 使用代码专精模型
model = "gpt-5.3-codex-xhigh"调整推理强度
根据任务复杂度调整 model_reasoning_effort:
toml
# 简单任务,快速响应
model_reasoning_effort = "low"
# 中等任务,平衡速度和质量
model_reasoning_effort = "medium"
# 复杂任务,深度推理
model_reasoning_effort = "high"常见问题
1. 如何获取 LuckyAPI Key?
访问 LuckyAPI,注册账号后在控制台创建 API 令牌。
2. 配置文件在哪里?
- Linux/macOS:
~/.codex/ - Windows:
%USERPROFILE%\.codex\
3. 如何更新配置?
直接编辑 ~/.codex/auth.json 或 ~/.codex/config.toml,无需重启。
4. 支持哪些模型?
通过 LuckyAPI 可以使用:
- GPT 系列: gpt-5.4, gpt-5.3-codex-xhigh, gpt-5.2
- Claude 系列: claude-opus-4-6, claude-sonnet-4-6, claude-haiku-4-5
- Gemini 系列: gemini-3.1-pro-preview, gemini-3-pro-preview
5. 如何保护 API Key?
- 不要将
auth.json提交到 Git 仓库 - 设置文件权限:
chmod 600 ~/.codex/auth.json - 定期轮换 API Key
进阶技巧
1. 设置别名
在 ~/.bashrc 或 ~/.zshrc 中添加:
bash
alias c="codex"
alias ce="codex explain"
alias cdb="codex debug"2. 管道使用
bash
# 解释命令输出
ls -la | codex "解释这个目录结构"
# 分析日志
cat error.log | codex "找出错误原因"3. 结合 Git
bash
# 生成 commit message
git diff | codex "为这些改动写一个 commit message"
# 代码审查
git diff main | codex "审查这些代码改动"相关链接
- Codex CLI GitHub
- LuckyAPI — 低价稳定的 API 服务
- OpenAI 文档
- Claude 文档