zyc123/Aiapi-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

120

Browse Source
This commit is contained in:
zyc123 2026-05-14 14:00:39 +08:00
parent e9ecca01b0
commit a9ba2281cd
3 changed files with 202 additions and 312 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

328
deploy/codex.md
View File

@ -2,40 +2,36 @@
**企业级 AI 编码助手 - 完整部署手册** **企业级 AI 编码助手 - 完整部署手册**
资源| 地址 | 资源 | 地址 |
---|--- | --- | --- |
官方文档| [developers.openai.com/codex](<https://developers.openai.com/codex/>) | 官方文档 | [developers.openai.com/codex](https://developers.openai.com/codex/) |
| oneinai 控制台 | <https://api.oneinai.com/console/token> |
📋 前置要求 > 📋 **前置要求**
> 请先完成 [Node.js 环境安装](/node/windows) 和 [CC-Switch 工具安装](/tools/cc-switch)。
请先完成 [Node.js 环境安装](</node/windows>) 和 [CC-Switch 工具安装](</tools/cc-switch>)。
## 🎯 快速导航 ## 🎯 快速导航
CodeX 是基于 GPT-5 架构的下一代智能编程助手，为开发者提供卓越的代码生成与优化能力。 CodeX 是基于 GPT-5 架构的智能编程助手，为开发者提供卓越的代码生成与优化能力。
**部署路径**：系统环境配置 ➜ CLI 工具安装 ➜ API 集成 ➜ 开发环境就绪 **部署路径**：系统环境配置 ➜ CLI 工具安装 ➜ API 集成 ➜ 开发环境就绪
## 🚀 使用 CC-Switch 快速配置（推荐） ## 🚀 使用 CC-Switch 快速配置（推荐）
⚠️ 前置条件 > ⚠️ **前置条件**
> 使用 CC-Switch 配置 CodeX 之前，请确保已通过 npm 全局安装 CodeX 工具：
>
> ```bash
> npm install -g @openai/codex@latest
> ```
>
> 验证安装：`codex --version`
使用 CC-Switch 配置 CodeX 之前，请确保已通过 npm 全局安装 CodeX 工具： 推荐使用 [CC-Switch 快速配置工具](/tools/cc-switch) 进行图形化配置，简单快捷无需命令行操作。
bash
npm install -g @openai/codex@latest
1
验证安装：`codex --version`
推荐使用 [CC-Switch 快速配置工具](</tools/cc-switch>) 进行图形化配置，简单快捷无需命令行操作。
### 配置步骤 ### 配置步骤
**1\. 启动 CC-Switch 并切换到 Codex 标签** **1. 启动 CC-Switch 并切换到 Codex 标签**
1. 打开 CC-Switch 应用程序 1. 打开 CC-Switch 应用程序
2. 点击顶部的「Codex」标签页 2. 点击顶部的「Codex」标签页
@ -43,49 +39,51 @@ bash
![CC-Switch Codex 标签页](https://minio.oneinai.com/oneinai/images/docs/codex/codex01.png) ![CC-Switch Codex 标签页](https://minio.oneinai.com/oneinai/images/docs/codex/codex01.png)
**2\. 填写 CodeX 提供商配置** **2. 填写 CodeX 提供商配置**
1. **提供商名称** ：自定义名称（如「IkunCoding」） | 配置项 | 说明 |
2. **Base URL** ：输入 `https://api.oneinai.com/v1` | --- | --- |
3. **API Key** ：粘贴您从 IkunCode 平台获取的 CodeX 专用令牌（codex令牌组） | **提供商名称** | 自定义名称，如「oneinai」 |
4. **Model** ：选择 `gpt-5.4`（书写文档时最新模型为 5.4） | **Base URL** | `https://api.oneinai.com/v1` |
5. **其他配置** ：根据需求调整推理强度、网络访问等参数 | **API Key** | 在 [oneinai 控制台](https://api.oneinai.com/console/token) 创建的 CodeX 专用令牌（codex 令牌组） |
6. 点击「保存」按钮 | **Model** | `gpt-5.4`（撰写文档时最新模型为 5.4） |
| **其他配置** | 根据需求调整推理强度、网络访问等参数 |
![CC-Switch 添加 CodeX 配置](https://minio.oneinai.com/oneinai/images/docs/codex/codex02.png)![CC-Switch CodeX 配置详情](https://minio.oneinai.com/oneinai/images/docs/codex/codex03.png) 填写完成后点击「保存」按钮。
💡 提示 ![CC-Switch 添加 CodeX 配置](https://minio.oneinai.com/oneinai/images/docs/codex/codex02.png)
![CC-Switch CodeX 配置详情](https://minio.oneinai.com/oneinai/images/docs/codex/codex03.png)
* CC-Switch 会自动创建 `~/.codex/config.toml` 和 `auth.json` 文件 > 💡 **提示**
* 可以添加多个提供商配置，随时切换 > - CC-Switch 会自动创建 `~/.codex/config.toml` 和 `auth.json` 文件
* 切换配置后，关闭并重启 CodeX 即可生效 > - 可以添加多个提供商配置，随时切换
> - 切换配置后，关闭并重启 CodeX 即可生效
**3\. 启用配置并使用** **3. 启用配置并使用**
1. 在配置列表中找到刚创建的「IkunCoding」配置 1. 在配置列表中找到刚创建的「oneinai」配置
2. 点击配置右侧的「当前使用」按钮 2. 点击配置右侧的「当前使用」按钮
3. 配置会被标记为「当前使用」状态（绿色标签） 3. 配置会被标记为「当前使用」状态（绿色标签）
4. 重启 CodeX，新配置即可生效 4. 重启 CodeX，新配置即可生效
**4\. 系统托盘快速切换** **4. 系统托盘快速切换**
CC-Switch 支持通过系统托盘快速切换 CodeX 配置： CC-Switch 支持通过系统托盘快速切换 CodeX 配置：
* 右键点击系统托盘中的 CC-Switch 图标 - 右键点击系统托盘中的 CC-Switch 图标
* 在菜单中选择 Codex 分类 - 在菜单中选择 Codex 分类
* 直接选择要切换到的配置 - 直接选择要切换到的配置
* 配置立即生效，无需打开主界面 - 配置立即生效，无需打开主界面
⚠️ 注意事项 > ⚠️ **注意事项**
> - 务必在 oneinai 平台创建「codex」令牌组的专用密钥
* 务必从 IkunCode 平台创建「codex」令牌组的专用密钥 > - CodeX 令牌与 Claude Code 令牌不通用
* CodeX 令牌与 Claude Code 令牌不通用 > - 切换配置后需要重启 CodeX 才能生效
* 切换配置后需要重启 CodeX 才能生效 > - 可在 CC-Switch 中测试 API 端点速度
* 可在 CC-Switch 中测试 API 端点速度
## ⌨️ 手动命令行配置 ## ⌨️ 手动命令行配置
如果您不使用 CC-Switch，可以按照以下步骤手动配置 CodeX。 如果你不使用 CC-Switch，可以按照以下步骤手动配置 CodeX。
### 🖥️ Windows 平台 ### 🖥️ Windows 平台
@ -93,46 +91,35 @@ CC-Switch 支持通过系统托盘快速切换 CodeX 配置：
以管理员权限启动命令提示符或 PowerShell，执行： 以管理员权限启动命令提示符或 PowerShell，执行：
powershell ```powershell
npm install -g @openai/codex@latest npm install -g @openai/codex@latest
codex --version codex --version
```
1 #### 第二步：集成 oneinai API 服务
2
#### 第二步：集成 IkunCoding API 服务
**获取专属 API 凭证**： **获取专属 API 凭证**：
1. 访问 IkunCoding 开发者控制台 1. 访问 [oneinai 控制台](https://api.oneinai.com/console/token)
2. 完成账户注册或执行登录操作 2. 完成账户注册或登录
3. 导航至「API 密钥管理」模块 3. 进入「API 密钥管理」模块
4. 创建新密钥时，务必选择「codex」令牌组 4. 创建新密钥时务必选择「codex」令牌组
5. 安全保存生成的 API Key 5. 安全保存生成的 API Key
🔐 安全提醒 > 🔐 **安全提醒**
> CodeX 要求使用独立的令牌组配置，与 Claude Code 令牌体系完全隔离。
CodeX 要求使用独立的令牌组配置，与 Claude Code 令牌体系完全隔离。
**构建配置目录结构**： **构建配置目录结构**：
powershell ```powershell
mkdir $env:USERPROFILE\.codex
cd $env:USERPROFILE\.codex
```
**编写配置文件 `config.toml`**：
mkdir %USERPROFILE%\\.codex ```toml
cd %USERPROFILE%\\.codex model_provider = "oneinai"
1
2
**编写配置文件：config.toml**
toml
model_provider = "IkunCoding"
model = "gpt-5.4" model = "gpt-5.4"
model_reasoning_effort = "xhigh" model_reasoning_effort = "xhigh"
disable_response_storage = true disable_response_storage = true
@ -140,85 +127,52 @@ toml
sandbox_mode = "danger-full-access" sandbox_mode = "danger-full-access"
model_supports_reasoning_summaries = true model_supports_reasoning_summaries = true
[model_providers.IkunCoding] [model_providers.oneinai]
name = "ikun" name = "oneinai"
base_url = "https://api.oneinai.com/v1" base_url = "https://api.oneinai.com/v1"
wire_api = "responses" wire_api = "responses"
requires_openai_auth = true requires_openai_auth = true
```
1 **编写认证文件 `auth.json`**：
2
3
4
5
6
7
8
9
10
11
12
13
**编写认证文件：auth.json**
json
```json
{ {
"OPENAI_API_KEY": "此处粘贴您的 CodeX 专用令牌" "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌"
} }
```
1
2
3
#### 第三步：初始化工作空间 #### 第三步：初始化工作空间
powershell ```powershell
mkdir my-codex-project mkdir my-codex-project
cd my-codex-project cd my-codex-project
codex codex
```
1
2
3
### 🍏 macOS 平台 ### 🍏 macOS 平台
#### 部署 CodeX 工具 #### 部署 CodeX 工具
bash ```bash
npm install -g @openai/codex@latest npm install -g @openai/codex@latest
codex --version codex --version
```
1
2
#### 集成 API 服务 #### 集成 API 服务
**构建配置目录**： **构建配置目录**：
bash ```bash
mkdir -p ~/.codex mkdir -p ~/.codex
cd ~/.codex cd ~/.codex
```
1 **编写 `config.toml` 配置**：
2
**编写 config.toml 配置** ：
bash
```bash
cat > config.toml << 'EOF' cat > config.toml << 'EOF'
model_provider = "IkunCoding" model_provider = "oneinai"
model = "gpt-5.4" model = "gpt-5.4"
model_reasoning_effort = "xhigh" model_reasoning_effort = "xhigh"
disable_response_storage = true disable_response_storage = true
@ -226,92 +180,55 @@ bash
sandbox_mode = "danger-full-access" sandbox_mode = "danger-full-access"
model_supports_reasoning_summaries = true model_supports_reasoning_summaries = true
[model_providers.IkunCoding] [model_providers.oneinai]
name = "ikun" name = "oneinai"
base_url = "https://api.oneinai.com/v1" base_url = "https://api.oneinai.com/v1"
wire_api = "responses" wire_api = "responses"
requires_openai_auth = true requires_openai_auth = true
EOF EOF
```
1 **编写 `auth.json` 认证配置**：
2
3
4
5
6
7
8
9
10
11
12
13
14
15
**编写 auth.json 认证配置** ：
bash
```bash
cat > auth.json << 'EOF' cat > auth.json << 'EOF'
{ {
"OPENAI_API_KEY": "此处粘贴您的 CodeX 专用令牌" "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌"
} }
EOF EOF
```
1
2
3
4
5
#### 初始化工作空间 #### 初始化工作空间
bash ```bash
mkdir my-codex-project mkdir my-codex-project
cd my-codex-project cd my-codex-project
codex codex
```
1
2
3
### 🐧 Linux 平台 ### 🐧 Linux 平台
#### 部署 CodeX 工具 #### 部署 CodeX 工具
bash ```bash
sudo npm install -g @openai/codex@latest sudo npm install -g @openai/codex@latest
codex --version codex --version
```
1
2
#### 集成 API 服务 #### 集成 API 服务
**构建配置目录**： **构建配置目录**：
bash ```bash
mkdir -p ~/.codex mkdir -p ~/.codex
cd ~/.codex cd ~/.codex
```
1 **编写 `config.toml` 配置**：
2
**编写 config.toml 配置** ：
bash
```bash
cat > config.toml << 'EOF' cat > config.toml << 'EOF'
model_provider = "IkunCoding" model_provider = "oneinai"
model = "gpt-5.4" model = "gpt-5.4"
model_reasoning_effort = "xhigh" model_reasoning_effort = "xhigh"
disable_response_storage = true disable_response_storage = true
@ -319,75 +236,48 @@ bash
sandbox_mode = "danger-full-access" sandbox_mode = "danger-full-access"
model_supports_reasoning_summaries = true model_supports_reasoning_summaries = true
[model_providers.IkunCoding] [model_providers.oneinai]
name = "ikun" name = "oneinai"
base_url = "https://api.oneinai.com/v1" base_url = "https://api.oneinai.com/v1"
wire_api = "responses" wire_api = "responses"
requires_openai_auth = true requires_openai_auth = true
EOF EOF
```
1 **编写 `auth.json` 认证配置**：
2
3
4
5
6
7
8
9
10
11
12
13
14
15
**编写 auth.json 认证配置** ：
bash
```bash
cat > auth.json << 'EOF' cat > auth.json << 'EOF'
{ {
"OPENAI_API_KEY": "此处粘贴您的 CodeX 专用令牌" "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌"
} }
EOF EOF
```
1
2
3
4
5
#### 初始化工作空间 #### 初始化工作空间
bash ```bash
mkdir my-codex-project mkdir my-codex-project
cd my-codex-project cd my-codex-project
codex codex
```
1 ## ❓ 常见问题
2
3
## 常见问题
### CodeX 和 Claude Code 的令牌不通用？ ### CodeX 和 Claude Code 的令牌不通用？
是的，两者使用不同的令牌组： 是的，两者使用不同的令牌组：
* Claude Code: 使用 Claude Code 令牌组 - Claude Code：使用 Claude Code 令牌组
* CodeX: 使用 "codex" 令牌组 - CodeX：使用 `codex` 令牌组
请在 IkunCode 平台创建对应的专用令牌。 请在 oneinai 平台创建对应的专用令牌。
### 配置文件放在哪里？ ### 配置文件放在哪里？
* Windows: `%USERPROFILE%\\.codex\\` - Windows：`%USERPROFILE%\.codex\`
* macOS/Linux: `~/.codex/` - macOS / Linux：`~/.codex/`
### 更多问题 ### 更多问题
请查看 [FAQ](</support/faq>) 或联系[售后支持](</support/after-sales>)。 请查看 [FAQ](/support/faq) 或联系[售后支持](/support/after-sales)。

2
guide/modify-token.md
View File

@ -2,7 +2,7 @@
创建 Key 后，您可以根据需要修改令牌的各项设置。 创建 Key 后，您可以根据需要修改令牌的各项设置。
![令牌设置页面](https://docs.ikuncode.cc/images/tu3_new.png) ![令牌设置页面](https://minio.oneinai.com/oneinai/images/docs/modify-token/modify-token01.png)
## 可修改的设置 ## 可修改的设置

2
guide/registration.md
View File

@ -10,7 +10,7 @@
* 使用邮箱注册 * 使用邮箱注册
* 使用第三方账号快捷注册 * 使用第三方账号快捷注册
![注册页面](https://docs.ikuncode.cc/images/tu1.png) ![注册页面](https://minio.oneinai.com/oneinai/images/docs/registration/registration01.png)
## 注册方式 ## 注册方式