跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.apiyi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
概述

Codex CLI 是 OpenAI 官方推出的命令行编程助手，专为终端工作流设计。通过 API易接入只需要做一件事：
把 OpenAI 的入口换成 API易
API易是 OpenAI 兼容接口（透明代理）——本质就是替换 Base URL + Key，不需要修改 model_provider、不需要自定义 env_key，OpenAI SDK 怎么用，Codex CLI 就怎么用。

🚀 一键接入

两个环境变量即用，无需复杂配置文件

⚡ 最新模型

支持 gpt-5.5 / gpt-5.4 / gpt-5.3-codex

💰 按量计费

与 OpenAI 官方计费方式一致，价格更优

🔧 全平台

Mac / Linux / Windows（PowerShell）通用

​
一、准备工作

​
安装 Codex CLI

先全局安装官方 CLI 工具（需要 Node.js 18+）： 
npm install -g @openai/codex
验证： 
codex --version
Mac 用户如果遇到权限问题，可加 sudo；推荐用 nvm / fnm 管理 Node 版本以避免全局权限。

​
二、核心配置：替换两个环境变量

API易是 OpenAI 兼容接口，所以配置就两行： 
OPENAI_BASE_URL=https://api.apiyi.com/v1
OPENAI_API_KEY=sk-你的APIYI密钥
变量名固定：必须叫 OPENAI_API_KEY 和 OPENAI_BASE_URL，这是 Codex CLI 内置约定，不要改名。Base URL 必须带 /v1：写成 https://api.apiyi.com/v1，缺 /v1 会 404。

​
Mac / Linux 配置

编辑 shell 配置文件： 
vim ~/.zshrc
# 或 ~/.bashrc
加入： 
export OPENAI_BASE_URL="https://api.apiyi.com/v1"
export OPENAI_API_KEY="sk-你的APIYI密钥"
让配置生效： 
source ~/.zshrc
# 或 source ~/.bashrc

​
Windows 配置

使用 setx 写入用户级环境变量：
setx OPENAI_BASE_URL "https://api.apiyi.com/v1"
setx OPENAI_API_KEY "sk-你的APIYI密钥"
关闭并重新打开终端生效。

​
三、启动与基础使用

进入项目目录直接启动： 
cd /your/project
codex
或一句话直接执行任务： 
codex "帮我写一个 Python HTTP Server"
非交互（静默）模式： 
codex -q "修复当前项目的构建错误"

​
四、模型说明（API易推荐）

API易当前可用于 Codex CLI 的常用模型：
模型特点适用场景
gpt-5.5最新主力模型复杂代码任务、工程分析、Agent 工作流
gpt-5.4稳定常用大多数代码开发、调试、重构场景
gpt-5.4-mini便宜的 5.4 变体中小规模任务、批量处理
gpt-5.4-nano极致便宜简单代码补全、轻量任务
gpt-5.3-codex专攻 Codex 场景复杂软件工程任务
gpt-4.1经典便宜模型预算敏感的日常使用
怎么选：日常 → gpt-5.4；重活/Agent → gpt-5.5；纯代码工程 → gpt-5.3-codex；省钱 → gpt-5.4-mini / gpt-4.1。

​
1. 启动时临时指定模型

用 -m 或 --model： 
codex -m gpt-5.5
codex --model gpt-5.4
codex -m gpt-5.3-codex
也可以直接带任务： 
codex -m gpt-5.5 "帮我检查这个项目的代码结构，并指出可以优化的地方"

​
2. 非交互模式指定模型

codex -q -m gpt-5.4 "修复当前项目里的构建错误"

​
3. 会话内切换模型

进入 Codex CLI 后，在会话里输入： 
/model
按提示选择或输入要切换的模型。

​
4. 配置默认模型

如果希望默认就用某个模型，编辑 ~/.codex/config.toml： 
model = "gpt-5.5"
Codex 当前官方配置文件是 config.toml（不是早期教程里的 config.json）。用户级配置在 ~/.codex/config.toml，也支持项目级 .codex/config.toml。

​
五、进阶配置

​
自定义系统提示词

