📚 目录 / Contents

OpenAI Codex 接入

在 OpenAI Codex(CLI 和桌面版)中使用 TokenHub

OpenAI Codex 是 OpenAI 推出的 AI 编程助手,提供命令行工具(CLI)和桌面应用两种版本,支持 GPT-5.5 等最新模型。

ℹ️ 说明:Codex CLI 使用 OpenAI 最新的 Responses API 协议(/v1/responses),桌面版使用标准的 Chat Completions API。本文档介绍如何配置 TokenHub 作为 API 提供商。


方式一:Codex 桌面版配置

Codex 桌面版需要手动修改配置文件,配置后需要完全退出应用再重新打开。

配置步骤

1. 找到 Codex 配置目录

Windows 系统

C:\Users\{用户名}\.codex

macOS 系统

~/.codex

2. 配置 API Key

找到 auth.json 文件,修改其中的 OPENAI_API_KEY 字段:

{
  "OPENAI_API_KEY": "sk-xxxxx"
}

sk-xxxxx 替换为您的 TokenHub API Key

3. 配置自定义 API 提供商

找到 config.toml 文件,添加以下配置:

# 指定使用自定义 API 提供商
model_provider = "my_custom_api"

# 默认模型名称
model = "gpt-5.1"

# 推理努力程度(可选)
model_reasoning_effort = "high"

# 定义自定义 API 提供商
[model_providers.my_custom_api]
name = "my_custom_api"

# TokenHub API 地址
base_url = "https://hubwave.ai/v1"

# API 协议类型
wire_api = "responses"

📝 注意

  • base_url 替换为您的 TokenHub 实际域名
  • model 可以改为您在 TokenHub 中配置的任意模型名称
  • wire_api 必须设置为 "responses"

4. 完全退出并重启 Codex

重要:必须完全退出应用,而不是退出登录!

  • Windows:右键任务栏托盘图标 → 退出,或使用任务管理器结束进程
  • macOS:右键 Dock 图标 → 退出,或使用 Cmd+Q 完全退出

⚠️ 注意:仅点击窗口关闭按钮(X 或红色关闭按钮)可能无法完全退出应用,Codex 会在后台继续运行。必须从系统托盘/Dock 完全退出。

5. 重新打开 Codex

完全退出后,重新启动 Codex 桌面应用,配置即可生效。

使用说明

  • 配置完成后,Codex 会自动使用 TokenHub 的 API
  • 所有在 TokenHub 后台配置的模型都可以使用
  • 所有功能(Chat、Composer、Cmd+K 等)都会使用您的自定义 API

方式二:Codex CLI 配置

Codex CLI 适合喜欢命令行工作的开发者,配置相对复杂但更灵活。

前置要求

  • 已安装 Codex CLI v0.142.5 或更高版本
  • 已获取 TokenHub API Key(格式:sk-xxxxx
  • Windows 系统需使用 PowerShell 或 CMD

配置步骤

1. 设置环境变量

为了安全起见,Codex 要求将 API Key 存储在环境变量中,而不是直接写在配置文件里。

Windows(PowerShell)

# 永久设置环境变量
[System.Environment]::SetEnvironmentVariable('MY_CUSTOM_API_KEY', 'sk-xxxxx', 'User')

# 验证设置
$env:MY_CUSTOM_API_KEY

Windows(CMD)

# 永久设置环境变量
setx MY_CUSTOM_API_KEY "sk-xxxxx"

# 需要重启终端后验证
echo %MY_CUSTOM_API_KEY%

macOS/Linux(Bash)

# 添加到 ~/.bashrc 或 ~/.zshrc
echo 'export MY_CUSTOM_API_KEY="sk-xxxxx"' >> ~/.bashrc
source ~/.bashrc

# 验证设置
echo $MY_CUSTOM_API_KEY

⚠️ 重要:设置环境变量后,必须重启终端才能生效!

2. 创建配置文件

在项目目录下创建 config.toml 文件:

# 默认使用的模型名称
model = "gpt-5.1"

# 默认使用的提供商名称
model_provider = "tokenhub"

[model_providers.tokenhub]
name = "TokenHub"

# API 基础 URL(替换为您的 TokenHub 域名)
base_url = "https://hubwave.ai/v1"

# 使用 Responses API 协议(必需)
wire_api = "responses"

# 环境变量名称(不是 API Key 本身)
env_key = "MY_CUSTOM_API_KEY"

[projects.'your-project-path']
trust_level = "trusted"

[windows]
sandbox = "elevated"

📝 注意

  • env_key 填写的是环境变量的名称,不是 API Key 本身
  • base_url 必须包含 /v1 后缀
  • your-project-path 替换为实际的项目路径(如 d:\projects\myapp

3. 启动 Codex

# 在项目目录下启动
cd your-project-path
codex

4. 测试连接

启动后,在 Codex 中输入任意问题进行测试:

› 你好

如果配置正确,Codex 会正常返回响应。

注意事项

桌面版

  • 配置简单,界面友好
  • 所有功能都支持自定义 API

CLI 版

  • 需要设置环境变量
  • 必须重启终端才能生效
  • base_url 必须包含 /v1 后缀

所有在 TokenHub 后台配置的模型都可以使用。