511 实验室 Sub2API 配置 Codex 教程

本文面向 511 实验室成员,目标是让大家用自己的 Sub2API API Key 配置 Codex App、Codex CLI 或 VS Code 里的 Codex 插件。
补充:如果你没有 ChatGPT 账号,只用 API Key 登录 Codex 时发现“插件”入口提示必须登录 ChatGPT,可以看这篇单独教程:没有 ChatGPT 账号时 Codex 插件无法使用的解决方法。
文中的 xxx 代表实验室通知的 Sub2API 地址。为避免公开传播,教程里不直接展示真实地址。

0. 需要准备什么

先准备这些内容:
  • 511 Sub2API 注册地址:xxx/register
  • Codex App 官方文档:<https://developers.openai.com/codex/app>
  • Codex CLI 官方文档:<https://developers.openai.com/codex/cli>
  • Cockpit Tools:<https://github.com/jlcodes99/cockpit-tools>
  • Cockpit Tools 下载页:<https://github.com/jlcodes99/cockpit-tools/releases>
  • VS Code:<https://code.visualstudio.com/>
可以按自己的使用习惯选择下面三种方式之一:
  • 方式 A:Cockpit Tools 添加 API,适合想统一管理多个 API Key 的同学。
  • 方式 B:不使用 Cockpit Tools,直接在 Codex App 里配置,适合只使用 Codex App / Codex CLI 的同学。
  • 方式 C:在 VS Code 里使用 Codex 插件,适合主要在 VS Code 里写代码的同学。
无论选择哪种方式,都要先完成 Sub2API 注册、登录和 API Key 创建。

1. 注册 Sub2API 账号

浏览器打开:
注册页面如下:
Sub2API 注册页面
Sub2API 注册页面
填写内容:
  • 邮箱:建议使用常用邮箱。
  • 密码:至少 6 个字符,建议不要和其他网站复用密码。
  • 优惠码:如果管理员没有单独通知,可以留空。
已有账号的同学可以直接登录:
Sub2API 登录页面
Sub2API 登录页面

2. 新建 API Key

登录 Sub2API 后,进入后台中类似 API Key、API 密钥、Tokens、令牌、密钥 的页面,新建自己的 API Key。
新建 API Key 时,分组 一定选择 订阅a。
新建 API Key 时选择订阅a分组
新建 API Key 时选择订阅a分组
注意:
  • 每个人使用自己的 Key,不要共用别人的 Key。
  • 不要把 Key 发到群里,也不要提交到 Git 仓库。
  • 如果 Key 泄露,立刻在 Sub2API 后台删除旧 Key 并重新生成。
  • 后面教程里用 sk-从Sub2API复制的Key 作为占位符,实际填写时换成自己的真实 Key。

3. 方式 A:使用 Cockpit Tools 添加 Codex API

这种方式适合需要在多个账号、多个 API 之间切换的同学。

3.1 安装 Codex App

Codex App 官方文档提供 macOS 和 Windows 下载入口。打开:
在页面里找到 Download and install the Codex app,按自己的系统下载:
  • Windows:选择 Download for Windows。
  • macOS Apple Silicon:选择 Download for macOS (Apple Silicon)。
  • macOS Intel:选择 Download for macOS (Intel)。
安装完成后打开 Codex App。第一次打开时可以先不急着开始项目,先按后面的步骤在 Cockpit Tools 里添加 API Key。
如果你只想用命令行,也可以安装 Codex CLI:
启动 Codex CLI:
如果已经安装了 Codex CLI,也可以尝试用下面命令打开 Codex App:

3.2 安装 Cockpit Tools

打开 Cockpit Tools 下载页:
Windows 用户在 Assets 里下载 Windows 安装包;macOS 用户下载 .dmg;Linux 用户下载 .AppImage、.deb 或 .rpm。

3.3 打开 Cockpit Tools 的 Codex 页面

启动 Cockpit Tools 后,点击左侧栏的 Codex 图标,进入 Codex 账号管理页面。
Cockpit Tools Codex 账号页面
Cockpit Tools Codex 账号页面
这一页只需要确认两件事:
  • 左侧选中的是 Codex。
  • 页面右上角能看到蓝色的 + 按钮。

3.4 点击加号添加账号

在 Codex 账号页面右上角,点击蓝色 + 按钮。
点击加号添加 Codex 账号
点击加号添加 Codex 账号
点击后会打开“添加 Codex 账号”的窗口。

