11# Codex 配置文档
22
33[ English] ( ./CODEX_README_EN.md ) | 中文 | [ Claude文档] ( ./README.md )
4- ( 当前文档为Codex配置介绍,查看Claude Code文档请点击右上角↗️查看)
4+ ** 当前文档为Codex配置介绍,查看Claude Code文档请点击右上角↗️查看**
55
66## 功能特性
77
88- 🔄 ** 一键切换** - 快速在不同 Codex AI 提供商之间切换
99- 🔐 ** 自动配置** - 自动更新 auth.json 和系统环境变量
10- - 📊 ** 延迟测试** - 测试所有提供商的网络延迟
10+ - 📊 ** 延迟测试** - 快速同时测试所有中转站延迟以及API配置的可用性
1111- 🎯 ** 自动优选** - 自动测试并切换到延迟最低的最优配置
1212- 🌍 ** 国际化支持** - 支持中文和英文界面语言切换
1313
1616### 1. 配置config.toml
1717
1818``` bash
19- # 查看当前配置路径(会显示默认路径)
20- ccapi cx set
21- # 或使用完整命令
22- ccapi codex set
23-
24- # 如果配置文件不在默认位置,可以设置自定义路径
25- ccapi cx set < path>
26- 例如: ccapi cx set ~ /.codex/config.toml
27-
28- # 也可以在 ~/.ccapi-config.json 中配置 Codex config路径
29- ` ` ` json5
30- {
31- " codexConfigPath" : " ~/.codex/config.toml"
32- }
33- ` ` `
19+ codex默认使用的配置文件是config.toml,默认路径在:
20+ 【windows】C:\U sers\A dministrator\. codex\c onfig.toml
21+ 【mac/linux】~/.codex/config.toml
3422
35- ** Codex官方默认配置config.toml路径 :**
23+ ** 注意:使用命令前需要在config.toml文件中配置 api_key 和 model (这两个属性非官方属性,仅ccapi使用) :**
3624
37- - macOS/Linux: ` ~/.codex/config.toml`
38- - Windows: ` %USERPROFILE%\. codex\c onfig.toml`
39-
40- ** 注意:使用切换命令前需要在config.toml文件中配置 api_key 和 models (这两个属性非官方属性,仅ccapi使用):**
41-
42- - api_key: 切换环境变量使用
43- - models: 数组格式,切换不同模型使用
25+ api_key: 数组格式,切换不同环境变量使用
26+ model: 数组格式,切换不同模型使用
4427
4528` ` ` toml
29+ 示例:
4630[model_providers.any]
4731name = " any"
4832base_url = " https://anyrouter.top/v1"
@@ -51,11 +35,27 @@ wire_api = "responses"
5135requires_openai_auth = true
5236
5337--需添加下面两项才可正常切换配置--
54- api_key = " your-api-key"
38+ api_key = [
39+ " your-api-key1" ,
40+ " your-api-key2"
41+ ]
5542models = [
5643 " gpt-5-codex" ,
5744 " gpt-5"
5845]
46+
47+ # 如果你的codex配置文件不在默认位置,可以设置自定义路径
48+ ccapi cx set < path>
49+ 例如: ccapi cx set ~ /.codex/config.toml
50+
51+ # 也可以在 ~/.ccapi-config.json 中配置 Codex config路径
52+ ` ` ` json5
53+ {
54+ " codexConfigPath" : " ~/.codex/config.toml"
55+ }
56+
57+ # 查看当前codex配置路径
58+ ccapi cx set
5959```
6060
6161### 2. 查看可用提供商
@@ -66,25 +66,21 @@ ccapi cx ls 或 ccapi codex ls
6666
6767### 3. 切换提供商
6868
69- 切换到指定的 Codex 提供商,可选择性地同时切换模型。
69+ 切换到指定的 Codex 提供商,可选择性地同时切换模型和api_key
7070
7171``` bash
72+ 注意切换的名称是model_providers后面的字段,比如[model_providers.any] 则是any,不是配置中的name字段
7273# 基本切换
73- ccapi cx use < 提供商名称>
74-
75- # 同时切换模型(使用第2个模型,模型索引从1开始)
76- ccapi cx use < 提供商名称> -m < 模型索引>
77-
78- # 切换到 any 提供商,使用默认模型(第1个)
7974ccapi cx use any
8075
81- # 切换到 any 提供商, 使用第2个模型
76+ # 切换模型 ( 使用第2个模型,索引从1开始)
8277ccapi cx use any -m 2
8378
84- # 1. 修改配置文件的 `model_provider` 字段为指定的提供商名称
85- # 2. 如果指定了 `-m`,同时修改 `model` 字段为对应的模型
86- # 3. 更新 `~/.codex/auth.json` 文件的 `OPENAI_API_KEY` 字段
87- # 4. 设置系统环境变量(使用提供商的 `env_key` 作为键名)
79+ # 切换api_key (使用第2个api_key,索引从1开始)
80+ ccapi cx use any -k 2
81+
82+ # 同时切换模型和api_key(使用第2个模型,第2个api_key,索引从1开始)
83+ ccapi cx use any -m 2 -k 2
8884```
8985
9086### 4. 测试提供商的URL延迟
@@ -93,10 +89,14 @@ ccapi cx use any -m 2
9389ccapi cx ping
9490```
9591
96- # ## 5. 测试提供商的API是否在Codex Cli中可用
92+ ### 5. 测试提供商的api_key在Codex Cli中的有效性
9793
9894``` bash
95+ # 测试所有的提供商的有效性
9996ccapi cx test
97+
98+ # 测试单个提供商的有效性
99+ ccapi cx test any
100100```
101101
102102### 6. 自动查找最优路线并切换配置
@@ -105,11 +105,68 @@ ccapi cx test
105105# 会先进行所有配置测试,然后选择最优的配置进行自动切换,默认以test命令测试的结果为基准切换
106106ccapi cx auto
107107
108+ # 以test结果为准进行切换(默认)
109+ ccapi cx auto -t
110+
108111# 以ping结果为准进行切换
109112ccapi cx auto -p
110113
111- # 以test结果为准进行切换(默认)
112- ccapi cx auto -t
114+ ```
115+
116+ ### 7. 更新检查
117+
118+ 程序自带版本检查,若npm发布新版则在使用过程中会进行更新提示,若不想要提示可在 ~ /.ccapi-config.json 文件中新增变量 update: false关闭
119+
120+ ``` bash
121+ # 自动更新 ccapi 到最新版本
122+ ccapi update
123+ ```
124+
125+ ### 8. 语言设置 (国际化)
126+
127+ 程序支持中英文双语界面,可以根据需要切换显示语言,默认中文:
128+
129+ ``` bash
130+ # 查看当前语言设置
131+ ccapi lang
132+
133+ # 切换为中文
134+ ccapi lang zh
135+
136+ # 切换为英文
137+ ccapi lang en
138+
139+ # 也可直接在配置文件修改 ~/.ccapi-config.json
140+ {
141+ " language" : " zh"
142+ }
143+ ```
144+
145+ ### 9. 完整的ccapi-config.json配置
146+
147+ 该文件是ccapi使用的配置文件,可在此进行选项配置,具体文件在 ~ /.ccapi-config.json。
148+
149+ ``` bash
150+ {
151+ # settings.json文件路径
152+ " settingsPath" : " ~/.claude/settings.json" ,
153+ # api配置文件路径
154+ " apiConfigPath" : " /Users/4xian/Desktop/api.json5" ,
155+ # codex配置文件路径(可选)
156+ " codexConfigPath" : " ~/.codex/config.toml" ,
157+ # ping命令超时时间
158+ " pingTimeout" : 30000,
159+ # test命令超时时间
160+ " testTimeout" : 100000,
161+ # ping、test命令返回结果显示
162+ " testResponse" : true,
163+ # 是否需要更新提示
164+ " update" : true,
165+ # 使用use命令时是否同步修改系统环境变量
166+ " useNoEnv" : true,
167+ # 界面语言设置 (zh: 中文, en: 英文)
168+ " language" : " zh"
169+ }
113170```
114171
115172## 常见问题
@@ -139,15 +196,15 @@ ccapi cx auto -t
139196name = " Provider 1"
140197base_url = " https://api.provider1.com/v1"
141198env_key = " provider1"
142- api_key = " key1"
143- models = [" model1" , " model2" ]
199+ api_key = [ " key1" ]
200+ model = [" model1" , " model2" ]
144201
145202[model_providers .provider2 ]
146203name = " Provider 2"
147204base_url = " https://api.provider2.com/v1"
148205env_key = " provider2"
149- api_key = " key2"
150- models = [" model3" , " model4" ]
206+ api_key = [ " key2" ]
207+ model = [" model3" , " model4" ]
151208```
152209
153210然后使用 ` ccapi -cx use provider1 ` 或 ` ccapi -cx use provider2 ` 切换。
0 commit comments