Skip to content

Codex CLI

本页只讲终端里的 Codex CLI。如果你使用 ChatGPT 桌面版、独立 Codex 客户端或 IDE 插件,请查看 Codex/ChatGPT 文档。

TIP

推荐路径:先在 CC Switch 中把 getapi.one 和 getapi.pro 分别创建成 OpenAI 兼容 Provider。如果只想走终端配置,也可以把两个 Provider 写进 Codex 的 config.toml,并把 API Key 放在环境变量里。

桌面端和 IDE 插件请查看 Codex/ChatGPT

下载安装

CC Switch 下载

如果希望用可视化方式统一管理和切换 GetAPI Provider,建议先安装 CC Switch。

客户端系统 / 场景CDN 下载备用下载
CC SwitchmacOS下载GitHub Releases
CC SwitchWindows下载GitHub Releases
CC Switch更多版本GitHub Releases

安装 Codex CLI

Codex CLI 官方安装命令:

bash
curl -fsSL https://chatgpt.com/codex/install.sh | sh

如果当前环境无法使用该安装脚本,更多安装方式请以 OpenAI 官方 Codex CLI 文档为准。

开始前准备

  • 已安装 Codex CLI,并且终端里可以正常运行 codex 命令。
  • 已安装 CC Switch,或者已经准备好手动编辑 Codex 配置文件。
  • 已完成 GetAPI 注册和登录。如果还没有完成,先查看注册和登录总览
  • 已创建 GetAPI API Key。如果还没有创建,先查看申请 API Key 总览
  • 确认这次 CLI 会话要使用 getapi.one 还是 getapi.pro。
  • 准备好要让 Codex CLI 使用的模型名称。

选择 GetAPI 服务

API Key 和 Base URL 必须来自同一个服务。Codex CLI 和 CC Switch 配置时,Base URL 需要带上 /v1。不要把 getapi.one 的 Key 配到 getapi.pro 的中转地址,也不要反过来混用。

服务Codex Base URLAPI Key 来源申请说明
getapi.onehttps://www.getapi.one/v1getapi.one API Keys申请说明
getapi.prohttps://relay-api.getapi.pro/v1getapi.pro API Keys申请说明

使用 CC Switch 配置

1. 打开 CC Switch

先打开 CC Switch,准备进入 Codex 供应商配置区域。

2. 打开 Codex 供应商页

在 CC Switch 顶部选择 Codex 供应商页,然后点击右上角加号新增供应商。

CC Switch Codex 供应商列表和新增按钮

3. 选择自定义配置

进入添加新供应商页面后,选择“自定义配置”;如果没看到,可以向下滑动查找。

CC Switch 添加供应商页面中选择自定义配置

4. 填写 GetAPI 供应商

填写供应商名称,粘贴对应服务的 API Key,并在 API 请求地址中填写带 /v1 的地址,例如 https://relay-api.getapi.pro/v1。

CC Switch 中填写 GetAPI Pro 供应商配置,Base URL 以 /v1 结尾
配置项getapi.progetapi.one说明
供应商名称GetAPI ProGetAPI One自定义名称,方便后续识别。
官网链接https://www.getapi.prohttps://www.getapi.one填写供应商官网;如果 CC Switch 不强制要求,也可以不填。
API Keygetapi.pro 的 API Keygetapi.one 的 API Key从对应站点的 API 密钥页面复制,不要混用两个站点的 Key 和地址。
API 请求地址https://relay-api.getapi.pro/v1https://www.getapi.one/v1必须带上 /v1。
默认模型例如 gpt-5.6-sol例如 gpt-5.6-sol填写对应 GetAPI 控制台中可用的模型名称。

5. 启用供应商

保存后回到供应商列表,点击“启用”,再启动 Codex CLI。

CC Switch 中启用 GetAPI Pro 供应商

手动配置 config.toml

如果只想用终端方式配置,先把 Key 放进环境变量。不要把真实 API Key 明文写进 config.toml。

bash
export GETAPI_ONE_API_KEY="sk-..."
export GETAPI_PRO_API_KEY="sk-..."

然后打开 ~/.codex/config.toml,加入两个 GetAPI Provider。需要默认使用哪个服务,就把 model_provider 改成对应 Provider。

toml
model_provider = "getapi_pro"
model = "your-model-name"

[model_providers.getapi_one]
name = "GetAPI One"
base_url = "https://www.getapi.one/v1"
env_key = "GETAPI_ONE_API_KEY"
wire_api = "responses"

[model_providers.getapi_pro]
name = "GetAPI Pro"
base_url = "https://relay-api.getapi.pro/v1"
env_key = "GETAPI_PRO_API_KEY"
wire_api = "responses"

把 your-model-name 替换成你在对应 GetAPI 控制台里可用的模型名称。GetAPI 的 base_url 需要保留 /v1 结尾。如果中转站使用了不同的 OpenAI 兼容协议,请按 Codex 配置参考调整 Provider 设置。

运行 Codex CLI

1. 确认 Codex CLI 已安装

在终端执行 codex --version,确认 codex 命令可以正常使用。

终端显示 codex --version 输出

2. 发送测试请求

启动 Codex CLI 后发送一条简单消息。如果能正常返回,说明 CLI Provider 可以使用。

终端中 Codex CLI 正常回复测试消息

常见问题

问题可能原因
codex: command not foundCodex CLI 未安装,或安装目录没有加入 PATH。
Missing API keyenv_key 对应的环境变量没有在当前终端加载。
401 / UnauthorizedAPI Key 错误、已禁用,或 Key 和服务地址不匹配。
404 / Not FoundBase URL 填写错误、缺少 /v1,或中转站不支持当前 CLI 使用的请求路径。
Model not found模型名称填写错误,或当前 GetAPI 分组没有开通该模型。
配置没有生效编辑了错误的配置文件、model_provider 指向了其它 Provider,或终端需要重新打开。

安全提醒

不要把真实 API Key 放进截图、公开仓库、前端代码或共享文档中。建议使用环境变量保存 Key,分享终端输出前先遮盖敏感信息。

参考链接

OpenAI 官方文档提供 Codex CLI 的安装、认证和配置参考。CC Switch Releases 可作为备用下载入口。