Skip to content

CodeX模型使用指南

本页汇总 Codex 在 Windows / Linux / macOS / VScode 的安装与配置。适用于CodeX CLI / CodeX App等,可灵活变通。

1. 🥟Windows

1.1 安装 Node.js

  • 访问官网下载 Node.js的Windows安装包,下载完成后双击.msi文件即可进行安装。
  • 安装完成后在桌面空白处右键在终端处打开,选择使用CMD或者PowerShell进行安装验证:
bash
node --version
npm --version

若打印出相应数字(既版本号)则为安装成功。如果右键没有在终端处打开的选项可以在系统菜单中搜索CMD或者PowerShell程序,或者使用Win + R快捷键然后输入cmd或者powershell,然后回车即可。

1.2 在CMD或者PowerShell中安装 Codex

bash
npm i -g @openai/codex --registry=https://registry.npmmirror.com

验证安装:

bash
codex --version

⚠️ 安装需要稳定网络环境,否则速度较慢。

1.3 配置环境变量

方法 1:配置文件(如果没有请手动新建.codex文件夹/config.toml文件/auth.json文件)

打开/创建 C:\Users\你的用户名\.codex\config.toml

toml
model_provider = "custom"
model = "gpt-5.4"
model_reasoning_effort = "xhigh"
disable_response_storage = true
search_request = true

[model_providers.custom]
name = "custom"
wire_api = "responses"
requires_openai_auth = true
base_url = "https://onlycode.shop/v1"

[features]
view_image_tool = true

同目录创建 auth.json

json
{
  "OPENAI_API_KEY": "你的API密钥"
}

方法 2:环境变量

powershell
[System.Environment]::SetEnvironmentVariable("OPENAI_BASE_URL", "https://onlycode.shop/v1", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "你的API密钥", [System.EnvironmentVariableTarget]::User)

重启 PowerShell 后验证:

powershell
echo $env:OPENAI_BASE_URL
echo $env:OPENAI_API_KEY

⚠️ API 密钥获取路径:onlycode.shop 登录 → 令牌管理 → 添加令牌。

2. 🐧Linux

2.1 安装 Node.js

bash
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

验证:

bash
node --version
npm --version

2.2 安装 Codex

bash
npm install -g @openai/codex

验证安装:

bash
codex --version

2.3 编辑文件(也可以尝试2.4异常处理1中的写入环境变量的方法)

mkdir -p ~/.codex
cd ~/.codex
vi config.toml

粘贴以下内容并保存该文件:

toml
model_provider = "custom"
model = "gpt-5.4"
model_reasoning_effort = "xhigh"
disable_response_storage = true
search_request = true

[model_providers.custom]
name = "custom"
wire_api = "responses"
requires_openai_auth = true
base_url = "https://onlycode.shop/v1"

[features]
view_image_tool = true

接着编辑保存密钥的文件auth.json

vi auth.json

粘贴以下内容并保存:

json
{
  "OPENAI_API_KEY": "你的API密钥"
}

回到命令行使用:

bash
codex

⚠️ API 密钥获取路径:onlycode.shop 登录 → 令牌管理 → 添加令牌。

2.4 异常情况处理

  1. 编辑完成上述两个文件的编辑后打开CodeX提示需要登录CodeX账户或者是依旧调用了别家的Base URL。 正常设置好Base URL和密钥后进入CodeX一般会提示是否信任在该文件夹的选择。如果遇到了需要登录账户/调用别家遗留的Base URL这种情况通常是写入的文件在环境变量中读取不到。先进行测试,验证你设置的两个值。

    验证Base URL设置:

echo $OPENAI_BASE_URL

​ 验证密钥设置:

echo $OPENAI_API_KEY

​ 如果没有任何输出/输出的项不为你根据文档设置的值,说明你文件的设置有误,先检查config.toml和auth.json中是 否保存了。如果确定保存了,你可以尝试使用命令行:

echo 'export OPENAI_BASE_URL="https://onlycode.shop/v1"' >> ~/.bashrc
echo 'export OPENAI_API_KEY="你的API密钥"' >> ~/.bashrc
source ~/.bashrc