编辑： 
~/.codex/instructions.md
可以定义编码风格、输出语言、项目规范等，例如： 
- 代码注释使用中文
- 遵循项目的 ESLint 配置
- 提供详细的解释说明

​
项目级 AGENTS.md

首次进入项目时运行 codex /init 会生成 AGENTS.md，记录项目结构与规范。如需 Codex 默认用中文交流，加一行： 
本项目请始终用中文跟用户交流。

​
常用参数

codex -h          # 查看完整帮助
codex -m <模型>   # 指定模型
codex -q          # 非交互/静默模式
codex --full-auto # 自动执行（谨慎使用）

​
六、注意事项

​
1. Key 与变量名

  • API易 Key 在控制台 api.apiyi.com/token 获取
  • 变量名必须是 OPENAI_API_KEY（CLI 写死的，不可改名）

​
2. Base URL

  • 必须带 /v1：https://api.apiyi.com/v1
  • 也可使用其他网关域名（如 b.apiyi.com/v1、vip.apiyi.com/v1），响应行为一致

​
3. 网络问题

如果遇到 timeout / 连接失败，优先排查：
  • 本地 HTTP/HTTPS 代理配置
  • DNS 解析
  • 是否误用了 Cloudflare 中转域名（不建议）

​
4. 模型差异

  • Codex CLI 偏向代码任务，多模态能力（图像/语音）走专门接口更合适
  • 不同 gpt-5.x 模型在工具调用、长上下文、推理深度上有差异，建议按任务复杂度选择

​
七、常见问题

因为 API易完全兼容 OpenAI API 协议——CLI 看到的 https://api.apiyi.com/v1 和 https://api.openai.com/v1 在请求/响应格式上是一致的，仅替换 Base URL 即可。
确认已正确安装：
npm install -g @openai/codex
codex --version
如果仍报错，检查 npm bin -g 路径是否在 PATH 中。
  1. 确认用的是 API易 Key（以 sk- 开头），不是 OpenAI 官方 Key
  2. 检查环境变量是否生效： 
    echo $OPENAI_API_KEY    # Mac/Linux
echo %OPENAI_API_KEY%   # Windows CMD
echo $env:OPENAI_API_KEY # Windows PowerShell
  3. 改完环境变量后重启终端或 source ~/.zshrc
最常见原因：Base URL 没带 /v1。正确写法：https://api.apiyi.com/v1其次排查本地代理与 DNS。
三种方式：
  • 临时：codex -m gpt-5.5
  • 会话中：/model
  • 默认：编辑 ~/.codex/config.toml，设置 model = "gpt-5.5"
  • OpenAI 系列：✅ 完整支持（推荐 gpt-5.5 / gpt-5.4 / gpt-5.3-codex）
  • 其他厂商聚合模型：API易支持，但 Codex CLI 本身偏向 OpenAI 协议——非 OpenAI 模型可能在 tool use / function call 协议上有差异
  • 想用 Claude / Gemini 系列做编程，建议用对应原生 CLI（如 Claude Code）
  • CLI：适合开发期效率工具
  • 生产：建议直接调用 API（更可控、可监控、可灰度）
卸载 CLI：
npm uninstall -g @openai/codex
停用 API易 配置：删除环境变量与配置文件即可。
# Mac/Linux：编辑 ~/.zshrc 或 ~/.bashrc 删掉 OPENAI_* 两行
rm ~/.codex/config.toml

# Windows：从「系统环境变量」中删除 OPENAI_BASE_URL / OPENAI_API_KEY

​
八、总结

这类接入本质就一句话：
把 OpenAI 的入口换成 API易
核心两行： 
export OPENAI_BASE_URL="https://api.apiyi.com/v1"
export OPENAI_API_KEY="sk-你的APIYI密钥"
剩下都是锦上添花——选模型、写提示词、自定义 instructions.md / AGENTS.md。

​
相关资源

API易控制台

管理 API 密钥与查看用量

Claude Code 集成

用 Claude 系列做命令行编程

模型对比

所有可用模型与定价

API 使用手册

通用调用规范