OpenAI · 工具文档
Codex
本文说明 Codex 的安装、清理配置文件、填写配置文件。若你曾使用过 Codex 相关产品,请先完成下方清理,再继续安装配置。
1 清理旧配置
2 安装 CLI / 桌面 / 插件
3 用 cc-switch 填写配置
安装前必读
如果你使用过 Codex CLI、Codex 桌面端或
VS Code 的 Codex 插件,请先到用户目录下的
如果你未使用过上述产品,可跳过清理步骤,直接前往 安装。
.codex 文件夹中,清空
auth.json 与 config.toml
两个文件的内容(或删除后由程序重建)。旧的鉴权与配置容易导致登录失败、配置冲突或连到错误环境。
如果你未使用过上述产品,可跳过清理步骤,直接前往 安装。
清理旧配置
重要
清空前请务必备份相关文件(复制到其他目录或改名保存),以免需要时无法恢复。
.codex 一般位于用户主目录(Home)下。不同系统路径如下:
| 系统 | 典型路径 |
|---|---|
| Windows | C:\Users\你的用户名\.codex\ |
| macOS / Linux | ~/.codex/ |
需要处理的文件
auth.json— 登录 / 鉴权信息config.toml— 本地配置
请将这两个文件内容清空(保留空文件亦可),或直接删除它们;后续重启使用时会重新生成。
提示
若目录中还有其他缓存文件,一般不必动;重点是清掉
auth.json 与 config.toml,避免旧账号或旧配置干扰本次配置。
安装
完成上方清理后,可按需安装以下任一形态(可只装一种,也可多种并存)。安装前请确认本机已具备对应运行环境。
安装 CLI
注意
使用官方安装脚本前,请确认本机可以正常访问外网(含下载安装脚本与拉取安装包)。网络受限、需代理或无法访问官方域名时,请改用 npm 等方式,或先配置好代理后再执行。
推荐使用官方安装脚本(无需 Node.js):
macOS / Linux:
curl -fsSL https://chatgpt.com/codex/install.sh | sh
Windows(PowerShell):
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"
也可使用 npm 全局安装(需本机已安装 Node.js 与 npm):
npm install -g @openai/codex
macOS / Linux 还可使用 Homebrew:
brew install --cask codex
安装完成后,在终端执行以下命令检查是否可用:
codex --version
安装桌面端
- 打开 Codex 桌面端官方下载页(或团队提供的安装包地址)。
- 按系统选择安装包(Windows / macOS 等)并下载。
- 运行安装程序,按向导完成安装。
安装 VS Code 插件
- 打开 VS Code(或兼容的 Cursor 等编辑器,若团队允许)。
- 打开扩展面板:快捷键
Ctrl + Shift + X(macOS 为Cmd + Shift + X)。 - 搜索 Codex(发布者一般为 OpenAI)。
- 点击 安装(Install),等待安装完成。
填写配置文件
开始配置前
如果你曾使用过 Codex CLI / 桌面端 / 插件,必须先按上文
清理旧配置
清空配置文件,同时请
关闭 Codex CLI / 桌面端 / 插件,再进行后续配置。
强烈推荐
使用可视化配置软件 cc-switch 进行配置,操作更直观、不易写错。
下载地址:
https://github.com/farion1231/cc-switch/tags
使用 cc-switch 配置
提示
请尽量使用 Edge 或 谷歌浏览器(Chrome) 打开官网进行后续操作。其他浏览器可能出现调用 cc-switch 失败的情况。
- 安装成功后,启动 cc-switch。
- 打开官网 https://aiapi.317ak.com/ ,登录你的账号。
- 登录成功后,点击 控制台。
- 在页面左侧选择 API 密钥。
- 在页面右侧点击 创建 API 密钥。
-
在创建 API 密钥页面:
- 名称:随意填写即可。
- 分组:必须选择 codex 分组(务必选对,否则无法正常使用)。
- 其他配置不要改动,保持默认。
- 确认无误后,点击 保存更改,并妥善保存生成的密钥。
- 在密钥列表中,点击当前令牌后方的 三个点(⋯),在弹框中选择 CC-Switch。
-
在随后出现的弹窗中:
- 选择 Codex(一定不要选错,否则配置会写入错误产品)。
- 名称:随意填写即可。
-
主模型:选择你想调用的模型。例如想使用
gpt-5.5,则选择gpt-5.5即可。
- 填写完成后,点击 打开 CC Switch。
提示
如果点击 打开 CC Switch 后未跳转,请
点击此处
查看下方手动配置教程。
- 此时 cc-switch 会出现弹窗,点击弹窗右下角的 导入。
- 导入成功后,打开 Codex CLI / Codex 桌面端 / Codex 插件 即可使用。
手动配置(打开 CC Switch 未跳转时)
若点击 打开 CC Switch 后没有自动跳转,可按下列步骤在 cc-switch 中手动完成配置。
- 手动打开 cc-switch。
- 选择顶部 Codex 图标。
- 点击右上角 + 号。
- 在 API key 输入框中填写你的 API 密钥。
-
在 config.toml 中填写以下内容(其他设置不懂的话无需填写):
model_provider = "custom" model = "gpt-5.6-sol" model_reasoning_effort = "high" disable_response_storage = true [model_providers.custom] name = "My Codex" base_url = "https://aiapi.317ak.com/v1" wire_api = "responses" requires_openai_auth = true - 填写完成后,点击 保存。
- 保存成功后,点击 启用。