diff --git a/deploy/codex.md b/deploy/codex.md index d17fd8a..3b4e318 100644 --- a/deploy/codex.md +++ b/deploy/codex.md @@ -1,393 +1,283 @@ -# CodeX 部署指南 +# CodeX 部署指南 **企业级 AI 编码助手 - 完整部署手册** -资源| 地址 ----|--- -官方文档| [developers.openai.com/codex]() - -📋 前置要求 +| 资源 | 地址 | +| --- | --- | +| 官方文档 | [developers.openai.com/codex](https://developers.openai.com/codex/) | +| oneinai 控制台 | | -请先完成 [Node.js 环境安装]() 和 [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 +**1. 启动 CC-Switch 并切换到 Codex 标签** -验证安装:`codex --version` - -推荐使用 [CC-Switch 快速配置工具]() 进行图形化配置,简单快捷无需命令行操作。 - -### 配置步骤 - -**1\. 启动 CC-Switch 并切换到 Codex 标签** - - 1. 打开 CC-Switch 应用程序 - 2. 点击顶部的「Codex」标签页 - 3. 点击右上角橙色「+」按钮添加新配置 +1. 打开 CC-Switch 应用程序 +2. 点击顶部的「Codex」标签页 +3. 点击右上角橙色「+」按钮添加新配置 ![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令牌组) - 4. **Model** :选择 `gpt-5.4`(书写文档时最新模型为 5.4) - 5. **其他配置** :根据需求调整推理强度、网络访问等参数 - 6. 点击「保存」按钮 +| 配置项 | 说明 | +| --- | --- | +| **提供商名称** | 自定义名称,如「oneinai」 | +| **Base URL** | `https://api.oneinai.com/v1` | +| **API Key** | 在 [oneinai 控制台](https://api.oneinai.com/console/token) 创建的 CodeX 专用令牌(codex 令牌组) | +| **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` 文件 - * 可以添加多个提供商配置,随时切换 - * 切换配置后,关闭并重启 CodeX 即可生效 +> 💡 **提示** +> - CC-Switch 会自动创建 `~/.codex/config.toml` 和 `auth.json` 文件 +> - 可以添加多个提供商配置,随时切换 +> - 切换配置后,关闭并重启 CodeX 即可生效 -**3\. 启用配置并使用** +**3. 启用配置并使用** - 1. 在配置列表中找到刚创建的「IkunCoding」配置 - 2. 点击配置右侧的「当前使用」按钮 - 3. 配置会被标记为「当前使用」状态(绿色标签) - 4. 重启 CodeX,新配置即可生效 +1. 在配置列表中找到刚创建的「oneinai」配置 +2. 点击配置右侧的「当前使用」按钮 +3. 配置会被标记为「当前使用」状态(绿色标签) +4. 重启 CodeX,新配置即可生效 -**4\. 系统托盘快速切换** +**4. 系统托盘快速切换** CC-Switch 支持通过系统托盘快速切换 CodeX 配置: - * 右键点击系统托盘中的 CC-Switch 图标 - * 在菜单中选择 Codex 分类 - * 直接选择要切换到的配置 - * 配置立即生效,无需打开主界面 +- 右键点击系统托盘中的 CC-Switch 图标 +- 在菜单中选择 Codex 分类 +- 直接选择要切换到的配置 +- 配置立即生效,无需打开主界面 -⚠️ 注意事项 +> ⚠️ **注意事项** +> - 务必在 oneinai 平台创建「codex」令牌组的专用密钥 +> - CodeX 令牌与 Claude Code 令牌不通用 +> - 切换配置后需要重启 CodeX 才能生效 +> - 可在 CC-Switch 中测试 API 端点速度 - * 务必从 IkunCode 平台创建「codex」令牌组的专用密钥 - * CodeX 令牌与 Claude Code 令牌不通用 - * 切换配置后需要重启 CodeX 才能生效 - * 可在 CC-Switch 中测试 API 端点速度 +## ⌨️ 手动命令行配置 -## ⌨️ 手动命令行配置 +如果你不使用 CC-Switch,可以按照以下步骤手动配置 CodeX。 -如果您不使用 CC-Switch,可以按照以下步骤手动配置 CodeX。 +### 🖥️ Windows 平台 -### 🖥️ Windows 平台 - -#### 第一步:部署 CodeX 命令行工具 +#### 第一步:部署 CodeX 命令行工具 以管理员权限启动命令提示符或 PowerShell,执行: -powershell - - - npm install -g @openai/codex@latest - codex --version +```powershell +npm install -g @openai/codex@latest +codex --version +``` -1 -2 +#### 第二步:集成 oneinai API 服务 -#### 第二步:集成 IkunCoding API 服务 +**获取专属 API 凭证**: -**获取专属 API 凭证** : +1. 访问 [oneinai 控制台](https://api.oneinai.com/console/token) +2. 完成账户注册或登录 +3. 进入「API 密钥管理」模块 +4. 创建新密钥时务必选择「codex」令牌组 +5. 安全保存生成的 API Key - 1. 访问 IkunCoding 开发者控制台 - 2. 完成账户注册或执行登录操作 - 3. 导航至「API 密钥管理」模块 - 4. 创建新密钥时,务必选择「codex」令牌组 - 5. 安全保存生成的 API Key +> 🔐 **安全提醒** +> CodeX 要求使用独立的令牌组配置,与 Claude Code 令牌体系完全隔离。 -🔐 安全提醒 +**构建配置目录结构**: -CodeX 要求使用独立的令牌组配置,与 Claude Code 令牌体系完全隔离。 +```powershell +mkdir $env:USERPROFILE\.codex +cd $env:USERPROFILE\.codex +``` -**构建配置目录结构** : +**编写配置文件 `config.toml`**: -powershell - - - mkdir %USERPROFILE%\\.codex - cd %USERPROFILE%\\.codex +```toml +model_provider = "oneinai" +model = "gpt-5.4" +model_reasoning_effort = "xhigh" +disable_response_storage = true +approval_policy = "on-request" +sandbox_mode = "danger-full-access" +model_supports_reasoning_summaries = true -1 -2 +[model_providers.oneinai] +name = "oneinai" +base_url = "https://api.oneinai.com/v1" +wire_api = "responses" +requires_openai_auth = true +``` -**编写配置文件:config.toml** +**编写认证文件 `auth.json`**: -toml - - - model_provider = "IkunCoding" - model = "gpt-5.4" - model_reasoning_effort = "xhigh" - disable_response_storage = true - approval_policy = "on-request" - sandbox_mode = "danger-full-access" - model_supports_reasoning_summaries = true - - [model_providers.IkunCoding] - name = "ikun" - base_url = "https://api.oneinai.com/v1" - wire_api = "responses" - requires_openai_auth = true +```json +{ + "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌" +} +``` -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 +#### 第三步:初始化工作空间 -**编写认证文件:auth.json** +```powershell +mkdir my-codex-project +cd my-codex-project +codex +``` -json - - - { - "OPENAI_API_KEY": "此处粘贴您的 CodeX 专用令牌" - } +### 🍏 macOS 平台 -1 -2 -3 +#### 部署 CodeX 工具 -#### 第三步:初始化工作空间 +```bash +npm install -g @openai/codex@latest +codex --version +``` -powershell - - - mkdir my-codex-project - cd my-codex-project - codex +#### 集成 API 服务 -1 -2 -3 +**构建配置目录**: -### 🍏 macOS 平台 +```bash +mkdir -p ~/.codex +cd ~/.codex +``` -#### 部署 CodeX 工具 +**编写 `config.toml` 配置**: -bash - - - npm install -g @openai/codex@latest - codex --version +```bash +cat > config.toml << 'EOF' +model_provider = "oneinai" +model = "gpt-5.4" +model_reasoning_effort = "xhigh" +disable_response_storage = true +approval_policy = "on-request" +sandbox_mode = "danger-full-access" +model_supports_reasoning_summaries = true -1 -2 +[model_providers.oneinai] +name = "oneinai" +base_url = "https://api.oneinai.com/v1" +wire_api = "responses" +requires_openai_auth = true +EOF +``` -#### 集成 API 服务 +**编写 `auth.json` 认证配置**: -**构建配置目录** : +```bash +cat > auth.json << 'EOF' +{ + "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌" +} +EOF +``` -bash - - - mkdir -p ~/.codex - cd ~/.codex +#### 初始化工作空间 -1 -2 +```bash +mkdir my-codex-project +cd my-codex-project +codex +``` -**编写 config.toml 配置** : +### 🐧 Linux 平台 -bash - - - cat > config.toml << 'EOF' - model_provider = "IkunCoding" - model = "gpt-5.4" - model_reasoning_effort = "xhigh" - disable_response_storage = true - approval_policy = "on-request" - sandbox_mode = "danger-full-access" - model_supports_reasoning_summaries = true - - [model_providers.IkunCoding] - name = "ikun" - base_url = "https://api.oneinai.com/v1" - wire_api = "responses" - requires_openai_auth = true - EOF +#### 部署 CodeX 工具 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 +```bash +sudo npm install -g @openai/codex@latest +codex --version +``` -**编写 auth.json 认证配置** : +#### 集成 API 服务 -bash - - - cat > auth.json << 'EOF' - { - "OPENAI_API_KEY": "此处粘贴您的 CodeX 专用令牌" - } - EOF +**构建配置目录**: -1 -2 -3 -4 -5 +```bash +mkdir -p ~/.codex +cd ~/.codex +``` -#### 初始化工作空间 +**编写 `config.toml` 配置**: -bash - - - mkdir my-codex-project - cd my-codex-project - codex +```bash +cat > config.toml << 'EOF' +model_provider = "oneinai" +model = "gpt-5.4" +model_reasoning_effort = "xhigh" +disable_response_storage = true +approval_policy = "on-request" +sandbox_mode = "danger-full-access" +model_supports_reasoning_summaries = true -1 -2 -3 +[model_providers.oneinai] +name = "oneinai" +base_url = "https://api.oneinai.com/v1" +wire_api = "responses" +requires_openai_auth = true +EOF +``` -### 🐧 Linux 平台 +**编写 `auth.json` 认证配置**: -#### 部署 CodeX 工具 +```bash +cat > auth.json << 'EOF' +{ + "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌" +} +EOF +``` -bash - - - sudo npm install -g @openai/codex@latest - codex --version +#### 初始化工作空间 -1 -2 +```bash +mkdir my-codex-project +cd my-codex-project +codex +``` -#### 集成 API 服务 +## ❓ 常见问题 -**构建配置目录** : - -bash - - - mkdir -p ~/.codex - cd ~/.codex - -1 -2 - -**编写 config.toml 配置** : - -bash - - - cat > config.toml << 'EOF' - model_provider = "IkunCoding" - model = "gpt-5.4" - model_reasoning_effort = "xhigh" - disable_response_storage = true - approval_policy = "on-request" - sandbox_mode = "danger-full-access" - model_supports_reasoning_summaries = true - - [model_providers.IkunCoding] - name = "ikun" - base_url = "https://api.oneinai.com/v1" - wire_api = "responses" - requires_openai_auth = true - EOF - -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 - -**编写 auth.json 认证配置** : - -bash - - - cat > auth.json << 'EOF' - { - "OPENAI_API_KEY": "此处粘贴您的 CodeX 专用令牌" - } - EOF - -1 -2 -3 -4 -5 - -#### 初始化工作空间 - -bash - - - mkdir my-codex-project - cd my-codex-project - codex - -1 -2 -3 - -## 常见问题 - -### CodeX 和 Claude Code 的令牌不通用? +### CodeX 和 Claude Code 的令牌不通用? 是的,两者使用不同的令牌组: - * Claude Code: 使用 Claude Code 令牌组 - * CodeX: 使用 "codex" 令牌组 +- Claude Code:使用 Claude Code 令牌组 +- CodeX:使用 `codex` 令牌组 -请在 IkunCode 平台创建对应的专用令牌。 +请在 oneinai 平台创建对应的专用令牌。 -### 配置文件放在哪里? +### 配置文件放在哪里? - * Windows: `%USERPROFILE%\\.codex\\` - * macOS/Linux: `~/.codex/` +- Windows:`%USERPROFILE%\.codex\` +- macOS / Linux:`~/.codex/` -### 更多问题 +### 更多问题 -请查看 [FAQ]() 或联系[售后支持]()。 +请查看 [FAQ](/support/faq) 或联系[售后支持](/support/after-sales)。 diff --git a/guide/modify-token.md b/guide/modify-token.md index aa1793e..e81dc36 100644 --- a/guide/modify-token.md +++ b/guide/modify-token.md @@ -2,7 +2,7 @@ 创建 Key 后,您可以根据需要修改令牌的各项设置。 -![令牌设置页面](https://docs.ikuncode.cc/images/tu3_new.png) +![令牌设置页面](https://minio.oneinai.com/oneinai/images/docs/modify-token/modify-token01.png) ## 可修改的设置 diff --git a/guide/registration.md b/guide/registration.md index 8ea0710..54efc37 100644 --- a/guide/registration.md +++ b/guide/registration.md @@ -10,7 +10,7 @@ * 使用邮箱注册 * 使用第三方账号快捷注册 -![注册页面](https://docs.ikuncode.cc/images/tu1.png) +![注册页面](https://minio.oneinai.com/oneinai/images/docs/registration/registration01.png) ## 注册方式