3.5 选择 API Key 添加方式

在弹窗顶部选择 API Key。
选择 API Key 添加方式
选择 API Key 添加方式
如果界面里有供应商选项,按下面方式处理:
  • 推荐选择 自定义。
  • 如果界面默认选中了 Cockpit Api,也可以继续往下填,但必须把下面的 基础地址 改成实验室地址。

3.6 填写 API Key 和基础地址

向下滚动到填写区域,主要填写两个地方:
填写 API Key 和基础地址
填写 API Key 和基础地址
填写时注意:
  • API Key 只粘贴 Key 本身,不要加 Bearer 。
  • 基础地址 填 xxx。
  • 基础地址 后面不要额外加 /v1。
  • 如果输入框里原来是示例地址或其他地址,要改成实验室通知的 xxx。
  • 确认无误后,点击底部的 添加账号。

3.7 切换到刚添加的账号

添加成功后,回到 Codex 账号页面。找到刚添加的 API Key 账号,点击卡片上的 切换。
切换成功后,账号卡片上会显示类似:
  • 当前
  • API_KEY
  • 供应商显示为自定义或你刚才选择的供应商
看到 当前 后,再打开 Codex App 或在命令行运行 codex,就会使用 Cockpit Tools 当前选中的 API Key。

4. 方式 B:不使用 Cockpit Tools,直接配置 Codex App

这种方式不需要安装 Cockpit Tools。核心思路是:在 Sub2API 后台复制 API Key 和网站生成的 Codex 配置,然后在 Codex App 的 API 模式和 config.toml 里填好。

4.1 在 Sub2API 后台点击“使用密钥”

打开 Sub2API 后台,进入 API 密钥 页面。找到自己新建的 Key,在右侧 操作 区域点击 使用密钥。
在 API 密钥列表中点击使用密钥
在 API 密钥列表中点击使用密钥

4.2 复制 Codex CLI 配置文件

在弹出的 使用 API 密钥 窗口中,选择 Codex CLI。
如果你是 Windows 用户,选择 Windows;如果你是 macOS / Linux 用户,选择 macOS / Linux。
然后点击配置文件右侧的 复制 按钮,把网站生成的 config.toml 配置复制下来。
复制 Codex CLI 配置文件
复制 Codex CLI 配置文件
注意:
  • 这里复制的是配置文件内容,不只是 API Key。
  • 配置文件里如果出现真实地址或真实 Key,不要发到群里。
  • 网站给出的配置以页面为准,不要自己手动乱改。

4.3 在 Codex App 里选择 API 模式

打开 Codex App。登录方式选择 API 或 API Key 模式,然后把 Sub2API 后台复制的 API Key 粘贴进去。
这里只填 Key 本身,不要加 Bearer 。

4.4 打开 Codex App 设置

进入 Codex App 后,点击左下角的设置入口,然后选择 设置。
Codex App 左下角打开设置
Codex App 左下角打开设置
进入设置页后,左侧保持在 常规 或切换到后面的 配置 页面。
Codex App 设置页面
Codex App 设置页面

4.5 打开 config.toml

在设置页左侧点击 配置,找到 自定义 config.toml 设置,然后点击 打开 config.toml。
Codex App 打开 config.toml
Codex App 打开 config.toml

4.6 粘贴网站生成的配置并重启

把第 4.2 步从 Sub2API 网站复制的配置粘贴到 config.toml 的开头部分。
保存文件后,完全退出并重新打开 Codex App。
注意:
  • 如果 config.toml 里已经有同名的 Codex / OpenAI provider 配置,不要保留两份重复配置;用 Sub2API 网站生成的新配置替换旧配置。
  • 不要把真实 API Key 发给别人。
  • 修改 config.toml 后一定要重启 Codex App,否则新配置可能不会生效。

5. 方式 C:在 VS Code 里使用 Codex 插件

VS Code 的配置方式和 Codex App 基本相同,区别是需要先安装 Codex 插件。

5.1 安装 VS Code Codex 插件

打开 VS Code 左侧扩展市场,搜索 codex。
选择 Codex - OpenAI's coding agent,发布者为 OpenAI,然后点击安装。
VS Code 应用商店安装 Codex 插件
VS Code 应用商店安装 Codex 插件
注意不要选错第三方插件。优先选择带 OpenAI 标识、名称为 Codex - OpenAI's coding agent 的插件。

5.2 选择 API 模式并粘贴 API Key

