图文使用说明

从添加第一个 KEY 到启动 Codex。

codex助手 适合需要频繁切换 Codex API Key、使用 NewAPI 中转服务、查看配置写入结果, 或希望在不修改 Codex 安装目录的前提下启用启动增强的用户。

codex助手 管理界面预览
左侧是功能导航,右侧集中处理 KEY、Codex 启动、配置预览和恢复。

1. 安装与运行

  1. 下载对应系统的安装包。
  2. Windows 使用 msi 或 exe 安装包,macOS 使用 app 或 dmg 安装包。
  3. 第一次打开后进入设置页,点击重新检测 Codex 位置。

开发环境可以直接运行:

cd apps/codex-manager
npm install
npm run dev

2. 添加免登录 KEY

  1. 进入免登录 KEY 配置页。
  2. 填写名称、Base URL 和 API KEY。
  3. 点击保存并切换,codex助手 会把它设为当前账号。
Base URL 通常以 /v1 结尾。切换账号后,应用会写入 Codex 的 config.toml 和 auth.json。

3. 登录 NewAPI 并同步远程 KEY

  1. 进入登录配置页,填写兼容 NewAPI 的服务地址、账号和密码。
  2. 登录成功后查询远程 KEY,可以按名称搜索。
  3. 选择同步,或直接点击使用,把远程 KEY 解密后保存到本地账号列表。

当前 V1 主要面向兼容 NewAPI 的远程 KEY 管理流程。

4. 启动或重启 Codex

  1. 确认当前账号已经切换成功。
  2. 进入设置页,点击启动 Codex 或重启 Codex。
  3. 如果开启插件解锁,codex助手 会保存设置并自动重启 Codex。

启动时会动态选择空闲调试端口,并过滤冲突参数,减少重启白屏风险。

5. 查看配置与恢复备份

  1. 在设置页点击查看配置,可以预览当前 config.toml 和 auth.json。
  2. 点击恢复配置,可以查看最近一次备份内容。
  3. 确认后恢复,Codex 配置会回到备份状态。
每次应用账号、恢复配置或清除 API 模式前,核心逻辑都会创建备份。