概述

OpenAI Codex CLI 是 OpenAI 推出的命令行编程助手,专为开发者设计的 AI 编程工具。通过配置 API易 服务,您可以获得:

🚀 稳定服务

直连 API易,无需代理

💰 灵活计费

支持按量或按次计费

⚡ GPT-5 支持

使用最新 GPT-5 模型

🔧 简单配置

几分钟完成全部设置

环境准备

必要软件

1

安装 Git

访问 Git 官网 下载并安装
Windows 用户:建议默认安装到 C 盘,使用默认设置 macOS 用户:通常已预装,可跳过此步
2

安装 Node.js

访问 Node.js 官网 下载并安装要求 Node.js 18 或更高版本
3

验证安装

打开终端验证安装是否成功:
git --version
node --version
npm --version

快速开始

1. 安装 Codex CLI

在终端运行以下命令全局安装:
sudo npm install -g @openai/codex
验证安装:
# 查看版本
codex --version

# 查看帮助
codex --help

2. 获取 API 密钥

  1. 访问 API易控制台
  2. 创建新密钥或使用默认密钥
  3. 支持两种类型:
    • 按量计费:按 Token 使用量付费
    • 按次计费:适合 Codex 系列模型

3. 配置 Codex

创建配置文件

编辑配置文件:
nano ~/.codex/config.toml
如果目录不存在,先创建:
mkdir -p ~/.codex

配置内容

config.toml 中添加以下内容:
model_provider = "codex"
model = "gpt-5-codex-high"  # 或 gpt-5-codex-medium, gpt-5-codex-low
model_reasoning_effort = "high"
disable_response_storage = true

[model_providers.codex]
name = "codex"
base_url = "https://api.apiyi.com/v1"
wire_api = "chat"
env_key = "K_CODEX"  # 不要在这里填写密钥,在环境变量中设置
模型选择说明
  • gpt-5-codex-high:最强编程能力,对标 GPT-5
  • gpt-5-codex-medium:中等性能,价格适中
  • gpt-5-codex-low:轻量版本,成本最低

4. 设置环境变量

将你的 API易 密钥设置为环境变量:
macOS (zsh):
echo 'export K_CODEX="sk-你的API易密钥"' >> ~/.zshrc
source ~/.zshrc
Linux (bash):
echo 'export K_CODEX="sk-你的API易密钥"' >> ~/.bashrc
source ~/.bashrc
配置完成后,建议重启终端以确保环境变量生效。

5. 开始使用

进入你的项目目录并启动 Codex:
# 进入项目目录
cd /path/to/your/project

# 启动 Codex
codex

使用技巧

项目初始化

首次在项目中使用时,可以让 Codex 熟悉项目结构:
codex /init
这会自动创建 AGENTS.md 文件,记录项目信息。

中文支持

默认 Codex 使用英语对话。如需中文交流,在 AGENTS.md 文件中添加:
本项目请始终用中文跟用户交流。

自定义提示词

编辑 ~/.codex/instructions.md 文件可以自定义系统提示词,定制 AI 助手的行为:
# 自定义指令

- 代码注释使用中文
- 遵循项目的代码规范
- 提供详细的解释说明

Codex 系列模型对比

模型计费模式特点适用场景
gpt-5-codex-high按量/按次最强编程能力复杂算法、架构设计
gpt-5-codex-medium按量/按次平衡性能日常编程任务
gpt-5-codex-low按量/按次轻量高效简单代码生成
计费建议
  • 大上下文场景:选择按次计费更划算
  • 短对话场景:选择按量计费更经济

功能特性

支持的编程任务

  • ✅ 代码生成和补全
  • ✅ Bug 修复和调试
  • ✅ 代码重构和优化
  • ✅ 单元测试编写
  • ✅ 文档生成
  • ✅ 代码审查
  • ✅ 算法实现

支持的语言

Codex 支持 100+ 编程语言,包括:
  • 主流语言:Python, JavaScript, TypeScript, Java, C++, C#, Go, Rust
  • Web 技术:HTML, CSS, React, Vue, Angular
  • 数据库:SQL, MongoDB, Redis
  • 脚本语言:Bash, PowerShell, Perl
  • 其他:Swift, Kotlin, Ruby, PHP, R, MATLAB

故障排除

VS Code / Cursor 集成

除了命令行使用,Codex 也提供了 IDE 插件:
目前 VS Code 和 Cursor 中的 Codex 官方插件暂不支持 API易 配置,需要使用官网账号。如需在 IDE 中使用 API易,推荐使用其他兼容插件。

替代方案

  • Cursor:内置 AI 功能,支持自定义 API 端点
  • Continue:开源 AI 编程助手,支持 API易 配置
  • Cline:支持自定义 API 的 VS Code 插件

最佳实践

项目组织

  1. 创建 AGENTS.md:记录项目规范和要求
  2. 添加 .gitignore:排除 Codex 生成的临时文件
  3. 编写清晰的注释:帮助 AI 理解代码意图

提示词技巧

# 好的提示示例
"重构这个函数,提取重复代码并添加错误处理"
"为这个 API 端点编写单元测试,覆盖正常和异常情况"
"优化这段代码的时间复杂度,并解释优化思路"

# 避免模糊指令
"改进代码"  # 太宽泛
"修复 bug"  # 没有具体说明

性能优化

  1. 合理选择模型
    • 简单任务用 gpt-5-codex-low
    • 复杂任务用 gpt-5-codex-high
  2. 上下文管理
    • 及时清理不必要的对话历史
    • 专注于当前任务
  3. 批量处理
    • 相关任务一次性描述
    • 减少往返交互

相关资源

总结

OpenAI Codex CLI 配合 API易 服务,为开发者提供了强大且经济的 AI 编程助手。通过灵活的计费模式和稳定的服务,您可以充分利用 GPT-5 Codex 系列模型的编程能力,提升开发效率。
对比提示
  • 命令行体验:Codex CLI 适合熟悉终端的开发者
  • IDE 集成:如需更好的 IDE 体验,可考虑 Claude Code 或其他支持 API易 的插件