安装完成后,打开 VS Code 里的 Codex 面板。登录方式选择 API 或 API Key 模式,然后粘贴自己的 Sub2API API Key。
这里只填 Key 本身,不要加 Bearer 。

5.3 打开 VS Code Codex 设置

在 Codex 面板右上角点击设置图标。
VS Code Codex 面板右上角设置入口
VS Code Codex 面板右上角设置入口
在弹出的菜单里选择 Codex 设置。
选择 Codex 设置
选择 Codex 设置

5.4 打开 config.toml

在 Codex 设置页里进入 Configuration 或 配置,找到 config.toml,点击 Open config.toml。
VS Code Codex 打开 config.toml
VS Code Codex 打开 config.toml

5.5 粘贴网站生成的配置并重启

把第 4.2 步从 Sub2API 网站复制的 Codex CLI 配置粘贴到 config.toml 的开头部分。
保存文件后,重启 VS Code,或者至少重新加载 VS Code 窗口并重新打开 Codex 插件。
注意:
  • VS Code 插件和 Codex App 使用的是同一类 config.toml 配置。
  • 如果已有同名 provider 配置,不要重复粘贴两份;用网站生成的新配置替换旧配置。
  • 修改后必须重启或重新加载,配置才会稳定生效。

6. 最容易填错的地方

6.1 API Key 新建时没选 订阅a

如果新建 Key 时选错分组,后面可能无法正常使用。请回 Sub2API 后台重新创建一个 Key,分组选择 订阅a。

6.2 把登录密码当成 API Key

Codex 里要填的是 Sub2API 后台生成的 API Key,不是 Sub2API 登录密码。

6.3 API Key 前面多加了 Bearer

在 Codex App、VS Code 插件或 Cockpit Tools 里填写时,只粘贴 Key 本身:
不要写成:

6.4 Cockpit Tools 基础地址多加了 /v1

Cockpit Tools 的 API Key 添加窗口里,基础地址请填写:
不要填成:

6.5 修改 config.toml 后没有重启

无论是 Codex App 还是 VS Code 插件,只要改了 config.toml,都建议重启一次。否则界面可能仍然使用旧配置。

6.6 config.toml 里有重复配置

如果 config.toml 已经有同名 provider 配置,不要在文件里同时保留两份。保留 Sub2API 网站生成的那一份即可。

6.7 复制配置文件时选错系统

在 使用 API 密钥 窗口里,Windows 用户选择 Windows,macOS / Linux 用户选择 macOS / Linux。如果路径不对,Codex 可能找不到配置目录。

7. 最短流程

7.1 使用 Cockpit Tools

  1. 打开 xxx/register 注册或登录。
  1. 新建 API Key,分组选择 订阅a。
  1. 安装 Codex App。
  1. 安装并打开 Cockpit Tools。
  1. 点击左侧 Codex。
  1. 点击右上角蓝色 +。
  1. 选择 API Key。
  1. 填入自己的 API Key。
  1. 基础地址 填 xxx,不要加 /v1。
  1. 点击 添加账号。
  1. 回到账号卡片,点击 切换,看到 当前 即可。

7.2 不使用 Cockpit Tools

  1. 打开 xxx/register 注册或登录。
  1. 新建 API Key,分组选择 订阅a。
  1. 在 API 密钥 页面点击 使用密钥。
  1. 在 Codex CLI 选项卡中复制网站生成的配置文件。
  1. 打开 Codex App,选择 API 模式,粘贴 API Key。
  1. 左下角进入 设置。
  1. 进入 配置,点击 打开 config.toml。
  1. 把网站生成的配置粘贴到 config.toml 开头。
  1. 保存并重启 Codex App。

7.3 使用 VS Code 插件

  1. 打开 xxx/register 注册或登录。
  1. 新建 API Key,分组选择 订阅a。
  1. 在 API 密钥 页面点击 使用密钥。
  1. 在 Codex CLI 选项卡中复制网站生成的配置文件。
  1. VS Code 扩展市场搜索 codex。
  1. 安装 Codex - OpenAI's coding agent,发布者为 OpenAI。
  1. 打开 Codex 插件,选择 API 模式,粘贴 API Key。
  1. 点击右上角设置图标,进入 Codex 设置。
  1. 进入 Configuration / 配置,点击 Open config.toml。
  1. 把网站生成的配置粘贴到 config.toml 开头。
  1. 保存并重启 VS Code。