​ 接着再次验证Base URL设置和密钥设置。

​ 注意⚠️:上述命令根据用户反馈,某些情况下需要手动编辑~/.bashrc才能使变量生效(常见于公司内网机器)。我们默认Linux用户有极强的动手能力,但请依旧谨慎vi ~/.bashrc

  1. 编辑好文件后使用CodeX一直提示重连中。 先检查当前网络是否能正常访问互联网。重连失败多次后会打印出报错信息,核对报错信息中的Base URL是否为https://onlycode.shop/v1 。如果是,那么再检查在上面的问题1中的两个文件是否正确保存了。注意在编辑完文件后,可能需要重启你的CodeX CLI/CodeX App/VScode/OpenCode等客户端。

  2. WSL中的CodeX提示重连。

注意您的网络设置。尝试WSL端和Windows端分别ping baidu.com 确保WSL和本机之间的网络连通性。

3. 🍎MacOS

3.1 安装 Homebrew

bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

3.2 安装 Node.js

bash
brew update
brew install node

验证:

bash
node --version
npm --version

3.3 安装 Codex

bash
npm install -g @openai/codex

验证:

bash
codex --version

3.4 编辑文件

mkdir -p ~/.codex
cd ~/.codex
vi config.toml

粘贴以下内容并保存:

toml
model_provider = "custom"
model = "gpt-5.4"
model_reasoning_effort = "xhigh"
disable_response_storage = true
search_request = true

[model_providers.custom]
name = "custom"
wire_api = "responses"
requires_openai_auth = true
base_url = "https://onlycode.shop/v1"

[features]
view_image_tool = true

编辑保存密钥的文件auth.json

vi auth.json

粘贴以下内容并保存:

json
{
  "OPENAI_API_KEY": "你的API密钥"
}

使用:

bash
codex

⚠️ API 密钥获取路径:onlycode.shop 登录 → 令牌管理 → 添加令牌。

3.5 异常情况处理

  1. 编辑完成上述两个文件的编辑后打开CodeX提示需要登录CodeX账户或者是依旧调用了别家的Base URL。 正常设置好Base URL和密钥后进入CodeX一般会提示是否信任在该文件夹的选择。如果遇到了需要登录账户/调用别家遗留的Base URL这种情况通常是写入的文件在环境变量中读取不到。先进行测试,验证你设置的两个值。 验证Base URL设置:
echo $OPENAI_BASE_URL

验证密钥设置:

echo $OPENAI_API_KEY

​ 如果没有任何输出/输出的项不为你根据文档设置的值,说明你文件的设置有误,先检查config.toml和auth.json中是 否保存了。如果确定保存了,你可以尝试使用命令行:

echo 'export OPENAI_BASE_URL="https://onlycode.shop/v1"' >> ~/.bash_profile
echo 'export OPENAI_API_KEY="你的API密钥"' >> ~/.bash_profile
source ~/.bash_profile

​ 注意:上述命令根据用户反馈,某些情况下需要手动编辑~/.bashrc才能使变量生效(常见于公司内网机器)

  1. 编辑好文件后使用CodeX一直提示重连中。 先检查当前网络是否能正常访问互联网。重连失败多次后会打印出报错信息,核对报错信息中的Base URL是否为https://onlycode.shop/v1 。如果是,那么再检查在上面的问题1中的两个文件是否正确保存了。注意在编辑完文件后,可能需要重启你的CodeX CLI/CodeX App/VScode/OpenCode等客户端。

4. 🤖VSCode

4.1 安装插件

在扩展中安装 Codex – OpenAI’s coding agent 或相关插件。同时你要确保已经编辑了C:\Users\你的用户名\.codex\路径下的下的config.toml和auth.json。(重要,可以查看前面Windows中如何进行的设置⚠️)

4.2 配置 settings.json (建议使用我们的快速配置工具而不是编辑文件)

打开 VSCode 的 settings.json 在文件末尾的空白区域加入:

json
"chatgpt.apiBase": "https://onlycode.shop/v1",
"chatgpt.config": {
  "preferred_auth_method": "你的API密钥"
}

➡️打开方式:Ctrl+Shift+P / Cmd+Shift+PPreferences: Open Settings (JSON)

如果不会在 settings.json文件中添加上述内容,可以问问AI或者使用我们发布的OnlyCode-CC进行快速配置。

⚠️ API 密钥获取路径:onlycode.shop 登录 → 令牌管理 → 添加令牌。

附录-1 在Claude Code中使用CodeX系列模型

部分用户可能更喜欢使用Claude Code,如果希望在Claude Code中使用CodeX模型,您可以前往模型广场中选择供应商为OpenAI且专门给Claude Code使用的模型。以下为Claude Code配置json的示例:

{
  "env": {
    "ANTHROPIC_AUTH_TOKEN": "你的密钥",
    "ANTHROPIC_BASE_URL": "https://onlycode.shop",
    "ANTHROPIC_MODEL": "gpt-5.4(xhigh)"
  }
}

5. 🚀快速配置Codex CLI/VScode (Windows)

5.1 确保您已经安装好了Codex

5.2 下载OnlyCode-CC并进行快速配置

  • 下载链接🔗,提取密码为:123456
  • 该软件为开源软件cc-switch精简而来,可以放心使用。如果您有顾虑,可以前往Github下载cc-switch进行完成该步骤。Linux用户和MacOS用户亦可下载cc-switch进行快速配置。
  • 填入你的令牌(API KEY),保存后重新进入Codex/VScode客户端即可。

6. 🤔常见问题与错误

6.1 为什么我的Codex/VSCode中没有XXX模型?

以gpt-5.4为例子,如果您没有该模型先尝试升级应用/插件到最新版本,接着,对于Codex CLI可以用命令:

codex --model gpt-5.4

对于VScode有: Codex – OpenAI’s coding agent插件➡️打开该插件➡️设置(Settings)➡️Codex设置(Codex settings)➡️打开"config.toml"(Open config.toml)➡️编辑并保存对应的模型➡️重启VScode。具体的例子为:

model_provider = "custom"
model = "gpt-5.4"
model_reasoning_effort = "xhigh"
disable_response_storage = true

[model_providers.custom]
name = "custom"
base_url = "https://onlycode.shop/v1"
wire_api = "responses"
requires_openai_auth = true

注意如果您的终端即使更新到了最新版本依旧没有XX模型,可以尝试登录一次自己的OA账户,可能可以解决该问题。该问题的本质是OpenAI没有在CLI全量推送XX模型,但是可以在文件中指定(如上例),不会影响最终的输出质量。

6.2 运行 codex 时提示 "不是内部或外部命令"

#检查 npm 全局安装路径,并确保该路径在 PATH 中,如果不在请打开系统环境变量设置,将 npm 全局路径添加到 Path 中。该路径通常为C:\Users\你的用户名\AppData\Roaming\npm
npm config get prefix
$env:Path

6.3 如何更新Codex CLI?

npm i -g @openai/codex --registry=https://registry.npmmirror.com

6.4 如何确切的知道我使用的是什么模型?

您可以尝试使用以下命令确认您当前调用模型的确切信息,我们以gpt-5.3-codex为例子:

Windows PowerShell

$env:RUST_LOG='codex_api::sse::responses=trace'; (codex exec --skip-git-repo-check -m gpt-5.3-codex "PING" 2>&1 | Select-String -Pattern '"model":"([^"]+)"').Matches.Groups[1].Value

Linux

RUST_LOG='codex_api::sse::responses=trace' codex exec --skip-git-repo-check -m gpt-5.3-codex "PING" 2>&1 | grep -oP '"model":"\K[^"]+' | head -n 1

MacOS

RUST_LOG='codex_api::sse::responses=trace' codex exec --skip-git-repo-check -m gpt-5.3-codex "PING" 2>&1 \ | perl -ne 'if (/"model":"([^"]+)"/) { print "$1\n"; exit }'

该命令从 response.created 事件中提取后端算力节点的真实模型标签,这个标签是后端路由的最终目的地,无法被 CLI 伪造。如果您发现与当前使用的模型(gpt-5.3-codex)不一致,那么这为OpenAI官方所为,详见github的相关讨论🔗

Made with ❤️ by OnlyCode Team