lixin/vitepress
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: 移除死链接，修复构建错误

Browse Source 
- 删除已废弃的 skills 页面（ikuncode-aimcp, ikunimage）
- 删除售后页面并清理所有引用
- 修复 nano-banana.md 中 /skills/oneimage 死链接
- 修复 opencode.md 中损坏的图片路径

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
shihao 2026-05-15 18:07:58 +08:00
parent 16c6279484
commit 3afad1525c
29 changed files with 2590 additions and 3728 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.claude/settings.local.json Normal file
View File

@ -0,0 +1,16 @@
{
"permissions": {
"allow": [
"Bash(git init *)",
"Bash(git remote *)",
"Bash(npm run *)",
"Bash(git *)",
"Bash(echo \"exit: $?\")",
"Bash(sed -i 's|\\\\[售后支持\\\\]\\(/support/after-sales\\)|售后支持|g' apidoc/apps/opencode.md apidoc/apps/openclaw.md apidoc/apps/alma.md apidoc/deploy/claude-code.md apidoc/deploy/codex.md apidoc/deploy/gemini-cli.md apidoc/intro/overview.md)",
"Bash(sed -i 's|\\\\[售后支持\\\\]\\(</support/after-sales>\\)|售后支持|g' apidoc/apps/opencode.md apidoc/apps/alma.md apidoc/intro/overview.md)",
"Bash(sed -i 's|\\\\[售前售后\\\\]\\(</support/after-sales>\\)|售前售后|g' apidoc/support/troubleshooting.md apidoc/guide/recharge.md apidoc/intro/welcome.md)",
"Bash(sed -i 's|\\\\[售前售后\\\\]\\(/support/after-sales\\)|售前售后|g' apidoc/support/faq.md)",
"Bash(sed -i 's|- \\\\[售后支持\\\\]\\(/support/after-sales\\)||g' apidoc/apps/cherry-studio.md)"
]
}
}

8
apidoc/.vitepress/config.mts
View File

@ -91,18 +91,10 @@ export default defineConfig({
{ text: 'Claude Code Hub', link: '/tools/claude-code-hub' }, { text: 'Claude Code Hub', link: '/tools/claude-code-hub' },
] ]
}, },
{
text: '技能',
items: [
{ text: 'IkunCode AI MCP', link: '/skills/ikuncode-aimcp' },
{ text: 'IkunImage', link: '/skills/ikunimage' },
]
},
{ {
text: '支持', text: '支持',
items: [ items: [
{ text: 'FAQ', link: '/support/faq' }, { text: 'FAQ', link: '/support/faq' },
{ text: '售后', link: '/support/after-sales' },
{ text: '故障排查', link: '/support/troubleshooting' }, { text: '故障排查', link: '/support/troubleshooting' },
] ]
}, },

3
apidoc/apps/alma.md
View File

@ -1,3 +1,4 @@
# Alma 客户端配置指南 # Alma 客户端配置指南
**功能强大的 AI 编程客户端工具** **功能强大的 AI 编程客户端工具**
@ -146,7 +147,7 @@ Alma 提供以下强大功能：
### 更多问题 ### 更多问题
请查看 [FAQ](</support/faq>) 或联系[售后支持](</support/after-sales>)。 请查看 [FAQ](</support/faq>)
## ✅ 完成 ## ✅ 完成

309
apidoc/apps/cherry-studio.md
View File

@ -2,267 +2,280 @@
**全能的 AI 助手桌面客户端** **全能的 AI 助手桌面客户端**
> **官方网站** ：<https://www.cherry-ai.com/>**下载地址** ：<https://www.cherry-ai.com/download> | 资源 | 地址 |
|------|------|
| 官方网站 | [cherry-ai.com](https://www.cherry-ai.com/) |
| 下载地址 | [cherry-ai.com/download](https://www.cherry-ai.com/download) |
| oneinAI 控制台 | [api.oneinai.com/console/token](https://api.oneinai.com/console/token) |
📋 简介 ## 📋 简介
CherryStudio 是一款功能强大的 AI 助手桌面应用，支持多种主流 AI 模型（Claude、Gemini、GPT 等），为开发者和用户提供统一的 AI 交互界面。本教程将指导你如何配置 CherryStudio 接入 IkunCode 平台。 CherryStudio 是一款功能强大的 AI 助手桌面应用，支持 Claude、Gemini、GPT 等主流 AI 模型，为开发者和用户提供统一的 AI 交互界面。本教程将指导你如何配置 CherryStudio 接入 **oneinAI** 平台。
## ✨ 功能特点 ## ✨ 功能特点
CherryStudio 提供以下强大功能： - ✅ **多模型支持**：Claude、Gemini、GPT 等主流 AI 模型
- ✅ **统一界面**：一个应用管理所有 AI 服务
- ✅ **自定义 API**：支持接入自定义 API 提供商
- ✅ **跨平台**：支持 Windows、macOS、Linux
- ✅ **本地优先**：数据存储在本地，保护隐私
- ✅ **丰富功能**：对话管理、模型切换、参数调整等
* ✅ **多模型支持** ：支持 Claude、Gemini、GPT 等主流 AI 模型 ## 📋 配置快速参考
* ✅ **统一界面** ：一个应用管理所有 AI 服务
* ✅ **自定义 API** ：支持接入自定义 API 提供商 | 模型 | 提供商类型 | API 地址 | 令牌组 |
* ✅ **跨平台** ：支持 Windows、macOS、Linux |------|-----------|---------|--------|
* ✅ **本地优先** ：数据存储在本地，保护隐私 | Claude | `Anthropic` | `https://api.oneinai.com` | Claude 分组 |
* ✅ **丰富功能** ：对话管理、模型切换、参数调整等 | Gemini | `Gemini` | `https://api.oneinai.com/v1beta/models` | Gemini 分组 |
---
## 🛠️ 安装步骤 ## 🛠️ 安装步骤
### 第一步：下载安装 CherryStudio ### 第一步：下载安装 CherryStudio
1. 访问 [CherryStudio 下载页面](<https://www.cherry-ai.com/download>) 1. 访问 [CherryStudio 下载页面](https://www.cherry-ai.com/download)
2. 根据你的操作系统选择对应的安装包：
- **Windows**：下载 `.exe` 安装程序
- **macOS**：下载 `.dmg` 镜像文件
- **Linux**：下载 `.AppImage` 或 `.deb` 包
3. 下载完成后，按照系统提示完成安装
2. 根据你的操作系统选择对应的安装包： > 💡 **macOS 用户注意**
> 如果提示"无法打开，因为它来自身份不明的开发者"，请在系统偏好设置 → 安全性与隐私中允许打开。
* **Windows** ：下载 `.exe` 安装程序 ### 第二步：获取 oneinAI API Key
* **macOS** ：下载 `.dmg` 镜像文件
* **Linux** ：下载 `.AppImage` 或 `.deb` 包
3. 下载完成后，按照系统提示完成安装
💡 macOS 用户注意 在配置 CherryStudio 之前，需要先从 oneinAI 平台获取 API Key：
如果提示"无法打开，因为它来自身份不明的开发者"，请在系统偏好设置 → 安全性与隐私中允许打开。 1. 访问 [oneinAI 控制台](https://api.oneinai.com/console/token)
2. 登录你的账户
3. 根据需要创建对应的令牌组：
- **Claude 模型**：选择 Claude 分组
- **Gemini 模型**：选择 Gemini 分组
4. 保存生成的 API Key（请妥善保管，不要泄露）
### 第二步：获取 OneinAI API Key ![创建 API Key](https://minio.oneinai.com/oneinai/images/docs/cherrystudio/cherrystudio01.png)
在配置 CherryStudio 之前，需要先从 IkunCode 平台获取 API Key： > ⚠️ Claude 和 Gemini 的 API Key 必须使用**不同的令牌组**，两者不能通用。
1. 访问 [OneinAI 控制台](<https://api.oneinai.com/console/token>) ---
2. 登录你的账户
3. 根据需要创建对应的令牌组：
* **Claude 模型** ：选择 Claude分组
* **Gemini 模型** ：选择 Gemini分组
![Claude](https://minio.oneinai.com/oneinai/images/docs/cherrystudio/cherrystudio01.png)
4. 保存生成的 API Key
📋 配置快速参考
模型| 提供商类型| API 地址| 令牌组
---|---|---|---
Claude| `Anthropic`| `https://api.oneinai.com/v1/messages`| Claude分组
Gemini| `Gemini`| `https://api.oneinai.com/v1beta/models`| Gemini分组
## 🔧 配置 Claude 模型 ## 🔧 配置 Claude 模型
### 第一步：进入设置页面 ### 第一步：进入设置页面
1. 打开 CherryStudio 应用 1. 打开 CherryStudio 应用
2. 点击左下角的「设置」或「偏好设置」 2. 点击左下角的「设置」或「偏好设置」
3. 选择「模型配置」或「API 配置」选项 3. 选择「模型配置」或「API 配置」选项
### 第二步：选择 Claude 模型类型 ### 第二步：选择 Claude 模型类型
![Claude 类型选择](https://docs.ikuncode.cc/images/apps/CherryStudio/claudeleixing.png) ![Claude 类型选择](https://minio.oneinai.com/oneinai/images/docs/cherrystudio/cherrystudio02.png)
在模型列表中选择你需要的 Claude 模型 在模型列表中选择你需要的 Claude 模型。
### 第三步：配置 Claude API ### 第三步：配置 Claude API
在 Claude 配置界面中填写以下信息： 在 Claude 配置界面中填写以下信息：
![Claude 配置界面](https://docs.ikuncode.cc/images/apps/CherryStudio/claude.png) ![Claude 配置界面](https://minio.oneinai.com/oneinai/images/docs/cherrystudio/cherrystudio03.png)
**配置参数** ： **配置参数：**
* **提供商类型** ：选择 `Anthropic` | 字段 | 填写内容 |
* **API 地址** ：`https://api.oneinai.com` |------|---------|
* **API Key** ：粘贴你从 [IkunCode 控制台](<https://api.oneinai.com/console/token>) 获取的 Claude API Key | 提供商类型 | `Anthropic` |
* **模型名称** ：输入上一步选择的模型名称（如 `claude-sonnet-4-6`） | API 地址 | `https://api.oneinai.com` |
| API Key | 从 [oneinAI 控制台](https://api.oneinai.com/console/token) 获取的 Claude API Key |
| 模型名称 | 例如 `claude-sonnet-4-6`、`claude-opus-4-5-20251101` |
---
## 🔧 配置 Gemini 模型 ## 🔧 配置 Gemini 模型
### 第一步：选择 Gemini 模型类型 ### 第一步：选择 Gemini 模型类型
![Gemini 类型选择](https://docs.ikuncode.cc/images/apps/CherryStudio/geminileixing.png) ![Gemini 类型选择](https://minio.oneinai.com/oneinai/images/docs/cherrystudio/cherrystudio04.png)
在模型列表中选择你需要的 Gemini 模型： 在模型列表中选择你需要的 Gemini 模型：
* **Gemini 3 Flash Preview** ：`gemini-3-flash-preview` \- 最新版本，速度快，性能优秀（推荐） - **Gemini 3 Flash Preview**：`gemini-3-flash-preview` — 最新版本，速度快，性能优秀（推荐）
* **Gemini 3 Pro Preview** ：`gemini-3-pro-preview` \- 高性能，适合复杂任务 - **Gemini 3 Pro Preview**：`gemini-3-pro-preview` — 高性能，适合复杂任务
* **Gemini 2.0 Flash** ：快速响应，适合简单对话 - **Gemini 2.0 Flash**：快速响应，适合简单对话
⚠️ 注意
* Gemini 和 Claude 需要使用不同的 API Key（不同的令牌组）
* 确保你在 IkunCode 平台创建了对应的令牌组
### 第二步：配置 Gemini API ### 第二步：配置 Gemini API
在 Gemini 配置界面中填写以下信息： 在 Gemini 配置界面中填写以下信息：
![Gemini 配置界面](https://docs.ikuncode.cc/images/apps/CherryStudio/gemini.png) ![Gemini 配置界面](https://minio.oneinai.com/oneinai/images/docs/cherrystudio/cherrystudio05.png)
**配置参数** ： **配置参数：**
* **提供商类型** ：选择 `Gemini` | 字段 | 填写内容 |
* **API 地址** ：`https://api.oneinai.com/v1beta/models` |------|---------|
* **API Key** ：粘贴你从 [IkunCode 控制台](<https://api.oneinai.com/console/token>) 获取的 Gemini API Key | 提供商类型 | `Gemini` |
* **模型名称** ：输入上一步选择的模型名称（如 `gemini-3-flash-preview`） | API 地址 | `https://api.oneinai.com/v1beta/models` |
| API Key | 从 [oneinAI 控制台](https://api.oneinai.com/console/token) 获取的 Gemini API Key |
| 模型名称 | 例如 `gemini-3-flash-preview` |
> ⚠️ **注意**：Gemini 和 Claude 需要使用不同的 API Key（不同的令牌组），确保你在 oneinAI 平台已创建对应的令牌组。
---
## 💬 开始使用 ## 💬 开始使用
### 创建新对话 ### 创建新对话
1. 点击「新建对话」或「New Chat」按钮 1. 点击「新建对话」或「New Chat」按钮
2. 在模型选择器中选择已配置的模型 2. 在模型选择器中选择已配置的模型
3. 开始与 AI 对话 3. 开始与 AI 对话
### 切换模型 ### 切换模型
在对话过程中，你可以随时切换不同的模型： 在对话过程中，你可以随时切换不同的模型：
1. 点击顶部的模型选择器 1. 点击顶部的模型选择器
2. 选择其他已配置的模型 2. 选择其他已配置的模型
3. 继续对话（上下文可能会保留或重置，取决于应用设置） 3. 继续对话（上下文可能会保留或重置，取决于应用设置）
### 调整参数 ### 调整参数
CherryStudio 通常支持调整以下参数： CherryStudio 通常支持调整以下参数：
* **Temperature** （温度）：控制回复的随机性（0-1） - **Temperature**（温度）：控制回复的随机性（0-1）
* **Max Tokens** （最大令牌数）：控制回复长度 - **Max Tokens**（最大令牌数）：控制回复长度
* **Top P** ：控制采样范围 - **Top P**：控制采样范围
💡 参数建议 > 💡 **参数建议**
> - 编程任务：Temperature `0.2-0.5`（更准确）
> - 创意写作：Temperature `0.7-0.9`（更有创意）
> - 日常对话：Temperature `0.5-0.7`（平衡）
* 编程任务：Temperature 0.2-0.5（更准确） ---
* 创意写作：Temperature 0.7-0.9（更有创意）
* 日常对话：Temperature 0.5-0.7（平衡）
## 🎯 最佳实践 ## 🎯 最佳实践
### 1\. 合理选择模型 ### 1. 合理选择模型
不同任务使用不同模型： 不同任务使用不同模型：
* **代码编写** ：Claude Sonnet 4.5（`claude-sonnet-4-5-20250929`） | 任务类型 | 推荐模型 | 模型标识 |
* **快速对话** ：Gemini 3 Flash Preview（`gemini-3-flash-preview`） |---------|---------|---------|
* **复杂推理** ：Claude Opus 4.5（`claude-opus-4-5-20251101`） | 代码编写 | Claude Sonnet 4.5 | `claude-sonnet-4-5-20250929` |
* **多模态任务** ：Gemini 3 Pro Preview（支持图片） | 快速对话 | Gemini 3 Flash Preview | `gemini-3-flash-preview` |
| 复杂推理 | Claude Opus 4.5 | `claude-opus-4-5-20251101` |
| 多模态（图片） | Gemini 3 Pro Preview | `gemini-3-pro-preview` |
### 2\. 管理 API 使用 ### 2. 管理 API 使用
* 定期检查 [IkunCode 控制台](<https://api.oneinai.com/console/token>) 的余额 - 定期检查 [oneinAI 控制台](https://api.oneinai.com/console/token) 的余额
* 为不同用途创建不同的 API Key - 为不同用途创建不同的 API Key，便于管理和审计
* 避免在公共场合泄露 API Key - 避免在公共场合或代码仓库中泄露 API Key
### 3\. 优化对话体验 ### 3. 优化对话体验
* 使用清晰的提示词 - 使用清晰、具体的提示词
* 合理设置上下文长度 - 合理设置上下文长度，避免过长影响响应速度
* 善用对话历史管理功能 - 善用对话历史管理功能，及时归档或清理
---
## 🔍 与其他客户端的对比 ## 🔍 与其他客户端的对比
特性| CherryStudio| Alma| Hapi | 特性 | CherryStudio | Alma | Hapi |
---|---|---|--- |------|:------------:|:----:|:----:|
界面类型| 桌面应用| 桌面应用| Web/PWA | 界面类型 | 桌面应用 | 桌面应用 | Web/PWA |
多模型支持| ✅| ✅| ✅ | 多模型支持 | ✅ | ✅ | ✅ |
代码编辑| 部分支持| ✅| ✅ | 代码编辑 | 部分支持 | ✅ | ✅ |
终端集成| ❌| ✅| ✅ | 终端集成 | ❌ | ✅ | ✅ |
远程访问| ❌| ❌| ✅ | 远程访问 | ❌ | ❌ | ✅ |
学习曲线| 低| 中| 中 | 学习曲线 | 低 | 中 | 中 |
**选择建议** ： **选择建议：**
* **纯对话需求** ：CherryStudio（界面简洁，易上手） - **纯对话需求**：CherryStudio（界面简洁，易上手）
* **编程开发** ：Alma 或 Hapi（功能更强大） - **编程开发**：Alma 或 Hapi（功能更强大）
* **远程控制** ：Hapi（独有功能） - **远程控制**：Hapi（独有功能）
## 常见问题 ---
## ❓ 常见问题
### 提示 API Key 无效？ ### 提示 API Key 无效？
**可能原因** ： **可能原因：**
* API Key 输入错误 - API Key 输入错误或前后有空格
* 令牌组选择错误（只允许逆向分组的 Key 不能用于 Gemini） - 令牌组选择错误（Claude 的 Key 不能用于 Gemini，反之亦然）
* 余额不足 - 账户余额不足
**解决方法** ： **解决方法：**
1. 检查 API Key 是否完整复制 1. 重新复制 API Key，确保完整且无多余空格
2. 确认在 [IkunCode 控制台](<https://api.oneinai.com/console/token>) 创建了正确的令牌组（Claude 用 只允许逆向分组，Gemini 用 gemini分组） 2. 在 [oneinAI 控制台](https://api.oneinai.com/console/token) 确认创建了正确的令牌组
3. 查看账户余额是否充足 3. 查看账户余额是否充足
### 模型列表为空？ ### 模型列表为空？
**可能原因** ： **可能原因：**
* Base URL 配置错误 - Base URL 配置错误
* 网络连接问题 - 网络连接问题
* API Key 权限不足 - API Key 权限不足
**解决方法** ： **解决方法：**
1. 确认 Claude 的 API 地址为 `https://api.oneinai.com/v1/messages` 1. 确认 Claude 的 API 地址为 `https://api.oneinai.com`
2. 确认 Gemini 的 API 地址为 `https://api.oneinai.com/v1beta/models` 2. 确认 Gemini 的 API 地址为 `https://api.oneinai.com/v1beta/models`
3. 检查网络连接 3. 检查网络连接是否正常
4. 重新获取 API Key 并确保令牌组权限正确 4. 重新获取 API Key 并确认令牌组权限正确
### 对话响应速度慢？ ### 对话响应速度慢？
**可能原因** ： **可能原因：**
* 网络延迟 - 网络延迟
* 选择的模型较大 - 选择的模型较大（如 Opus 系列）
* 上下文过长 - 上下文过长
**解决方法** ： **解决方法：**
1. 检查网络连接质量 1. 检查网络连接质量
2. 尝试使用更快的模型（如 Gemini Flash） 2. 尝试使用更快的模型（如 Gemini Flash 或 Claude Haiku）
3. 清理或减少对话历史 3. 清理或缩短对话历史
### 如何同时使用多个模型？ ### 如何同时使用多个模型？
在 CherryStudio 中： 1. 在设置中分别配置不同的模型提供商
2. 在新建对话时选择对应的模型
1. 分别配置不同的模型提供商 3. 也可以创建多个对话窗口，每个使用不同模型
2. 在新建对话时选择对应的模型
3. 可以创建多个对话窗口，每个使用不同模型
### 更多问题 ### 更多问题
请查看： - [oneinAI 控制台](https://api.oneinai.com/console/token)
- [oneinAI FAQ](/support/faq)
- [CherryStudio 官方文档](https://www.cherry-ai.com/)
* [IkunCode 控制台](<https://api.oneinai.com/console/token>) ---
* [IkunCode FAQ](</support/faq>)
* [售后支持](</support/after-sales>)
* [CherryStudio 官方文档](<https://www.cherry-ai.com/>)
## ✅ 完成 ## ✅ 完成
🎉 **配置完成！现在你可以使用 CherryStudio 愉快地与 AI 对话了！** 🎉 **配置完成！现在你可以使用 CherryStudio 愉快地与 AI 对话了！**
记住以下要点： **核心要点回顾：**
* ✅ 不同模型使用不同的 API Key（不同令牌组） - ✅ Claude 与 Gemini 必须使用**不同的 API Key**（不同令牌组）
* ✅ Claude API 地址：`https://api.oneinai.com/v1/messages` - ✅ Claude API 地址：`https://api.oneinai.com`
* ✅ Gemini API 地址：`https://api.oneinai.com/v1beta/models` - ✅ Gemini API 地址：`https://api.oneinai.com/v1beta/models`
* ✅ 根据任务选择合适的模型 - ✅ 根据任务特性选择合适的模型
* ✅ 定期检查 [IkunCode 控制台](<https://api.oneinai.com/console/token>) 的余额 - ✅ 定期检查 [oneinAI 控制台](https://api.oneinai.com/console/token) 的余额
* ✅ 妥善保管你的 API Key - ✅ 妥善保管你的 API Key，避免泄露
* * * ---
**相关教程** ： **相关教程：**
* [Alma 客户端配置](</apps/alma>) - [Alma 客户端配置](/apps/alma)
* [Hapi 远程控制](</apps/hapi>) - [Hapi 远程控制](/apps/hapi)
* [IkunCode 控制台](<https://api.oneinai.com/console/token>) - [oneinAI 控制台](https://api.oneinai.com/console/token)

4
apidoc/apps/hapi-advanced.md
View File

@ -22,7 +22,7 @@
* ❌ 运营商 QoS 限速，访问速度慢 * ❌ 运营商 QoS 限速，访问速度慢
* ❌ 延迟高达几百毫秒，严重影响使用体验 * ❌ 延迟高达几百毫秒，严重影响使用体验
![优选 IP 前的访问速度](https://docs.ikuncode.cc/images/apps/hapi/%E4%BC%98%E9%80%89%E5%89%8D.png) ![优选 IP 前的访问速度](https://minio.oneinai.com/oneinai/images/docs/hapi-advanced/hapi-advanced01.png)
### 优选 IP 方案的优势 ### 优选 IP 方案的优势
@ -33,7 +33,7 @@
* ✅ 完全免费，利用 Cloudflare 企业级功能 * ✅ 完全免费，利用 Cloudflare 企业级功能
* ✅ 稳定性高，自动切换最优路由 * ✅ 稳定性高，自动切换最优路由
![优选 IP 后的访问速度](https://docs.ikuncode.cc/images/apps/hapi/%E4%BC%98%E9%80%89%E5%90%8E.png) ![优选 IP 后的访问速度](https://minio.oneinai.com/oneinai/images/docs/hapi-advanced/hapi-advanced0.png)
🚀 速度提升对比 🚀 速度提升对比

20
apidoc/apps/hapi.md
View File

@ -54,7 +54,7 @@ bash
**请务必保存好 Token 凭证！** 这是你连接和控制 Hapi 服务的唯一凭证。 **请务必保存好 Token 凭证！** 这是你连接和控制 Hapi 服务的唯一凭证。
![保留 Token 凭证](https://docs.ikuncode.cc/images/apps/hapi/image.png) ![保留 Token 凭证](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi01.png)
### 第二步：启动 AI 会话 ### 第二步：启动 AI 会话
@ -87,11 +87,11 @@ bash
1 1
![启动命令](https://docs.ikuncode.cc/images/apps/hapi/image%201.png) ![启动命令](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi02.png)
启动成功后，前端界面会显示连接状态： 启动成功后，前端界面会显示连接状态：
![前端连接状态](https://docs.ikuncode.cc/images/apps/hapi/image%202.png) ![前端连接状态](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi03.png)
🎉 局域网访问 🎉 局域网访问
@ -112,33 +112,33 @@ bash
**1\. 登录 Cloudflare Zero Trust 控制台** **1\. 登录 Cloudflare Zero Trust 控制台**
![配置步骤 1](https://docs.ikuncode.cc/images/apps/hapi/image%203.png) ![配置步骤 1](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi04.png)
**2\. 创建新的 Tunnel** **2\. 创建新的 Tunnel**
![配置步骤 2](https://docs.ikuncode.cc/images/apps/hapi/image%204.png) ![配置步骤 2](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi05.png)
**3\. 安装 cloudflared 客户端** **3\. 安装 cloudflared 客户端**
![配置步骤 3](https://docs.ikuncode.cc/images/apps/hapi/image%205.png) ![配置步骤 3](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi06.png)
**4\. 配置隧道名称** **4\. 配置隧道名称**
![配置步骤 4](https://docs.ikuncode.cc/images/apps/hapi/image%206.png) ![配置步骤 4](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi07.png)
**5\. 配置公共主机名** **5\. 配置公共主机名**
![配置步骤 5](https://docs.ikuncode.cc/images/apps/hapi/image%207.png) ![配置步骤 5](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi08.png)
**6\. 设置服务地址** **6\. 设置服务地址**
将服务地址设置为 `localhost:3006`（Hapi 默认端口） 将服务地址设置为 `localhost:3006`（Hapi 默认端口）
![配置步骤 6](https://docs.ikuncode.cc/images/apps/hapi/image%208.png) ![配置步骤 6](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi09.png)
**7\. 完成配置** **7\. 完成配置**
![配置步骤 7](https://docs.ikuncode.cc/images/apps/hapi/image%209.png) ![配置步骤 7](https://minio.oneinai.com/oneinai/images/docs/hapi/hapi10.png)
## ✅ 使用 Hapi ## ✅ 使用 Hapi

607
apidoc/apps/openclaw.md
View File

@ -2,51 +2,44 @@
**多平台 AI 编程代理，支持终端 TUI、Web Dashboard 和 Telegram Bot** **多平台 AI 编程代理，支持终端 TUI、Web Dashboard 和 Telegram Bot**
📋 简介 ## 📋 简介
OpenClaw 是一款功能丰富的 AI 编程代理工具，支持终端 TUI 交互、Web Dashboard 管理和 Telegram Bot 远程访问。适合需要在服务器环境中运行 AI 编程助手的开发者。 OpenClaw 是一款功能丰富的 AI 编程代理工具，支持终端 TUI 交互、Web Dashboard 管理和 Telegram Bot 远程访问。适合需要在服务器环境中运行 AI 编程助手的开发者。
⚠️ 适用环境 > ⚠️ **适用环境**
> 本教程适用于 **Linux 云服务器** 和 **macOS** 系统用户。
此教程适合 **Linux 云服务器** 和 **macOS** 系统用户。 > 🚨 **遇到 403 Your request was blocked？**
> 使用 oneinai 渠道时，**必须**在供应商配置中添加 `headers` 字段，否则请求会被拦截返回 403：
🚨 遇到 403 Your request was blocked？ >
> ```json
使用 OneinAI 渠道时，**必须** 在供应商配置中添加 `headers` 字段，否则请求会被拦截返回 403： > "headers": {
> "User-Agent": "claude-cli/2.0.76 (external, cli)",
json > "Authorization": "Bearer sk-xxxx"
> }
> ```
"headers": { >
"User-Agent": "claude-cli/2.0.76 (external, cli)", > - `Authorization` 的值必须与 `apiKey` 一致，格式为 `Bearer sk-你的密钥`
"Authorization": "Bearer sk-xxxx" > - `User-Agent` 必须保持示例中的格式，不可省略或随意修改
} > - 修改后执行 `openclaw gateway restart` 重启网关生效
>
1 > 详见下方[完整配置实例](#-完整配置实例)。
2
3
4
* `Authorization` 的值必须与 `apiKey` 一致，格式为 `Bearer sk-你的密钥`
* `User-Agent` 必须保持示例中的格式，不可省略或随意修改
* 修改后执行 `openclaw gateway restart` 重启网关生效
详见下方 完整配置实例。
## 🔗 相关链接 ## 🔗 相关链接
资源| 地址 | 资源 | 地址 |
---|--- | --- | --- |
OpenClaw 官网| <https://openclaw.ai> | OpenClaw 官网 | <https://openclaw.ai> |
| oneinai 控制台 | <https://api.oneinai.com/console/token> |
## ✨ 功能特点 ## ✨ 功能特点
* ✅ **终端 TUI** ：命令行交互界面，适合 SSH 环境 - ✅ **终端 TUI**：命令行交互界面，适合 SSH 环境
* ✅ **Web Dashboard** ：浏览器可视化管理面板 - ✅ **Web Dashboard**：浏览器可视化管理面板
* ✅ **Telegram Bot** ：支持通过 Telegram 远程对话 - ✅ **Telegram Bot**：支持通过 Telegram 远程对话
* ✅ **多模型支持** ：Claude、GPT、Gemini 等多种模型 - ✅ **多模型支持**：Claude、GPT、Gemini 等多种模型
* ✅ **Gateway 网关** ：内置网关服务，支持反向代理 - ✅ **Gateway 网关**：内置网关服务，支持反向代理
* ✅ **Skill 扩展** ：可通过 Dashboard 安装扩展技能 - ✅ **Skill 扩展**：可通过 Dashboard 安装扩展技能
## 🛠️ 安装与初始化 ## 🛠️ 安装与初始化
@ -54,30 +47,27 @@ OpenClaw 官网| <https://openclaw.ai>
登录服务器 SSH 或在 macOS 终端中运行以下命令： 登录服务器 SSH 或在 macOS 终端中运行以下命令：
bash ```bash
curl -fsSL https://openclaw.ai/install.sh | bash
```
curl -fsSL https://openclaw.ai/install.sh | bash
1
耐心等待安装流程结束。 耐心等待安装流程结束。
### 第二步：初始化配置 ### 第二步：初始化配置
安装过程中会依次出现以下选项，按照说明操作： 安装过程中会依次出现以下选项，按说明选择：
步骤| 选择| 说明 | 步骤 | 选择 | 说明 |
---|---|--- | --- | --- | --- |
启动方式| **QuickStart**| 快速开始模式 | 启动方式 | **QuickStart** | 快速开始模式 |
供应商设置| **Skip for now**| 先跳过，后续手动编辑配置文件 | 供应商设置 | **Skip for now** | 先跳过，后续手动编辑配置文件 |
适配器选择| **anthropic**| 选择 Anthropic 适配器 | 适配器选择 | **anthropic** | 选择 Anthropic 适配器 |
模型选择| **opus-4.5**| 或选择你需要的模型 | 模型选择 | **opus-4.5** | 或选择你需要的模型 |
社交适配器| 按需选择| 如 Telegram（可选） | 社交适配器 | 按需选择 | 如 Telegram（可选） |
Skill 安装| 跳过| 后续可通过 Dashboard 安装 | Skill 安装 | 跳过 | 后续可通过 Dashboard 安装 |
Hook 选择| 全选| 使用空格键全选后回车确认 | Hook 选择 | 全选 | 使用空格键全选后回车确认 |
打开方式| 跳过| 先跳过 | 打开方式 | 跳过 | 先跳过 |
Shell 补全| **yes**| 安装命令行自动补全 | Shell 补全 | **yes** | 安装命令行自动补全 |
## ⚙️ 渠道与模型配置 ## ⚙️ 渠道与模型配置
@ -85,46 +75,32 @@ Shell 补全| **yes**| 安装命令行自动补全
打开 OpenClaw 的配置文件进行编辑： 打开 OpenClaw 的配置文件进行编辑：
bash ```bash
vim ~/.openclaw/openclaw.json
```
参照下方[完整配置实例](#-完整配置实例)填入供应商和模型信息。
vim ~/.openclaw/openclaw.json
1
参照下方 完整配置实例 填入你的供应商和模型信息。
### 第二步：填入 API Key ### 第二步：填入 API Key
在 `models.providers` 中配置供应商信息，将 `apiKey` 和 `headers.Authorization` 替换为你在 [IkunCode 控制台](<https://api.oneinai.com/console/token>) 创建的 API Key。 在 `models.providers` 中配置供应商信息，将 `apiKey` 和 `headers.Authorization` 替换为你在 [oneinai 控制台](https://api.oneinai.com/console/token) 创建的 API Key。
💡 支持的分组 > 💡 **支持的分组**
> OpenClaw 使用 **逆向分组** 的 API Key。请在[创建专属 Key](/guide/create-key) 时选择逆向分组。
OpenClaw 使用 **逆向分组** 的 API Key。
![只允许逆向分组](`+a+`)
请在 [创建专属 Key](</guide/create-key>) 时选择逆向分组。
### 第三步：重启网关 ### 第三步：重启网关
bash ```bash
openclaw gateway restart
```
openclaw gateway restart
1
### 第四步：验证配置 ### 第四步：验证配置
运行以下命令进入 TUI 界面测试模型是否正常： 运行以下命令进入 TUI 界面测试模型是否正常：
bash ```bash
openclaw tui
```
openclaw tui
1
测试成功后输入 `/quit` 退出 TUI。 测试成功后输入 `/quit` 退出 TUI。
@ -134,43 +110,34 @@ bash
在控制台运行命令获取 Dashboard URL，在浏览器中访问即可进入管理面板。 在控制台运行命令获取 Dashboard URL，在浏览器中访问即可进入管理面板。
⚠️ 服务器用户注意 > ⚠️ **服务器用户注意**
> 如果你在远程服务器上运行 OpenClaw，需要完成以下额外步骤。
如果你在远程服务器运行 OpenClaw，需要： **1. 配置反向代理**
**1\. 配置反向代理** 使用 Nginx 或其他反向代理工具反代 OpenClaw 服务，并配置 SSL 证书。
使用 Nginx 或其他反向代理工具反代 OpenClaw 服务，并设置 SSL 证书。 **2. 修改配置文件**
**2\. 修改配置文件**
编辑 `~/.openclaw/openclaw.json`，在 `gateway` 字段下添加： 编辑 `~/.openclaw/openclaw.json`，在 `gateway` 字段下添加：
json ```json
"controlUi": {
"allowInsecureAuth": true
}
```
**3. 重启网关**
"controlUi": { ```bash
"allowInsecureAuth": true openclaw gateway restart
} ```
1
2
3
**3\. 重启网关**
bash
openclaw gateway restart
1
访问带有 Token 的 Dashboard URL 即可进入后台界面。 访问带有 Token 的 Dashboard URL 即可进入后台界面。
## 🤖 配置 Telegram Bot（可选） ## 🤖 配置 Telegram Bot（可选）
如果安装时选择了 Telegram 适配器，可以通过以下步骤配置 Bot 访问权限： 如果安装时选择了 Telegram 适配器，可以通过以下步骤配置 Bot 访问权限。
### 第一步：与 Bot 对话 ### 第一步：与 Bot 对话
@ -178,321 +145,195 @@ bash
### 第二步：获取 Pairing Code ### 第二步：获取 Pairing Code
首次对话后会收到一个 **Pairing Code** 。 首次对话后会收到一个 **Pairing Code**。
### 第三步：授权配对 ### 第三步：授权配对
在控制台运行以下命令完成授权： 在控制台运行以下命令完成授权：
bash ```bash
openclaw pairing approve telegram 你的Pairing_Code
```
openclaw pairing approve telegram 你的Pairing_Code
1
配对成功后，即可通过 Telegram Bot 与 OpenClaw 进行远程对话。 配对成功后，即可通过 Telegram Bot 与 OpenClaw 进行远程对话。
## 📄 完整配置实例 ## 📄 完整配置实例
以下是一份接入 IkunCode 渠道的 `openclaw.json` 完整配置参考（路径：`~/.openclaw/openclaw.json`）： 以下是一份接入 oneinai 渠道的 `openclaw.json` 完整参考（路径：`~/.openclaw/openclaw.json`）：
💡 说明 > 💡 **说明**
> 配置中的 `sk-xxxx` 和 `xxxxx` 为占位符，请替换为你自己的 API Key 和 Bot Token。
配置中的 `sk-xxxx` 和 `xxxxx` 为占位符，请替换为你自己的 API Key 和 Bot Token。 ```json
{
json "messages": {
"ackReactionScope": "group-mentions"
},
{ "agents": {
"messages": { "defaults": {
"ackReactionScope": "group-mentions" "model": {
"primary": "oneinai-claude/claude-opus-4-5-20251101"
}, },
"agents": { "maxConcurrent": 4,
"defaults": { "subagents": {
"model": { "maxConcurrent": 8
"primary": "ikuncode-claude/claude-opus-4-5-20251101"
},
"maxConcurrent": 4,
"subagents": {
"maxConcurrent": 8
},
"compaction": {
"mode": "safeguard"
},
"workspace": "C:\\\\Users\\\\Administrator\\\\.openclaw\\\\workspace"
}
}, },
"models": { "compaction": {
"providers": { "mode": "safeguard"
"ikuncode-claude": {
"baseUrl": "https://api.oneinai.com/v1",
"apiKey": "sk-xxxx",
"api": "openai-completions",
"headers": {
"User-Agent": "claude-cli/2.0.76 (external, cli)",
"Authorization": "Bearer sk-xxxx"
},
"models": [
{
"id": "claude-opus-4-5-20251101",
"name": "claude-opus-4-5-20251101",
"contextWindow": 200000,
"maxTokens": 32000,
"cost": {
"input": 0,
"output": 0,
"cacheRead": 0,
"cacheWrite": 0
}
}
]
},
"ikuncode-codex": {
"baseUrl": "https://api.oneinai.com/v1",
"apiKey": "sk-xxxx",
"api": "openai-completions",
"headers": {
"User-Agent": "codex_cli_rs/0.77.0 (Windows 10.0.26100; x86_64) WindowsTerminal",
"Authorization": "Bearer sk-xxxx"
},
"models": [
{
"id": "gpt-5.2-codex",
"name": "gpt-5.2-codex",
"contextWindow": 200000,
"maxTokens": 32000,
"cost": {
"input": 0,
"output": 0,
"cacheRead": 0,
"cacheWrite": 0
}
}
]
}
}
}, },
"gateway": { "workspace": "C:\\\\Users\\\\Administrator\\\\.openclaw\\\\workspace"
"mode": "local", }
"auth": { },
"mode": "token", "models": {
"token": "xxxx" "providers": {
"oneinai-claude": {
"baseUrl": "https://api.oneinai.com/v1",
"apiKey": "sk-xxxx",
"api": "openai-completions",
"headers": {
"User-Agent": "claude-cli/2.0.76 (external, cli)",
"Authorization": "Bearer sk-xxxx"
}, },
"port": 18789, "models": [
"bind": "loopback", {
"tailscale": { "id": "claude-opus-4-5-20251101",
"mode": "off", "name": "claude-opus-4-5-20251101",
"resetOnExit": false "contextWindow": 200000,
} "maxTokens": 32000,
}, "cost": {
"auth": { "input": 0,
"profiles": {} "output": 0,
}, "cacheRead": 0,
"plugins": { "cacheWrite": 0
"entries": { }
"telegram": {
"enabled": true
} }
} ]
}, },
"channels": { "oneinai-codex": {
"telegram": { "baseUrl": "https://api.oneinai.com/v1",
"enabled": true, "apiKey": "sk-xxxx",
"botToken": "xxxxx" "api": "openai-completions",
} "headers": {
}, "User-Agent": "codex_cli_rs/0.77.0 (Windows 10.0.26100; x86_64) WindowsTerminal",
"logging": { "Authorization": "Bearer sk-xxxx"
"level": "trace", },
"consoleLevel": "debug", "models": [
"consoleStyle": "pretty" {
}, "id": "gpt-5.2-codex",
"commands": { "name": "gpt-5.2-codex",
"restart": true "contextWindow": 200000,
}, "maxTokens": 32000,
"skills": { "cost": {
"install": { "input": 0,
"nodeManager": "npm" "output": 0,
} "cacheRead": 0,
"cacheWrite": 0
}
}
]
} }
} }
},
1 "gateway": {
2 "mode": "local",
3 "auth": {
4 "mode": "token",
5 "token": "xxxx"
6 },
7 "port": 18789,
8 "bind": "loopback",
9 "tailscale": {
10 "mode": "off",
11 "resetOnExit": false
12 }
13 },
14 "auth": {
15 "profiles": {}
16 },
17 "plugins": {
18 "entries": {
19 "telegram": {
20 "enabled": true
21 }
22 }
23 },
24 "channels": {
25 "telegram": {
26 "enabled": true,
27 "botToken": "xxxxx"
28 }
29 },
30 "logging": {
31 "level": "trace",
32 "consoleLevel": "debug",
33 "consoleStyle": "pretty"
34 },
35 "commands": {
36 "restart": true
37 },
38 "skills": {
39 "install": {
40 "nodeManager": "npm"
41 }
42 }
43 }
44 ```
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
### 关键字段说明 ### 关键字段说明
字段| 说明 | 字段 | 说明 |
---|--- | --- | --- |
`agents.defaults.model.primary`| 默认使用的模型，格式为 `供应商名/模型ID` | `agents.defaults.model.primary` | 默认使用的模型，格式为 `供应商名/模型ID` |
`agents.defaults.maxConcurrent`| 主代理最大并发数 | `agents.defaults.maxConcurrent` | 主代理最大并发数 |
`agents.defaults.subagents.maxConcurrent`| 子代理最大并发数 | `agents.defaults.subagents.maxConcurrent` | 子代理最大并发数 |
`agents.defaults.compaction.mode`| 上下文压缩模式，`safeguard` 为安全模式 | `agents.defaults.compaction.mode` | 上下文压缩模式，`safeguard` 为安全模式 |
`agents.defaults.workspace`| 工作区目录路径，按你的系统修改 | `agents.defaults.workspace` | 工作区目录路径，按你的系统修改 |
`models.providers`| 模型供应商配置，可配置多个供应商 | `models.providers` | 模型供应商配置，可配置多个供应商 |
`models.providers.*.baseUrl`| API 基础地址，IkunCode 统一为 `https://api.oneinai.com/v1` | `models.providers.*.baseUrl` | API 基础地址，oneinai 统一为 `https://api.oneinai.com/v1` |
`models.providers.*.apiKey`| 对应分组的 API Key | `models.providers.*.apiKey` | 对应分组的 API Key |
`models.providers.*.api`| 接口协议，固定为 `openai-completions` | `models.providers.*.api` | 接口协议，固定为 `openai-completions` |
`models.providers.*.headers`| 请求头，需包含 `User-Agent` 和 `Authorization` | `models.providers.*.headers` | 请求头，需包含 `User-Agent` 和 `Authorization` |
`gateway.port`| 网关监听端口，默认 `18789` | `gateway.port` | 网关监听端口，默认 `18789` |
`gateway.bind`| 绑定模式，`loopback` 仅本机访问 | `gateway.bind` | 绑定模式，`loopback` 仅本机访问 |
`channels.telegram.botToken`| Telegram Bot Token，通过 @BotFather 获取 | `channels.telegram.botToken` | Telegram Bot Token，通过 @BotFather 获取 |
`logging.level`| 日志级别，排查问题时可设为 `trace` | `logging.level` | 日志级别，排查问题时可设为 `trace` |
⚠️ 注意事项 > ⚠️ **注意事项**
> - **Headers 中的 Authorization** 必须与 `apiKey` 保持一致，格式为 `Bearer sk-xxxx`
> - **User-Agent** 必须保持示例中的格式，确保请求正常识别
> - **workspace 路径**：Windows 用户使用 `\\\\` 双反斜杠，Linux/macOS 用户使用 `/` 正斜杠（如 `/root/.openclaw/workspace`）
> - **cost 全部设为 0**：通过 oneinai 中转使用时无需在本地计费
* **Headers 中的 Authorization** 必须与 `apiKey` 保持一致，格式为 `Bearer sk-xxxx` ## ❓ 常见问题
* **User-Agent** 建议保持示例中的格式，确保请求正常识别
* **workspace 路径** ：Windows 用户使用 `\\\\` 双反斜杠，Linux/macOS 用户使用 `/` 正斜杠（如 `/root/.openclaw/workspace`）
* **cost 全部设为 0** ：通过 IkunCode 中转使用时无需在本地计费
## 常见问题
### 安装脚本执行失败？ ### 安装脚本执行失败？
* 确认网络连接正常，能访问 `openclaw.ai` - 确认网络连接正常，能访问 `openclaw.ai`
* 确认系统已安装 `curl` 和 `bash` - 确认系统已安装 `curl` 和 `bash`
* 如果在国内服务器，可能需要配置代理 - 如果在国内服务器，可能需要配置代理
### 遇到 403 `Your request was blocked` 怎么办？ ### 遇到 403 `Your request was blocked` 怎么办？
如果请求返回 `403 Your request was blocked`，说明缺少正确的请求头。**必须** 在供应商配置中添加 `headers` 字段： 如果请求返回 `403 Your request was blocked`，说明缺少正确的请求头。**必须**在供应商配置中添加 `headers` 字段：
json ```json
"headers": {
"User-Agent": "claude-cli/2.0.76 (external, cli)",
"Authorization": "Bearer sk-xxxx"
}
```
> 🚨 **重要**
"headers": { > - `headers` 中的 `Authorization` 值必须与 `apiKey` 一致，格式为 `Bearer sk-你的密钥`
"User-Agent": "claude-cli/2.0.76 (external, cli)", > - `User-Agent` 必须保持示例格式，否则请求会被拦截
"Authorization": "Bearer sk-xxxx" > - 配置完成后执行 `openclaw gateway restart` 重启网关
}
1
2
3
4
🚨 重要
* `headers` 中的 `Authorization` 值必须与 `apiKey` 一致，格式为 `Bearer sk-你的密钥`
* `User-Agent` 必须保持示例格式，否则请求会被拦截
* 配置完成后执行 `openclaw gateway restart` 重启网关
### Gateway 重启后模型仍不可用？ ### Gateway 重启后模型仍不可用？
* 检查 API Key 是否正确填入 - 检查 API Key 是否正确填入
* 确认 Key 对应的分组支持你选择的模型 - 确认 Key 对应的分组支持你选择的模型
* 查看 OpenClaw 日志排查具体错误 - 查看 OpenClaw 日志排查具体错误
### 更多问题 ### 更多问题
请查看 [FAQ](</support/faq>) 或联系[售后支持](</support/after-sales>)。 请查看 [FAQ](/support/faq)

12
apidoc/apps/opencode.md
View File

@ -36,7 +36,7 @@ bash
安装完成后，在终端输入 `opencode` 命令，若出现 TUI 界面则安装成功。 安装完成后，在终端输入 `opencode` 命令，若出现 TUI 界面则安装成功。
![安装成功界面](https://cdn.xf233.io/project/Packy-docs/Advanced/OpenCode/02.png) ![安装成功界面](https://minio.oneinai.com/oneinai/images/docs/opencode/opencode01.png)
### 第二步：安装 CC-Switch ### 第二步：安装 CC-Switch
@ -48,7 +48,7 @@ bash
打开 CC-Switch，上方配置项选择 `OpenCode`，然后点击 **添加供应商** 按钮。 打开 CC-Switch，上方配置项选择 `OpenCode`，然后点击 **添加供应商** 按钮。
![添加供应商界面](https://docs.ikuncode.cc/images/opnecode.png) ![添加供应商界面](https://minio.oneinai.com/oneinai/images/docs/opencode/opencode02.png)
**2\. 填写供应商信息** **2\. 填写供应商信息**
@ -66,7 +66,7 @@ bash
根据你需要的模型类型，选择正确分组的 API Key： 根据你需要的模型类型，选择正确分组的 API Key：
![只允许逆向分组]('+t+') ![只允许逆向分组](https://minio.oneinai.com/oneinai/images/docs/opencode/opencode-group.png)
* **Claude 系列** ：只允许逆向分组 * **Claude 系列** ：只允许逆向分组
* **GPT 系列** ：Codex 分组 * **GPT 系列** ：Codex 分组
@ -80,11 +80,11 @@ bash
2. 输入 `/models` 命令，检查配置的渠道是否出现在模型列表中 2. 输入 `/models` 命令，检查配置的渠道是否出现在模型列表中
3. 如果能看到你添加的模型，说明配置成功 3. 如果能看到你添加的模型，说明配置成功
![模型列表验证](https://cdn.xf233.io/project/Packy-docs/Advanced/OpenCode/06.png) ![模型列表验证](https://minio.oneinai.com/oneinai/images/docs/opencode/opencode03.png)
开始愉快地编码吧！🎉 开始愉快地编码吧！🎉
![使用中的对话界面](https://cdn.xf233.io/project/Packy-docs/Advanced/OpenCode/07.png) ![使用中的对话界面](https://minio.oneinai.com/oneinai/images/docs/opencode/opencode0.png)
## 常见问题 ## 常见问题
@ -100,4 +100,4 @@ bash
### 更多问题 ### 更多问题
请查看 [FAQ](</support/faq>) 或联系[售后支持](</support/after-sales>)。 请查看 [FAQ](</support/faq>)

2
apidoc/deploy/claude-code.md
View File

@ -336,4 +336,4 @@ source ~/.zshrc
### 更多问题 ### 更多问题
请查看 [FAQ](/support/faq) 或联系 [售后支持](/support/after-sales)。 请查看 [FAQ](/support/faq)

476
apidoc/deploy/codex.md
View File

@ -2,90 +2,88 @@
**企业级 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」标签页
3. 点击右上角橙色「+」按钮添加新配置 3. 点击右上角橙色「+」按钮添加新配置
g
![CC-Switch Codex 标签页](https://minio.oneinai.com/oneinai/images/docs/codex/codex01.pn)
![CC-Switch Codex 标签页](https://docs.ikuncode.cc/images/tu9.png) **2. 填写 CodeX 提供商配置**
**2\. 填写 CodeX 提供商配置** | 配置项 | 说明 |
| --- | --- |
| **提供商名称** | 自定义名称，如「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） |
| **其他配置** | 根据需求调整推理强度、网络访问等参数 |
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. 点击「保存」按钮
![CC-Switch 添加 CodeX 配置](https://docs.ikuncode.cc/images/tu10.png)![CC-Switch CodeX 配置详情](https://docs.ikuncode.cc/images/tu11.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` 文件 **3. 启用配置并使用**
* 可以添加多个提供商配置，随时切换
* 切换配置后，关闭并重启 CodeX 即可生效
**3\. 启用配置并使用** 1. 在配置列表中找到刚创建的「oneinai」配置
2. 点击配置右侧的「当前使用」按钮
3. 配置会被标记为「当前使用」状态（绿色标签）
4. 重启 CodeX，新配置即可生效
1. 在配置列表中找到刚创建的「IkunCoding」配置 **4. 系统托盘快速切换**
2. 点击配置右侧的「当前使用」按钮
3. 配置会被标记为「当前使用」状态（绿色标签）
4. 重启 CodeX，新配置即可生效
**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,301 +91,193 @@ CC-Switch 支持通过系统托盘快速切换 CodeX 配置：
以管理员权限启动命令提示符或 PowerShell，执行： 以管理员权限启动命令提示符或 PowerShell，执行：
powershell ```powershell
npm install -g @openai/codex@latest
codex --version
```
#### 第二步：集成 oneinai API 服务
npm install -g @openai/codex@latest **获取专属 API 凭证**：
codex --version
1 1. 访问 [oneinai 控制台](https://api.oneinai.com/console/token)
2 2. 完成账户注册或登录
3. 进入「API 密钥管理」模块
4. 创建新密钥时务必选择「codex」令牌组
5. 安全保存生成的 API Key
#### 第二步：集成 IkunCoding API 服务 > 🔐 **安全提醒**
> CodeX 要求使用独立的令牌组配置，与 Claude Code 令牌体系完全隔离。
**获取专属 API 凭证** ： **构建配置目录结构**：
1. 访问 IkunCoding 开发者控制台 ```powershell
2. 完成账户注册或执行登录操作 mkdir $env:USERPROFILE\.codex
3. 导航至「API 密钥管理」模块 cd $env:USERPROFILE\.codex
4. 创建新密钥时，务必选择「codex」令牌组 ```
5. 安全保存生成的 API Key
🔐 安全提醒 **编写配置文件 `config.toml`**：
CodeX 要求使用独立的令牌组配置，与 Claude Code 令牌体系完全隔离。 ```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
**构建配置目录结构** ： [model_providers.oneinai]
name = "oneinai"
base_url = "https://api.oneinai.com/v1"
wire_api = "responses"
requires_openai_auth = true
```
powershell **编写认证文件 `auth.json`**：
```json
mkdir %USERPROFILE%\\.codex {
cd %USERPROFILE%\\.codex "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌"
}
1 ```
2
**编写配置文件：config.toml**
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
1
2
3
4
5
6
7
8
9
10
11
12
13
**编写认证文件：auth.json**
json
{
"OPENAI_API_KEY": "此处粘贴您的 CodeX 专用令牌"
}
1
2
3
#### 第三步：初始化工作空间 #### 第三步：初始化工作空间
powershell ```powershell
mkdir my-codex-project
cd my-codex-project
mkdir my-codex-project codex
cd my-codex-project ```
codex
1
2
3
### 🍏 macOS 平台 ### 🍏 macOS 平台
#### 部署 CodeX 工具 #### 部署 CodeX 工具
bash ```bash
npm install -g @openai/codex@latest
codex --version
npm install -g @openai/codex@latest ```
codex --version
1
2
#### 集成 API 服务 #### 集成 API 服务
**构建配置目录** ： **构建配置目录**：
bash ```bash
mkdir -p ~/.codex
cd ~/.codex
```
**编写 `config.toml` 配置**：
mkdir -p ~/.codex ```bash
cd ~/.codex 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 [model_providers.oneinai]
2 name = "oneinai"
base_url = "https://api.oneinai.com/v1"
wire_api = "responses"
requires_openai_auth = true
EOF
```
**编写 config.toml 配置** ： **编写 `auth.json` 认证配置**：
bash ```bash
cat > auth.json << 'EOF'
{
cat > config.toml << 'EOF' "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌"
model_provider = "IkunCoding" }
model = "gpt-5.4" EOF
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 ```bash
mkdir my-codex-project
cd my-codex-project
mkdir my-codex-project codex
cd my-codex-project ```
codex
1
2
3
### 🐧 Linux 平台 ### 🐧 Linux 平台
#### 部署 CodeX 工具 #### 部署 CodeX 工具
bash ```bash
sudo npm install -g @openai/codex@latest
codex --version
sudo npm install -g @openai/codex@latest ```
codex --version
1
2
#### 集成 API 服务 #### 集成 API 服务
**构建配置目录** ： **构建配置目录**：
bash ```bash
mkdir -p ~/.codex
cd ~/.codex
```
**编写 `config.toml` 配置**：
mkdir -p ~/.codex ```bash
cd ~/.codex 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 [model_providers.oneinai]
2 name = "oneinai"
base_url = "https://api.oneinai.com/v1"
wire_api = "responses"
requires_openai_auth = true
EOF
```
**编写 config.toml 配置** ： **编写 `auth.json` 认证配置**：
bash ```bash
cat > auth.json << 'EOF'
{
cat > config.toml << 'EOF' "OPENAI_API_KEY": "此处粘贴你的 CodeX 专用令牌"
model_provider = "IkunCoding" }
model = "gpt-5.4" EOF
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 ```bash
mkdir my-codex-project
cd my-codex-project
codex
```
## ❓ 常见问题
mkdir my-codex-project
cd my-codex-project
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)

416
apidoc/deploy/gemini-cli.md
View File

@ -2,346 +2,258 @@
**Google AI 编程助手安装指南** **Google AI 编程助手安装指南**
资源| 地址 | 资源 | 地址 |
---|--- | --- | --- |
官方文档| [geminicli.com/docs](<https://geminicli.com/docs/>) | 官方文档 | [geminicli.com/docs](https://geminicli.com/docs/) |
| oneinai 控制台 | <https://api.oneinai.com/console/token> |
📋 前置要求 > 📋 **前置要求**
> 请先完成 [Node.js 环境安装](/node/windows)，确保 Node.js 18+ 已正确安装。
请先完成 [Node.js 环境安装](</node/windows>)，确保 Node.js 18+ 已正确安装。 ## 🚀 快速开始
🚀 Gemini CLI 快速开始 Google AI 编程助手，由 Gemini 2.5 Pro 驱动。
Google AI 编程助手，Gemini 2.5 Pro 驱动 **1️⃣ 安装 CLI　2️⃣ 配置密钥　3️⃣ 开始编码**
**1️⃣** 安装 CLI **2️⃣** 配置密钥 **3️⃣** 开始编码
## 🚀 使用 CC-Switch 快速配置（推荐） ## 🚀 使用 CC-Switch 快速配置（推荐）
⚠️ 前置条件 > ⚠️ **前置条件**
> 使用 CC-Switch 配置 Gemini CLI 之前，请确保已通过 npm 全局安装 Gemini CLI：
>
> ```bash
> npm install -g @google/gemini-cli
> ```
>
> 验证安装：`gemini --version`
使用 CC-Switch 配置 Gemini CLI 之前，请确保已通过 npm 全局安装 Gemini CLI 工具： 推荐使用 [CC-Switch 快速配置工具](/tools/cc-switch) 进行图形化配置，简单快捷，无需手动创建配置文件。
bash
npm install -g @google/gemini-cli
1
验证安装：`gemini --version`
推荐使用 [CC-Switch 快速配置工具](</tools/cc-switch>) 进行图形化配置，简单快捷无需手动创建配置文件。
### 配置步骤 ### 配置步骤
**1\. 启动 CC-Switch 并切换到 Gemini 标签** **1. 启动 CC-Switch 并切换到 Gemini 标签**
1. 打开 CC-Switch 应用程序 1. 打开 CC-Switch 应用程序
2. 点击顶部的「Gemini」标签页 2. 点击顶部的「Gemini」标签页
3. 点击右上角橙色「+」按钮添加新配置 3. 点击右上角橙色「+」按钮添加新配置
![CC-Switch Gemini 标签页](https://docs.ikuncode.cc/images/tu12.png) ![CC-Switch Gemini 标签页](https://minio.oneinai.com/oneinai/images/docs/gemini-cli/gemini-cli01.png)
**2\. 填写 Gemini CLI 提供商配置** **2. 填写 Gemini CLI 提供商配置**
1. **提供商名称** ：自定义名称（如「ikuncode」） | 配置项 | 说明 |
2. **Base URL** ：输入 `https://api.oneinai.com` | --- | --- |
3. **API Key** ：粘贴您从 IkunCode 平台获取的 Gemini 专用令牌 | **提供商名称** | 自定义名称，如「oneinai」 |
4. **Model** ：选择 `gemini-3-pro-preview` 或其他可用模型 | **Base URL** | `https://api.oneinai.com` |
5. **安全设置** ：根据需求调整（可选） | **API Key** | 在 [oneinai 控制台](https://api.oneinai.com/console/token) 创建的 Gemini 专用令牌 |
6. 点击「保存」按钮 | **Model** | `gemini-3-pro-preview` 或其他可用模型 |
| **安全设置** | 根据需求调整（可选） |
![CC-Switch 添加 Gemini CLI 配置](https://docs.ikuncode.cc/images/tu13.png)![CC-Switch Gemini CLI 配置详情](https://docs.ikuncode.cc/images/tu14.png) 填写完成后点击「保存」按钮。
💡 提示 ![CC-Switch 添加 Gemini CLI 配置](https://minio.oneinai.com/oneinai/images/docs/gemini-cli/gemini-cli02.png)
![CC-Switch Gemini CLI 配置详情](https://minio.oneinai.com/oneinai/images/docs/gemini-cli/gemini-cli03.png)
* CC-Switch 会自动创建 `~/.gemini/.env` 和 `settings.json` 文件 > 💡 **提示**
* 可以添加多个提供商配置，随时切换 > - CC-Switch 会自动创建 `~/.gemini/.env` 和 `settings.json` 文件
* 切换配置后，关闭并重启 Gemini CLI 即可生效 > - 可以添加多个提供商配置，随时切换
> - 切换配置后，关闭并重启 Gemini CLI 即可生效
**3\. 启用配置并使用** **3. 启用配置并使用**
1. 在配置列表中找到刚创建的「ikuncode」配置 1. 在配置列表中找到刚创建的「oneinai」配置
2. 点击配置右侧的「当前使用」按钮 2. 点击配置右侧的「当前使用」按钮
3. 配置会被标记为「当前使用」状态（绿色标签） 3. 配置会被标记为「当前使用」状态（绿色标签）
4. 重启 Gemini CLI，新配置即可生效 4. 重启 Gemini CLI，新配置即可生效
**4\. 系统托盘快速切换** **4. 系统托盘快速切换**
CC-Switch 支持通过系统托盘快速切换 Gemini CLI 配置： CC-Switch 支持通过系统托盘快速切换 Gemini CLI 配置：
* 右键点击系统托盘中的 CC-Switch 图标 - 右键点击系统托盘中的 CC-Switch 图标
* 在菜单中选择 Gemini 分类 - 在菜单中选择 Gemini 分类
* 直接选择要切换到的配置 - 直接选择要切换到的配置
* 配置立即生效，无需打开主界面 - 配置立即生效，无需打开主界面
⚠️ 注意事项 > ⚠️ **注意事项**
> - 务必在 oneinai 平台创建 Gemini CLI 专用令牌
* 确保从 IkunCode 平台创建 Gemini CLI 专用令牌 > - Gemini 令牌与 Claude Code / CodeX 令牌不通用
* Gemini 令牌与 Claude Code/CodeX 令牌不通用 > - 切换配置后需要重启 Gemini CLI 才能生效
* 切换配置后需要重启 Gemini CLI 才能生效 > - 可在 CC-Switch 中测试 API 端点速度
* 可在 CC-Switch 中测试 API 端点速度
## ⌨️ 手动命令行配置 ## ⌨️ 手动命令行配置
如果您不使用 CC-Switch，可以按照以下步骤手动安装和配置 Gemini CLI。 如果你不使用 CC-Switch，可以按照以下步骤手动安装和配置 Gemini CLI。
### 🖥️ Windows 安装流程教程 ### 🖥️ Windows 平台
#### 1️⃣ 全局安装 Gemini CLI #### 1️⃣ 全局安装 Gemini CLI
powershell ```powershell
npm install -g @google/gemini-cli
```
npm install -g @google/gemini-cli
1
#### 2️⃣ 配置 Gemini CLI #### 2️⃣ 配置 Gemini CLI
⚠️ 重要提示 > ⚠️ **重要提示**
> 请替换下方的 `GEMINI_API_KEY` 为你从 [oneinai 控制台](https://api.oneinai.com/console/token) 获取的 Gemini CLI 专用 API 密钥。
请替换下方的 `GEMINI_API_KEY` 为你从 <https://ikuncode.cc> 获取的 Gemini CLI 专用 API 密钥！ **2.1 创建 gemini 配置目录**
**3.1 创建 gemini 文件夹** 在用户目录下创建：`%USERPROFILE%\.gemini\`
在用户目录下：`%USERPROFILE%\\.gemini\\` **2.2 创建 `.env` 文件**
**3.2 创建 .env 文件** 在 `.gemini` 目录中新建 `.env` 文件，写入：
在 `gemini` 文件夹新建 `.env` 文件： ```env
GOOGLE_GEMINI_BASE_URL=https://api.oneinai.com
GEMINI_API_KEY=你的专属密钥（在 oneinai 控制台创建）
GEMINI_MODEL=gemini-3-pro-preview
```
env **2.3 创建 `settings.json` 文件**
在 `.gemini` 目录中新建 `settings.json` 文件，写入：
GOOGLE_GEMINI_BASE_URL=https://api.oneinai.com ```json
GEMINI_API_KEY=你的专属密钥请到https://ikuncode.cc获取 {
GEMINI_MODEL=gemini-3-pro-preview "ide": {
"enabled": true
1 },
2 "security": {
3 "auth": {
"selectedType": "gemini-api-key"
**3.3 创建 settings.json 文件**
在 `gemini` 文件夹新建 `settings.json` 文件：
json
{
"ide": {
"enabled": true
},
"security": {
"auth": {
"selectedType": "gemini-api-key"
}
}
} }
}
1 }
2 ```
3
4
5
6
7
8
9
10
#### 3️⃣ 启动 Gemini CLI #### 3️⃣ 启动 Gemini CLI
powershell ```powershell
gemini
```
> 🎉 **开始使用 Gemini CLI**
> - 输入上下文描述快速生成代码
> - Agent Mode 自动编程模式
> - Google Search 实时联网搜索
gemini ### 🍏 macOS 平台
1
🎉 开始使用 Gemini CLI
• 输入上下文描述 "M kikasuna" • Agent Mode 自动编程模式 • Google Search 实时联网搜索
### 🍏 macOS 安装流程教程
#### 1️⃣ 全局安装 Gemini CLI #### 1️⃣ 全局安装 Gemini CLI
bash ```bash
npm install -g @google/gemini-cli
```
npm install -g @google/gemini-cli
1
#### 2️⃣ 配置 Gemini CLI #### 2️⃣ 配置 Gemini CLI
**3.1 创建配置目录** ： **2.1 创建配置目录**：
bash ```bash
mkdir -p ~/.gemini
cd ~/.gemini
```
**2.2 创建 `.env` 文件**：
mkdir -p ~/.gemini ```bash
cd ~/.gemini cat > .env << 'EOF'
GOOGLE_GEMINI_BASE_URL=https://api.oneinai.com
GEMINI_API_KEY=你的专属密钥（在 oneinai 控制台创建）
GEMINI_MODEL=gemini-3-pro-preview
EOF
```
1 **2.3 创建 `settings.json` 文件**：
2
**3.2 创建 .env 文件** ： ```bash
cat > settings.json << 'EOF'
bash {
"ide": {
"enabled": true
cat > .env << 'EOF' },
GOOGLE_GEMINI_BASE_URL=https://api.oneinai.com "security": {
GEMINI_API_KEY=你的专属密钥请到https://ikuncode.cc获取 "auth": {
GEMINI_MODEL=gemini-3-pro-preview "selectedType": "gemini-api-key"
EOF
1
2
3
4
5
**3.3 创建 settings.json 文件** ：
bash
cat > settings.json << 'EOF'
{
"ide": {
"enabled": true
},
"security": {
"auth": {
"selectedType": "gemini-api-key"
}
}
} }
EOF }
}
1 EOF
2 ```
3
4
5
6
7
8
9
10
11
12
#### 3️⃣ 启动 Gemini CLI #### 3️⃣ 启动 Gemini CLI
bash ```bash
gemini
```
### 🐧 Linux 平台
gemini
1
### 🐧 Linux 安装流程教程
#### 1️⃣ 全局安装 Gemini CLI #### 1️⃣ 全局安装 Gemini CLI
bash ```bash
sudo npm install -g @google/gemini-cli
```
sudo npm install -g @google/gemini-cli
1
#### 2️⃣ 配置 Gemini CLI #### 2️⃣ 配置 Gemini CLI
**3.1 创建配置目录** ： **2.1 创建配置目录**：
bash ```bash
mkdir -p ~/.gemini
cd ~/.gemini
```
**2.2 创建 `.env` 文件**：
mkdir -p ~/.gemini ```bash
cd ~/.gemini cat > .env << 'EOF'
GOOGLE_GEMINI_BASE_URL=https://api.oneinai.com
GEMINI_API_KEY=你的专属密钥（在 oneinai 控制台创建）
GEMINI_MODEL=gemini-3-pro-preview
EOF
```
1 **2.3 创建 `settings.json` 文件**：
2
**3.2 创建 .env 文件** ： ```bash
cat > settings.json << 'EOF'
bash {
"ide": {
"enabled": true
cat > .env << 'EOF' },
GOOGLE_GEMINI_BASE_URL=https://api.oneinai.com "security": {
GEMINI_API_KEY=你的专属密钥请到https://ikuncode.cc获取 "auth": {
GEMINI_MODEL=gemini-3-pro-preview "selectedType": "gemini-api-key"
EOF
1
2
3
4
5
**3.3 创建 settings.json 文件** ：
bash
cat > settings.json << 'EOF'
{
"ide": {
"enabled": true
},
"security": {
"auth": {
"selectedType": "gemini-api-key"
}
}
} }
EOF }
}
1 EOF
2 ```
3
4
5
6
7
8
9
10
11
12
#### 3️⃣ 启动 Gemini CLI #### 3️⃣ 启动 Gemini CLI
bash ```bash
gemini
```
> 🎉 **部署完成！**
> 现在你可以使用 Gemini CLI 进行 AI 辅助编程了。
gemini ## ❓ 常见问题
1
🎉 部署完成！
现在您可以使用 Gemini CLI 进行 AI 辅助编程了。
## 常见问题
### API Key 在哪里获取？ ### API Key 在哪里获取？
登录 [IkunCode 平台](<https://api.oneinai.com>)，创建 Gemini CLI 专用令牌。 登录 [oneinai 控制台](https://api.oneinai.com/console/token)，创建 Gemini CLI 专用令牌即可。
### 配置文件位置 ### 配置文件位置
* Windows: `%USERPROFILE%\\.gemini\\` - Windows：`%USERPROFILE%\.gemini\`
* macOS/Linux: `~/.gemini/` - macOS / Linux：`~/.gemini/`
### 更多问题 ### 更多问题
请查看 [FAQ](</support/faq>) 或联系[售后支持](</support/after-sales>)。 请查看 [FAQ](/support/faq)

544
apidoc/deploy/nano-banana.md
View File

@ -1,74 +1,74 @@
# ![NanoBanana](https://docs.ikuncode.cc/images/nano.png) NanoBanana 图像生成部署指南 # ![NanoBanana](https://minio.oneinai.com/oneinai/images/docs/nano-banana/nano-banana01.png) NanoBanana 图像生成部署指南
**通过 OneinAI 调用 Gemini 原生图像生成 API** **通过 oneinai 调用 Gemini 原生图像生成 API**
资源| 地址 | 资源 | 地址 |
---|--- | --- | --- |
OneinAI 平台| [api.ikuncode.cc](<https://api.oneinai.com>) | oneinai 平台 | <https://api.oneinai.com> |
| oneinai 控制台 | <https://api.oneinai.com/console/token> |
📋 简介 ## 📋 简介
NanoBanana 是 OneinAI 提供的 Gemini 图像生成模型系列。通过 OneinAI 的 API Key 即可直接调用，无需科学上网，无需谷歌账号。 NanoBanana 是 oneinai 提供的 Gemini 图像生成模型系列。通过 oneinai 的 API Key 即可直接调用，无需科学上网，无需谷歌账号。
## 🎯 模型介绍 ## 🎯 模型介绍
OneinAI 提供两个 NanoBanana 模型： oneinai 提供两个 NanoBanana 模型：
模型| 模型 ID| 特点| 适用场景 | 模型 | 模型 ID | 特点 | 适用场景 |
---|---|---|--- | --- | --- | --- | --- |
**NanoBananaPro**| `gemini-3-pro-image-preview`| 效果最佳，支持高清输出| 高质量海报、商业素材、精细创作 | **NanoBananaPro** | `gemini-3-pro-image-preview` | 效果最佳，支持高清输出 | 高质量海报、商业素材、精细创作 |
**NanoBanana2**| `gemini-3.1-flash-image-preview`| 速度快、价格低| 快速预览、批量生成、日常使用 | **NanoBanana2** | `gemini-3.1-flash-image-preview` | 速度快、价格低 | 快速预览、批量生成、日常使用 |
💡 如何选择 > 💡 **如何选择**
> - 追求**画质**：选 NanoBananaPro（Pro 版）
* 追求**画质** ：选 NanoBananaPro（Pro 版） > - 追求**速度和性价比**：选 NanoBanana2（Flash 版）
* 追求**速度和性价比** ：选 NanoBanana2（Flash 版）
## 📐 支持的宽高比 ## 📐 支持的宽高比
两个模型均支持以下 **10 种宽高比** ： 两个模型均支持以下 **10 种宽高比**：
宽高比| 说明| 宽高比| 说明 | 宽高比 | 说明 | 宽高比 | 说明 |
---|---|---|--- | --- | --- | --- | --- |
**1:1**| 正方形图片| **3:2**| 相机常用比例（横） | **1:1** | 正方形图片 | **3:2** | 相机常用比例（横） |
**16:9**| 横屏标准比例| **2:3**| 相机常用比例（竖） | **16:9** | 横屏标准比例 | **2:3** | 相机常用比例（竖） |
**9:16**| 竖屏标准比例| **21:9**| 超宽屏比例 | **9:16** | 竖屏标准比例 | **21:9** | 超宽屏比例 |
**4:3**| 传统横屏比例| **5:4**| 显示器比例（横） | **4:3** | 传统横屏比例 | **5:4** | 显示器比例（横） |
**3:4**| 传统竖屏比例| **4:5**| 显示器比例（竖） | **3:4** | 传统竖屏比例 | **4:5** | 显示器比例（竖） |
## 📏 支持的分辨率 ## 📏 支持的分辨率
每种宽高比支持三种分辨率等级： 每种宽高比支持三种分辨率等级。
### 1K 分辨率（快速预览） ### 1K 分辨率（快速预览）
宽高比| 分辨率| 宽高比| 分辨率 | 宽高比 | 分辨率 | 宽高比 | 分辨率 |
---|---|---|--- | --- | --- | --- | --- |
1:1| 1024×1024| 3:2| 1232×816 | 1:1 | 1024×1024 | 3:2 | 1232×816 |
16:9| 1376×768| 2:3| 816×1232 | 16:9 | 1376×768 | 2:3 | 816×1232 |
9:16| 768×1376| 21:9| 1584×672 | 9:16 | 768×1376 | 21:9 | 1584×672 |
4:3| 1200×896| 5:4| 1136×896 | 4:3 | 1200×896 | 5:4 | 1136×896 |
3:4| 896×1200| 4:5| 896×1136 | 3:4 | 896×1200 | 4:5 | 896×1136 |
### 2K 分辨率（推荐使用） ### 2K 分辨率（推荐使用）
宽高比| 分辨率| 宽高比| 分辨率 | 宽高比 | 分辨率 | 宽高比 | 分辨率 |
---|---|---|--- | --- | --- | --- | --- |
1:1| 2048×2048| 3:2| 2464×1632 | 1:1 | 2048×2048 | 3:2 | 2464×1632 |
16:9| 2752×1536| 2:3| 1632×2464 | 16:9 | 2752×1536 | 2:3 | 1632×2464 |
9:16| 1536×2752| 21:9| 3168×1344 | 9:16 | 1536×2752 | 21:9 | 3168×1344 |
4:3| 2400×1792| 5:4| 2272×1792 | 4:3 | 2400×1792 | 5:4 | 2272×1792 |
3:4| 1792×2400| 4:5| 1792×2272 | 3:4 | 1792×2400 | 4:5 | 1792×2272 |
### 4K 分辨率（超高清） ### 4K 分辨率（超高清）
宽高比| 分辨率| 宽高比| 分辨率 | 宽高比 | 分辨率 | 宽高比 | 分辨率 |
---|---|---|--- | --- | --- | --- | --- |
1:1| 4096×4096| 3:2| 4928×3264 | 1:1 | 4096×4096 | 3:2 | 4928×3264 |
16:9| 5504×3072| 2:3| 3264×4928 | 16:9 | 5504×3072 | 2:3 | 3264×4928 |
9:16| 3072×5504| 21:9| 6336×2688 | 9:16 | 3072×5504 | 21:9 | 6336×2688 |
4:3| 4800×3584| 5:4| 4544×3584 | 4:3 | 4800×3584 | 5:4 | 4544×3584 |
3:4| 3584×4800| 4:5| 3584×4544 | 3:4 | 3584×4800 | 4:5 | 3584×4544 |
## 🔧 API 请求格式 ## 🔧 API 请求格式
@ -76,337 +76,193 @@ NanoBanana 使用**谷歌原生格式** API，与 OpenAI 格式不同。
### 基本请求结构 ### 基本请求结构
json ```json
{
"contents": [{
{ "parts": [
"contents": [{ { "text": "你的图片描述" }
"parts": [ ]
{ "text": "您的图片描述" } }],
] "generationConfig": {
}], "responseModalities": ["IMAGE"],
"generationConfig": { "imageConfig": {
"responseModalities": ["IMAGE"], "aspectRatio": "16:9",
"imageConfig": { "image_size": "2K"
"aspectRatio": "16:9",
"image_size": "2K"
}
}
} }
}
1 }
2 ```
3
4
5
6
7
8
9
10
11
12
13
14
### 参数说明 ### 参数说明
参数| 说明| 可选值 | 参数 | 说明 | 可选值 |
---|---|--- | --- | --- | --- |
`responseModalities`| 响应类型，必须设为图片| `["IMAGE"]` | `responseModalities` | 响应类型，必须设为图片 | `["IMAGE"]` |
`aspectRatio`| 宽高比| `1:1`、`16:9`、`9:16`、`4:3`、`3:4`、`3:2`、`2:3`、`21:9`、`5:4`、`4:5` | `aspectRatio` | 宽高比 | `1:1`、`16:9`、`9:16`、`4:3`、`3:4`、`3:2`、`2:3`、`21:9`、`5:4`、`4:5` |
`image_size`| 分辨率等级| `1K`、`2K`、`4K` | `image_size` | 分辨率等级 | `1K`、`2K`、`4K` |
### API 端点 ### API 端点
```
POST https://api.oneinai.com/v1beta/models/{模型ID}:generateContent
```
POST https://api.oneinai.com/v1beta/models/{模型ID}:generateContent - NanoBananaPro：`gemini-3-pro-image-preview`
- NanoBanana2：`gemini-3.1-flash-image-preview`
1
* NanoBananaPro：`gemini-3-pro-image-preview`
* NanoBanana2：`gemini-3.1-flash-image-preview`
## 📝 示例代码 ## 📝 示例代码
### cURL 示例 ### cURL 示例
bash ```bash
curl -X POST "https://api.oneinai.com/v1beta/models/gemini-3-pro-image-preview:generateContent" \
-H "Authorization: Bearer sk-你的oneinai密钥" \
curl -X POST "https://api.oneinai.com/v1beta/models/gemini-3-pro-image-preview:generateContent" \\ -H "Content-Type: application/json" \
-H "Authorization: Bearer sk-你的OneinAI密钥" \\ -d '{
-H "Content-Type: application/json" \\ "contents": [{
-d '{ "parts": [
"contents": [{ {"text": "一只可爱的小猫咪坐在花园里，油画风格，高清，细节丰富"}
"parts": [ ]
{"text": "一只可爱的小猫咪坐在花园里，油画风格，高清，细节丰富"} }],
] "generationConfig": {
}], "responseModalities": ["IMAGE"],
"generationConfig": { "imageConfig": {
"responseModalities": ["IMAGE"], "aspectRatio": "16:9",
"imageConfig": { "image_size": "2K"
"aspectRatio": "16:9", }
"image_size": "2K" }
} }'
} ```
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
### Python 示例 ### Python 示例
python ```python
import requests
import base64
API_KEY = "sk-你的oneinai密钥"
API_URL = "https://api.oneinai.com/v1beta/models/gemini-3-pro-image-preview:generateContent"
import requests payload = {
import base64 "contents": [{
"parts": [
API_KEY = "sk-你的OneinAI密钥" {"text": "一只可爱的小猫咪坐在花园里，油画风格，高清，细节丰富"}
API_URL = "https://api.oneinai.com/v1beta/models/gemini-3-pro-image-preview:generateContent" ]
}],
payload = { "generationConfig": {
"contents": [{ "responseModalities": ["IMAGE"],
"parts": [ "imageConfig": {
{"text": "一只可爱的小猫咪坐在花园里，油画风格，高清，细节丰富"} "aspectRatio": "16:9",
] "image_size": "2K"
}],
"generationConfig": {
"responseModalities": ["IMAGE"],
"imageConfig": {
"aspectRatio": "16:9",
"image_size": "2K"
}
} }
} }
}
headers = { headers = {
"Authorization": f"Bearer {API_KEY}", "Authorization": f"Bearer {API_KEY}",
"Content-Type": "application/json" "Content-Type": "application/json"
} }
response = requests.post(API_URL, headers=headers, json=payload, timeout=600) response = requests.post(API_URL, headers=headers, json=payload, timeout=600)
if response.status_code == 200: if response.status_code == 200:
data = response.json() data = response.json()
image_base64 = data["candidates"][0]["content"]["parts"][0]["inlineData"]["data"] image_base64 = data["candidates"][0]["content"]["parts"][0]["inlineData"]["data"]
# 保存图片 with open("output.png", "wb") as f:
with open("output.png", "wb") as f: f.write(base64.b64decode(image_base64))
f.write(base64.b64decode(image_base64)) print("图片已保存为 output.png")
print("图片已保存为 output.png") else:
else: print(f"请求失败: {response.status_code}")
print(f"请求失败: {response.status_code}") print(response.text)
print(response.text) ```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
### Node.js 示例 ### Node.js 示例
javascript ```javascript
const fs = require('fs');
const API_KEY = 'sk-你的oneinai密钥';
const API_URL = 'https://api.oneinai.com/v1beta/models/gemini-3-pro-image-preview:generateContent';
const fs = require('fs'); async function generateImage() {
const response = await fetch(API_URL, {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
contents: [{
parts: [
{ text: '一只可爱的小猫咪坐在花园里，油画风格，高清，细节丰富' }
]
}],
generationConfig: {
responseModalities: ['IMAGE'],
imageConfig: {
aspectRatio: '16:9',
image_size: '2K'
}
}
})
});
const API_KEY = 'sk-你的OneinAI密钥'; const data = await response.json();
const API_URL = 'https://api.oneinai.com/v1beta/models/gemini-3-pro-image-preview:generateContent'; const imageBase64 = data.candidates[0].content.parts[0].inlineData.data;
async function generateImage() { fs.writeFileSync('output.png', Buffer.from(imageBase64, 'base64'));
const response = await fetch(API_URL, { console.log('图片已保存为 output.png');
method: 'POST', }
headers: {
'Authorization': \`Bearer \${API_KEY}\`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
contents: [{
parts: [
{ text: '一只可爱的小猫咪坐在花园里，油画风格，高清，细节丰富' }
]
}],
generationConfig: {
responseModalities: ['IMAGE'],
imageConfig: {
aspectRatio: '16:9',
image_size: '2K'
}
}
})
});
const data = await response.json(); generateImage().catch(console.error);
const imageBase64 = data.candidates[0].content.parts[0].inlineData.data; ```
fs.writeFileSync('output.png', Buffer.from(imageBase64, 'base64'));
console.log('图片已保存为 output.png');
}
generateImage().catch(console.error);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
## 🖼️ 图生图编辑 ## 🖼️ 图生图编辑
NanoBananaPro 还支持**图生图** 功能，上传一张图片并描述编辑指令，即可对图片进行修改。 NanoBananaPro 还支持**图生图**功能，上传一张图片并描述编辑指令，即可对图片进行修改。
json ```json
{
"contents": [{
{ "parts": [
"contents": [{ {
"parts": [ "inlineData": {
{ "mimeType": "image/png",
"inlineData": { "data": "图片的Base64编码字符串"
"mimeType": "image/png",
"data": "图片的Base64编码字符串"
}
},
{ "text": "将背景改为星空，保持人物不变" }
]
}],
"generationConfig": {
"responseModalities": ["IMAGE"],
"imageConfig": {
"aspectRatio": "16:9",
"image_size": "2K"
} }
} },
{ "text": "将背景改为星空，保持人物不变" }
]
}],
"generationConfig": {
"responseModalities": ["IMAGE"],
"imageConfig": {
"aspectRatio": "16:9",
"image_size": "2K"
} }
}
}
```
1 > 💡 **图生图使用技巧**
2 > - 编辑指令要**具体明确**，说清楚保留什么、修改什么
3 > - 支持换背景、改风格、加元素、去水印等操作
4 > - 图片需要转为 Base64 编码后放入 `inlineData.data` 字段
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
💡 图生图使用技巧
* 编辑指令要**具体明确** ，说清楚保留什么、修改什么
* 支持换背景、改风格、加元素、去水印等操作
* 图片需要转为 Base64 编码后放入 `inlineData.data` 字段
## 🤖 在 Claude Code 中使用 ## 🤖 在 Claude Code 中使用
如果您已安装 [ikunimage Skill](</skills/ikunimage>)，可以在 Claude Code 对话中直接使用自然语言生成图片，无需手动调用 API。 如果你已安装 oneimage Skill，可以在 Claude Code 对话中直接使用自然语言生成图片，无需手动调用 API。
```
> 用 oneinai 画一张赛博朋克风格的城市夜景，16:9 比例，2K 分辨率
> 用 ikun 画一张赛博朋克风格的城市夜景，16:9 比例，2K 分辨率 > oneinai 生成一张水墨风格的山水画，竖屏 9:16
> ikun 生成一张水墨风格的山水画，竖屏 9:16 > 用 oneinai 编辑这张图片 /path/to/image.png，把背景换成海边日落
```
> 用 ikun 编辑这张图片 /path/to/image.png，把背景换成海边日落 详细安装和使用说明请参考 oneimage AI 生图技能文档。
1
2
3
4
5
详细安装和使用说明请参考：[ikunimage AI 生图](</skills/ikunimage>)
## ⏱️ 性能建议 ## ⏱️ 性能建议
@ -414,24 +270,24 @@ json
不同分辨率的处理时间差异较大，建议设置合理的超时： 不同分辨率的处理时间差异较大，建议设置合理的超时：
分辨率| 推荐超时| 适用场景 | 分辨率 | 推荐超时 | 适用场景 |
---|---|--- | --- | --- | --- |
**1K**| 360 秒（6 分钟）| 快速预览、测试效果 | **1K** | 360 秒（6 分钟） | 快速预览、测试效果 |
**2K**| 600 秒（10 分钟）| 日常使用（推荐） | **2K** | 600 秒（10 分钟） | 日常使用（推荐） |
**4K**| 1200 秒（20 分钟）| 超高清输出、商业用途 | **4K** | 1200 秒（20 分钟） | 超高清输出、商业用途 |
### 带宽注意 ### 带宽注意
图片数据使用 Base64 编码传输，数据量较大： 图片数据使用 Base64 编码传输，数据量较大：
* 建议使用**稳定高速的网络连接** - 建议使用**稳定高速的网络连接**
* 4K 图片的 Base64 数据可能超过 **10MB** - 4K 图片的 Base64 数据可能超过 **10MB**
* 避免在网络高峰时段生成 4K 图片 - 避免在网络高峰时段生成 4K 图片
## ⚠️ 注意事项 ## ⚠️ 注意事项
1. **API Key** ：需从 [OneinAI 平台](<https://api.oneinai.com>) 创建支持图像模型的令牌 1. **API Key**：需从 [oneinai 平台](https://api.oneinai.com) 创建支持图像模型的令牌
2. **API 格式** ：NanoBanana 使用**谷歌原生格式** ，不是 OpenAI 兼容格式，请注意区分 2. **API 格式**：NanoBanana 使用**谷歌原生格式**，不是 OpenAI 兼容格式，请注意区分
3. **分辨率与耗时** ：分辨率越高，生成时间越长，请根据实际需求选择 3. **分辨率与耗时**：分辨率越高，生成时间越长，请根据实际需求选择
4. **文字渲染** ：支持在图片中渲染中文文字（如招牌、海报文案），在 prompt 中直接写明即可 4. **文字渲染**：支持在图片中渲染中文文字（如招牌、海报文案），在 prompt 中直接写明即可
5. **价格差异** ：不同模型和分辨率价格不同，详见 OneinAI 平台定价页面 5. **价格差异**：不同模型和分辨率价格不同，详见 oneinai 平台定价页面

50
apidoc/guide/create-key.md
View File

@ -4,42 +4,36 @@
## 创建步骤 ## 创建步骤
1. 登录 OneinAI 平台 1. 登录 oneinai 平台
2. 访问"[令牌管理](<https://api.oneinai.com/console/token>)" 2. 访问 [令牌管理](https://api.oneinai.com/console/token)
3. 点击"添加令牌"按钮 3. 点击「添加令牌」按钮
4. 创建需要使用的令牌，不要选择用户分组，请根据[监测站](<https://status.ikuncode.cc/>)的模型状态和令牌说明、倍率综合选择适合您的分组。 4. 创建需要使用的令牌，**不要选择用户分组**。请根据[监测站](https://status.oneinai.com/)的模型状态、令牌说明与倍率综合选择适合你的分组
5. 保存并复制 Key 5. 保存并复制 Key
💡 小提示 > 💡 **小提示**
> **模型限制列表**留空即可，无需配置（除非你了解它的作用）。
**模型限制列表** 留空即可，不需要配置。除非您看懂了它的作用。
## 安全建议 ## 安全建议
🔐 安全提醒 > 🔐 **安全提醒**
> - **不要**将 Key 分享给他人
* **不要** 将 Key 分享给他人 > - **不要**将 Key 提交到代码仓库
* **不要** 将 Key 提交到代码仓库 > - **不要**在公开场合展示 Key
* **不要** 在公开场合展示 Key > - 询问配置是否正确时，请给 Key 打码
* 询问配置是否正确时，给Key打码 > - 使用环境变量或配置文件存储 Key
* 使用环境变量或配置文件存储 Key > - 定期更换 Key 提高安全性
* 定期更换 Key 提高安全性
## 保存 Key ## 保存 Key
创建成功后，请立即保存好您的 Key： 创建成功后，请立即保存好你的 Key：
bash ```bash
# 示例 Key（请替换为你的实际 Key）
sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# 示例 Key（请替换为您的实际 Key） ```
sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
1
2
## 下一步 ## 下一步
* [修改令牌设置](</guide/modify-token>) \- 调整令牌参数 - [修改令牌设置](/guide/modify-token) - 调整令牌参数
* [配置环境变量](</deploy/claude-code#配置环境变量>) \- 在工具中使用 Key - [配置环境变量](/deploy/claude-code#配置环境变量) - 在工具中使用 Key
* [充值](</guide/recharge>) \- 确保账户有足够余额 - [充值](/guide/recharge) - 确保账户有足够余额

2
apidoc/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)
## 可修改的设置 ## 可修改的设置

3
apidoc/guide/recharge.md
View File

@ -88,9 +88,6 @@
* 可能享受优惠价格 * 可能享受优惠价格
* 支持开具发票 * 支持开具发票
## 联系方式
如有充值相关问题，请查看[售前售后](</support/after-sales>)页面获取联系方式。
## 下一步 ## 下一步

2
apidoc/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)
## 注册方式 ## 注册方式

6
apidoc/intro/links.md
View File

@ -6,7 +6,7 @@
## Claude Code 镜像站 ## Claude Code 镜像站
[![EasyChat](https://docs.ikuncode.cc/images/Anthropic.png)EasyChatClaude Code 免费账号网页版镜像站，无需注册即可体验 Claude 对话→](<https://easychat.top/>) [![EasyChat](https://minio.oneinai.com/oneinai/images/docs/links/links01.png)EasyChatClaude Code 免费账号网页版镜像站，无需注册即可体验 Claude 对话→](<https://easychat.top/>)
### 简介 ### 简介
@ -20,13 +20,13 @@ EasyChat 是面向 Claude 网页 Chat 使用场景推出的镜像服务，主要
打开 [EasyChat](<https://easychat.top/>) 后，页面会展示多个可用的免费共享账号卡片，点击任意一个状态为「可用」的账号即可开始对话。 打开 [EasyChat](<https://easychat.top/>) 后，页面会展示多个可用的免费共享账号卡片，点击任意一个状态为「可用」的账号即可开始对话。
![账号选择界面](https://docs.ikuncode.cc/images/jxz.png) ![账号选择界面](https://minio.oneinai.com/oneinai/images/docs/links/links02.png)
**2\. 开始聊天** **2\. 开始聊天**
进入后即为标准的 Claude 聊天界面，支持中文对话、多轮上下文、代码生成等全部功能。 进入后即为标准的 Claude 聊天界面，支持中文对话、多轮上下文、代码生成等全部功能。
![聊天界面](https://docs.ikuncode.cc/images/ltjm.png) ![聊天界面](https://minio.oneinai.com/oneinai/images/docs/links/links03.png)
注意 注意

1
apidoc/intro/overview.md
View File

@ -72,4 +72,3 @@ OneinAI 作为中间层：
* [注册账号](</guide/registration>)开始使用 * [注册账号](</guide/registration>)开始使用
* 查看[常见问题](</support/faq>)了解更多 * 查看[常见问题](</support/faq>)了解更多
* 联系[售后支持](</support/after-sales>)获取帮助

2
apidoc/intro/welcome.md
View File

@ -1,6 +1,6 @@
# 欢迎使用 OneinAI！ # 欢迎使用 OneinAI！
OneinAI 是一家专注于给编码人员生产提效的中转站（目前主要是 Claude Code、Codex等服务），我们始终坚持"真诚 热爱"的服务理念，希望能和用户交朋友。有任何服务不周到、用得不爽的地方，请直接联系（见[售前售后](</support/after-sales>)）我们的服务人员。 OneinAI 是一家专注于给编码人员生产提效的中转站（目前主要是 Claude Code、Codex等服务），我们始终坚持"真诚 热爱"的服务理念，希望能和用户交朋友。有任何服务不周到、用得不爽的地方，请直接联系我们的服务人员。
💡 提示 💡 提示

2
apidoc/node/windows.md
View File

@ -13,7 +13,7 @@ Claude Code、CodeX 和 Gemini CLI 都需要 Node.js 18+ 运行环境。 如果
3. 运行安装包，采用默认配置完成安装 3. 运行安装包，采用默认配置完成安装
4. 安装程序会自动配置系统 PATH 环境变量 4. 安装程序会自动配置系统 PATH 环境变量
![NodeJS下载页面](https://docs.ikuncode.cc/images/tu4.png) ![NodeJS下载页面](https://minio.oneinai.com/oneinai/images/docs/windows/windows01.png)
## 方法二：包管理器安装 ## 方法二：包管理器安装

202
apidoc/skills/ikuncode-aimcp.md
View File

@ -1,202 +0,0 @@
# ikuncode-aimcp - 统一 AI MCP 服务器
**一个二进制，三套 AI 引擎 — Gemini · Codex · Grok**
📋 简介
ikuncode-aimcp 是一个用 Rust 编写的统一 MCP 服务器，将 Gemini CLI、Codex CLI 和 Grok Search 整合到单个进程中。配置一次，即可在 Cursor / Windsurf / Claude Desktop 等任意 MCP 客户端中使用全部工具。
## 🔗 相关链接
资源| 地址
---|---
GitHub 仓库| [xuxu777xu/ikuncode-aimcp](<https://github.com/xuxu777xu/ikuncode-aimcp>)
ikun API| [api.ikuncode.cc](<https://api.oneinai.com>)
## ✨ 功能特点
* ✅ **一个二进制，全部工具** ：只需配置一个 MCP 服务器，取代三个独立安装
* ✅ **运行时检测** ：启动时自动检测可用工具，不可用的工具返回清晰错误信息
* ✅ **AdaptiveStdio 传输** ：自动检测 JSONL 和 LSP 帧格式，最大化客户端兼容性
* ✅ **纯 Rust GrokSearch** ：零 Python 依赖，通过 Grok API 实现 Web 搜索和内容抓取
* ✅ **Gemini 图像生成** ：内置 `gemini_image` 工具，支持宽高比和分辨率控制
## 🧰 工具列表
工具| 来源| 描述
---|---|---
`gemini`| Gemini CLI| AI 驱动的任务执行，支持会话连续性
`gemini_image`| Gemini CLI| AI 图像生成，使用专用生图模型
`codex`| Codex CLI| AI 辅助编码，支持沙箱策略
`web_search`| Grok API| Web 搜索，返回结构化 JSON 结果
`web_fetch`| Grok API| 抓取网页内容并转为 Markdown
`get_config_info`| Grok API| 显示配置信息并测试 API 连接
### 相关项目
项目| 类型| 适用场景
---|---|---
**ikuncode-aimcp** （本项目）| MCP Server| 所有 MCP 客户端通用，含 gemini_image 图像生成
[ikunimage](</skills/ikunimage>)| Claude Code Skill| Claude Code 专用 — 文生图 / 图生图 / 并发批量生成
## 🛠️ 安装
### 方式一：下载预编译二进制（推荐）
从 [GitHub Releases](<https://github.com/xuxu777xu/ikuncode-aimcp/releases>) 下载对应平台的二进制文件：
平台| 文件名
---|---
Windows x64| `ikuncode-aimcp-x86_64-pc-windows-msvc.exe`
macOS Apple Silicon| `ikuncode-aimcp-aarch64-apple-darwin`
macOS Intel| `ikuncode-aimcp-x86_64-apple-darwin`
Linux x64| `ikuncode-aimcp-x86_64-unknown-linux-gnu`
下载后放到 `PATH` 目录中即可使用。macOS / Linux 需要添加执行权限：
bash
chmod +x ikuncode-aimcp-*
mv ikuncode-aimcp-* /usr/local/bin/ikuncode-aimcp
1
2
### 方式二：npm 安装
bash
npm install -g ikuncode-aimcp
1
### 方式三：cargo 安装
bash
cargo install --git https://github.com/xuxu777xu/ikuncode-aimcp.git
1
### 方式四：从源码编译
bash
git clone https://github.com/xuxu777xu/ikuncode-aimcp.git
cd ikuncode-aimcp
cargo build --release
# 二进制文件在 target/release/ 目录下
1
2
3
4
## ⚙️ 配置 MCP 客户端
在你的 MCP 客户端（如 Claude Desktop、Cursor、Windsurf 等）中添加以下配置：
json
{
"mcpServers": {
"ikuncode-aimcp": {
"command": "ikuncode-aimcp",
"env": {
"GEMINI_API_KEY": "你的-gemini-api-key",
"GROK_API_KEY": "你的-grok-api-key"
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
⚠️ 环境变量说明
* `GEMINI_API_KEY`：用于 Gemini 相关工具（`gemini`、`gemini_image`）
* `GROK_API_KEY`：用于 Grok 搜索工具（`web_search`、`web_fetch`）
* Codex 工具使用独立配置，请参考 [Codex 部署文档](</deploy/codex>)
## 📖 工具使用说明
### gemini — AI 任务执行
参数| 必填| 类型| 默认值| 描述
---|---|---|---|---
`PROMPT`| 是| string| —| 发送给 Gemini 的任务指令
`sandbox`| 否| bool| false| 在沙箱模式下运行
`SESSION_ID`| 否| string| —| 恢复已有会话，用于多轮对话
`model`| 否| string| —| 模型覆盖
`timeout_secs`| 否| int| 600| 超时时间（1–3600 秒）
### gemini_image — 图像生成
参数| 必填| 类型| 默认值| 描述
---|---|---|---|---
`PROMPT`| 是| string| —| 图像生成指令
`model`| 否| string| —| 模型覆盖
`output_dir`| 否| string| —| 图片保存目录
`aspect_ratio`| 否| string| —| 宽高比（1:1 / 16:9 / 9:16 等）
`image_size`| 否| string| —| 分辨率（1K / 2K / 4K）
`timeout_secs`| 否| int| 600| 超时时间（1–3600 秒）
### codex — AI 辅助编码
参数| 必填| 类型| 默认值| 描述
---|---|---|---|---
`PROMPT`| 是| string| —| 发送给 Codex 的任务指令
`cd`| 是| string| —| 工作目录路径
`sandbox`| 否| string| `read-only`| 沙箱策略
### web_search — Web 搜索
参数| 必填| 类型| 默认值| 描述
---|---|---|---|---
`query`| 是| string| —| 自然语言搜索查询
`platform`| 否| string| —| 聚焦特定平台
`min_results`| 否| int| 3| 最少返回结果数
`max_results`| 否| int| 10| 最多返回结果数
### web_fetch — 网页内容抓取
参数| 必填| 类型| 默认值| 描述
---|---|---|---|---
`url`| 是| string| —| 有效的 HTTP/HTTPS 网址
### get_config_info — Grok 配置诊断
无参数。返回当前 Grok 配置信息并测试 API 连接。
## 常见问题
### 安装后命令找不到？
确认二进制文件已放到 `PATH` 目录中，且有执行权限。可运行 `which ikuncode-aimcp` 检查。
### Gemini 工具不可用？
检查 `GEMINI_API_KEY` 环境变量是否正确设置，以及本地是否安装了 Gemini CLI。
### Grok 搜索返回错误？
运行 `get_config_info` 工具检查 API 配置和连接状态。
### 更多问题
请查看 [FAQ](</support/faq>) 或联系[售后支持](</support/after-sales>)。

312
apidoc/skills/ikunimage.md
View File

@ -1,312 +0,0 @@
# ikunimage - AI 图片生成器
**Claude Code Skill — 通过 ikun API 调用 Gemini 图像模型，支持文生图与图生图**
📋 简介
ikunimage 是一款 Claude Code Skill 插件，通过 [ikun API](<https://api.oneinai.com>) 调用 **NanoBananaPro（Gemini 3 Pro Image Preview）** 模型，在 Claude Code 对话中直接生成高质量图片。支持文生图、图生图编辑、批量并发等多种模式。
## 🔗 相关链接
资源| 地址
---|---
GitHub 仓库| [deijing/ikunimage](<https://github.com/deijing/ikunimage>)
ikun API| [api.ikuncode.cc](<https://api.oneinai.com>)
## ✨ 功能特点
* ✅ **文生图** ：用自然语言描述场景，AI 生成对应图片
* ✅ **图生图** ：上传本地图片 + 编辑描述，AI 修改生成新图片
* ✅ **10 种宽高比** ：1:1 / 16:9 / 9:16 / 4:3 / 3:4 / 3:2 / 2:3 / 21:9 / 5:4 / 4:5
* ✅ **3 档分辨率** ：1K（快速预览）/ 2K（推荐）/ 4K（超高清）
* ✅ **文字渲染** ：支持在图片中渲染中文文字（招牌、海报、标语等）
* ✅ **并发批量** ：多张图片并发生成，大幅缩短总耗时
* ✅ **配置文件管理** ：API Key 存储在本地配置文件，安全便捷
## 📋 前置要求
* [Claude Code](<https://docs.anthropic.com/en/docs/claude-code>) CLI 已安装
* Python 3.10+
* ikun API Key（从 [api.ikuncode.cc](<https://api.oneinai.com>) 获取）
## 🛠️ 安装
### 第一步：下载 Skill
bash
# 如果目录不存在，先创建
mkdir -p ~/.claude/skills
# 克隆 ikunimage 到 skills 目录
cd ~/.claude/skills
git clone https://github.com/deijing/ikunimage.git
1
2
3
4
5
6
安装完成后目录结构如下：
~/.claude/skills/ikunimage/
├── SKILL.md # Skill 定义文件
├── scripts/
│ ├── generate_ikun.py # 文生图脚本
│ └── generate_ikun_edit.py # 图生图脚本
└── references/
└── api-reference.md # API 参考文档
1
2
3
4
5
6
7
### 第二步：安装依赖
bash
pip install httpx
1
### 第三步：配置 API Key
三种方式任选其一：
**方式 A：交互式配置（推荐）**
bash
python ~/.claude/skills/ikunimage/scripts/generate_ikun.py --setup
1
按提示输入你的 API Key 即可，配置会保存到 `~/.ikunimage/config.json`。
**方式 B：手动创建配置文件**
bash
mkdir -p ~/.ikunimage
echo '{"api_key": "sk-你的key"}' > ~/.ikunimage/config.json
1
2
**方式 C：环境变量**
bash
export IKUN_API_KEY="sk-你的key"
1
💡 API Key 加载优先级
`--api-key` 命令行参数 > `IKUN_API_KEY` 环境变量 > `~/.ikunimage/config.json` 配置文件
## 📖 使用方法
### 在 Claude Code 中使用
安装配置完成后，在 Claude Code 对话中输入：
/ikunimage
1
然后描述你想要的图片即可。例如：
* "画一张江南水乡的风景"
* "生成一张 4K 超宽屏的故宫雪景"
* "批量生成 5 张不同风格的古风人像"
图生图编辑：
* "编辑 /path/to/photo.jpg，把背景改成竹林"
### 独立脚本使用
也可以脱离 Claude Code，直接在命令行中调用。
**文生图** ：
bash
python ~/.claude/skills/ikunimage/scripts/generate_ikun.py \\
-p "一位中国女性，身穿汉服，站在竹林中，晨雾缭绕" \\
-ar 3:4 \\
-s 2K \\
-o ./output.png
1
2
3
4
5
**图生图** ：
bash
python ~/.claude/skills/ikunimage/scripts/generate_ikun_edit.py \\
-i ./photo.jpg \\
-p "将背景改为雪景，保持人物不变" \\
-ar 3:4 \\
-o ./edited.png
1
2
3
4
5
**批量生成** ：
bash
# 准备任务文件 tasks.json
cat > tasks.json << 'EOF'
[
{"prompt": "描述1", "aspect_ratio": "3:4", "size": "2K", "output": "./out1.png"},
{"prompt": "描述2", "aspect_ratio": "16:9", "size": "1K", "output": "./out2.png"}
]
EOF
# 执行批量生成
python ~/.claude/skills/ikunimage/scripts/generate_ikun.py \\
--batch tasks.json \\
--workers 2
1
2
3
4
5
6
7
8
9
10
11
12
## 📐 参数速查
### 文生图 (generate_ikun.py)
参数| 简写| 说明| 默认值
---|---|---|---
`--setup`| | 交互式配置 API Key|
`--api-key`| | 指定 API Key| 从配置加载
`--prompt`| `-p`| 图片描述（必填）|
`--aspect-ratio`| `-ar`| 宽高比| `1:1`
`--size`| `-s`| 分辨率（1K/2K/4K）| `2K`
`--output`| `-o`| 输出路径| `output.png`
`--batch`| `-b`| 批量任务 JSON 文件|
`--workers`| `-w`| 并发数| 自动（默认 2）
`--retry`| `-r`| 重试次数（0-10）| `3`
### 图生图 (generate_ikun_edit.py)
参数| 简写| 说明| 默认值
---|---|---|---
`--setup`| | 交互式配置 API Key|
`--api-key`| | 指定 API Key| 从配置加载
`--input`| `-i`| 输入图片路径（必填）|
`--prompt`| `-p`| 编辑描述（必填）|
`--aspect-ratio`| `-ar`| 输出宽高比| `1:1`
`--output`| `-o`| 输出路径| `output.png`
`--batch`| `-b`| 批量任务 JSON 文件|
`--workers`| `-w`| 并发数| 自动（默认 2）
`--retry`| `-r`| 重试次数（0-10）| `3`
⚠️ 互斥参数
`--prompt` 和 `--batch` 互斥，单图模式和批量模式必须二选一。
## 📊 分辨率参考
### 1K（快速预览）
宽高比| 分辨率
---|---
1:1| 1024×1024
16:9| 1376×768
9:16| 768×1376
4:3| 1200×896
3:4| 896×1200
### 2K（推荐）
宽高比| 分辨率
---|---
1:1| 2048×2048
16:9| 2752×1536
9:16| 1536×2752
4:3| 2400×1792
3:4| 1792×2400
### 4K（超高清）
宽高比| 分辨率
---|---
1:1| 4096×4096
16:9| 5504×3072
9:16| 3072×5504
4:3| 4800×3584
3:4| 3584×4800
## 🖼️ 图生图支持格式
格式| 支持| 备注
---|---|---
JPG / JPEG| ✅| 推荐
PNG| ✅| 推荐
WebP| ✅|
GIF| ✅| 仅使用第一帧
💡 建议
图片大小推荐 < 4MB，过大可能导致上传变慢或超时。
## 常见问题
### 提示 "未找到 API Key"？
运行交互式配置命令：
bash
python ~/.claude/skills/ikunimage/scripts/generate_ikun.py --setup
1
### 请求超时？
4K 图片生成较慢，脚本已设置充足的超时时间。如果仍然超时，可降低分辨率到 2K 或 1K。
### 收到 429 错误？
触发了 API 频率限制。脚本会自动指数退避重试（默认 3 次）。可加 `--retry 5` 增加重试次数。
### 更多问题
请查看 [FAQ](</support/faq>) 或联系[售后支持](</support/after-sales>)。

89
apidoc/support/after-sales.md
View File

@ -1,89 +0,0 @@
# 售前售后
有任何不懂的，可以进群咨询，可提供人工一对一服务。
## 联系方式
### Telegram 群组
**推荐方式** ：加入我们的 Telegram 群组，快速获得帮助。
* **群组链接** ：<https://t.me/ikuncode>
群内可以：
* 咨询使用问题
* 反馈bug和建议
* 获取最新消息
* 与其他用户交流
### QQ 群
* **QQ 群号** ：请扫描下方二维码加入
### 扫码加群
![联系方式二维码](https://docs.ikuncode.cc/images/tu5.png)
## 服务时间
* **工作日** ：9:00 - 00:00
* **节假日** ：11:00 - 00:00
💡 提示
紧急问题建议在工作时间联系，响应更快。
## 服务内容
### 售前咨询
* 产品功能介绍
* 价格方案说明
* 技术可行性咨询
* 企业方案定制
### 售后支持
* 使用问题解答
* 技术故障排查
* 配置指导
* 一对一人工服务
### 企业服务
如需企业服务，请联系客服
## 常见问题快速通道
在联系客服前，建议先查看：
* [常见问题 FAQ](</support/faq>)
* [部署指南](</deploy/claude-code>)
* [配置工具](</tools/cc-switch>)
## 反馈建议
我们欢迎您的反馈和建议：
* 功能需求
* 使用体验
* 问题反馈
* 改进建议
所有反馈都会认真对待，帮助我们持续改进服务。
## 服务承诺
💪 我们的承诺
* **真诚服务** ：坦诚沟通，不夸大宣传
* **热爱产品** ：持续优化，追求卓越
* **快速响应** ：及时处理问题和反馈
* **用户至上** ：以用户体验为中心
* * *
OneinAI - 真诚 热爱
我们希望能和用户交朋友

139
apidoc/support/faq.md
View File

@ -2,65 +2,58 @@
## 账号与 Key ## 账号与 Key
### 1\. 可以开发票对吧？ ### 1. 可以开发票吗？
对。支持普票、专票。累计充值满500元可提交开发票需求。 可以，支持普票和专票。累计充值满 500 元可提交开票需求。
### 2\. Key 无效/鉴权失败怎么办？ ### 2. Key 无效 / 鉴权失败怎么办？
* 检查是否复制了多余空格 - 检查是否复制了多余空格
* 检查 Key 是否过期/被禁用 - 检查 Key 是否过期或被禁用
* 检查请求是否使用了正确的 Header/参数 - 检查请求是否使用了正确的 Header / 参数
* 确认使用了对应工具的专用令牌组 - 确认使用了对应工具的专用令牌组
### 3\. 如何查看余额和消费记录？ ### 3. 如何查看余额和消费记录？
登录控制台即可查看： 登录 [oneinai 控制台](https://api.oneinai.com/console/token) 即可查看：
* 当前余额 - 当前余额
* 充值记录 - 充值记录
* 消费明细 - 消费明细
* 账单详情 - 账单详情
## 网站访问 ## 网站访问
### 网站进入为什么白屏？ ### 网站打开为什么白屏？
很有可能是你的广告过滤插件导致，请手动将我们的域名添加到白名单。 很可能是浏览器的广告过滤插件导致，请手动将我们的域名添加到白名单。
常见的广告过滤插件： 常见的广告过滤插件：
* AdBlock - AdBlock
* uBlock Origin - uBlock Origin
* AdGuard - AdGuard
解决方法： 解决方法：
1. 打开插件设置 1. 打开插件设置
2. 添加 `api.ikuncode.cc` 到白名单 2. 将 `api.oneinai.com` 添加到白名单
3. 刷新页面 3. 刷新页面
4. 尝试浏览器强制刷新（Windows：`Ctrl + Shift + R`，macOS：`Cmd + Shift + R`） 4. 必要时使用浏览器强制刷新（Windows：`Ctrl + Shift + R`，macOS：`Cmd + Shift + R`）
## 环境与安装 ## 环境与安装
### npm 安装很慢/失败？ ### npm 安装很慢 / 失败？
可以使用国内镜像： 可以切换为国内镜像：
bash ```bash
# 设置淘宝镜像
npm config set registry https://registry.npmmirror.com
# 验证配置
# 设置淘宝镜像 npm config get registry
npm config set registry https://registry.npmmirror.com ```
# 验证配置
npm config get registry
1
2
3
4
5
### Node.js 版本过低怎么办？ ### Node.js 版本过低怎么办？
@ -68,80 +61,77 @@ Claude Code、CodeX 和 Gemini CLI 都需要 Node.js 18+ 版本。
升级方法： 升级方法：
* Windows: 重新下载安装最新版本 - **Windows**：重新下载安装最新版本
* macOS: `brew upgrade node` - **macOS**：`brew upgrade node`
* Linux: 使用 nvm 或 NodeSource 仓库 - **Linux**：使用 nvm 或 NodeSource 仓库
### 环境变量设置后不生效？ ### 环境变量设置后不生效？
* Windows: 重启终端窗口或重启电脑 - **Windows**：重启终端窗口或重启电脑
* macOS/Linux: 执行 `source ~/.bashrc` 或 `source ~/.zshrc` - **macOS / Linux**：执行 `source ~/.bashrc` 或 `source ~/.zshrc`
## 工具使用 ## 工具使用
### CC-Switch 无法启动？ ### CC-Switch 无法启动？
1. 检查是否有权限问题 1. 检查是否有权限问题
2. 尝试以管理员身份运行 2. 尝试以管理员身份运行
3. 查看是否有杀毒软件拦截 3. 查看是否有杀毒软件拦截
4. 重新下载安装最新版本 4. 重新下载安装最新版本
### Claude Code 提示连接失败？ ### Claude Code 提示连接失败？
检查项： 请按顺序排查：
* 网络连接是否正常 - 网络连接是否正常
* API 密钥是否正确 - API 密钥是否正确
* 环境变量是否设置正确 - 环境变量是否设置正确
* 余额是否充足 - 余额是否充足
### CodeX 和 Claude Code 的令牌不通用？ ### CodeX 和 Claude Code 的令牌不通用？
是的，不同工具需要不同的令牌组： 是的，不同工具需要不同的令牌组：
* Claude Code: 使用 Claude Code 令牌组 - **Claude Code**：使用 Claude Code 令牌组
* CodeX: 使用 "codex测试" 令牌组 - **CodeX**：使用 `codex` 令牌组
* Gemini CLI: 使用 Gemini 令牌组 - **Gemini CLI**：使用 Gemini 令牌组
请在 IkunCode 平台创建对应的专用令牌。 请在 oneinai 平台创建对应的专用令牌。
## 计费相关 ## 计费相关
### 如何计费？ ### 如何计费？
* 按实际使用量计费 - 按实际使用量计费
* 不同模型价格不同 - 不同模型价格不同
* 详细计费规则请查看控制台 - 详细计费规则请查看控制台
### 余额不足会怎样？ ### 余额不足会怎样？
* 服务会暂停 - 服务会暂停
* 请及时充值以继续使用 - 请及时充值以继续使用
* 充值后立即恢复服务 - 充值后立即恢复服务
### 支持退款吗？ ### 支持退款吗？
* 未使用的余额可以申请退款 - 未使用的余额可以申请退款
* 已使用的部分不支持退款 - 已使用的部分不支持退款
* 具体政策请咨询客服 - 具体政策请咨询客服
## 技术问题 ## 技术问题
### 代码会被保存吗？ ### 代码会被保存吗？
不会。我们不会存储您的代码内容，仅转发请求和响应。 不会。我们不会存储你的代码内容，仅转发请求与响应。
### 是否支持企业使用？ ### 是否支持企业使用？
支持。企业用户可以： 支持。企业用户可以：
* 联系客服获取企业方案 - 联系客服获取企业方案
* 支持大额充值和发票 - 支持大额充值和开票
* 可能享受优惠价格 - 可能享受优惠价格
### 如何获得技术支持？
请查看[售前售后](</support/after-sales>)页面获取联系方式。
## 更多问题 ## 更多问题
@ -149,11 +139,10 @@ Claude Code、CodeX 和 Gemini CLI 都需要 Node.js 18+ 版本。
如果遇到启动失败、报错、超时等技术问题，请查看： 如果遇到启动失败、报错、超时等技术问题，请查看：
👉 **[疑难杂症排查指南](</support/troubleshooting>)** \- 详细的错误排查和解决方案 👉 **[疑难杂症排查指南](/support/troubleshooting)** - 详细的错误排查与解决方案
### 仍未解决？ ### 仍未解决？
如果上述问题没有解决您的疑问，请： 如果上述内容没有解决你的疑问，请联系我们：
* 加入 Telegram 群组：<https://t.me/ikuncode> - 加入 Telegram 群组：<https://t.me/oneinai>
* 查看[售前售后](</support/after-sales>)联系客服

226
apidoc/support/troubleshooting.md
View File

@ -1,20 +1,20 @@
# 疑难杂症排查指南 # 疑难杂症排查指南
本文档汇总了 Claude Code、CodeX、Gemini CLI 等 AI 编程工具的常见问题和解决方案。 本文档汇总了 Claude Code、CodeX、Gemini CLI 等 AI 编程工具在使用 oneinai 服务时的常见问题与解决方案。
## 🔍 服务状态查看 ## 服务状态查看
在排查问题前，建议先查看服务状态： 排查问题前，建议先确认 oneinai 服务是否正常：
**服务分组状态页** ：<https://status.ikuncode.cc/> **服务分组状态页**：<https://status.oneinai.cc/>
* * * ---
## 一、Claude Code 启动时跳登录 ## 一、Claude Code 启动时反复跳登录
### 问题描述 ### 问题描述
启动 Claude Code 时，反复弹出登录界面。 启动 Claude Code 时，反复弹出登录界面，无法进入正常使用状态。
### 解决方案 ### 解决方案
@ -28,88 +28,73 @@
参考教程：<https://www.cnblogs.com/gordonMlxg/articles/19103691> 参考教程：<https://www.cnblogs.com/gordonMlxg/articles/19103691>
* * * ---
## 四、API Connect Error 排查 ## 二、API Connect Error 排查
### 排查方向 ### 排查方向
1. **本地网络异常** 1. **本地网络异常**
- 检查网络连接是否正常
- 尝试访问其他网站验证网络可达性
* 检查网络连接是否正常 2. **代理 / 梯子不稳定**
* 尝试访问其他网站验证网络 - 检查代理配置是否正确
2. **代理/梯子不稳定** - 尝试切换代理节点
* 检查代理配置
* 尝试切换代理节点
### 建议 ### 建议
👉 **尝试直接使用直连网络** **优先尝试直连网络**：关闭代理后测试是否恢复正常。若直连可用，说明问题出在代理链路上。
关闭代理后测试是否恢复正常。 ---
* * * ## 三、上下文过大导致异常
## 八、CC 上下文过大导致异常
### 问题表现 ### 问题表现
对话中出现异常错误，通常与上下文过大有关。 对话中出现异常错误，通常表现为响应失败或返回乱码，多与上下文过大有关。
### 解决方案 ### 解决方案
1. **新建会话** 1. **新建会话**：开启新的对话，清空上下文。
2. **查看 Token 分布**：执行 `/context` 命令查看当前上下文的 Token 使用情况。
3. **关闭自动压缩**：关闭 Auto Compress 功能，手动控制上下文大小。
* 开启新的对话，清空上下文 ---
2. **查看 Token 分布**
/context ## 四、Request Timed Out（请求超时）
1
查看当前上下文的 Token 使用情况
3. **关闭自动压缩**
* 关闭 Auto Compress（自动压缩）功能
* 手动控制上下文大小
* * *
## 九、Request Timed Out（请求超时）
### 可能原因 ### 可能原因
1. 本地网络连接问题 1. 本地网络连接问题
2. 代理或梯子状态不稳定 2. 代理或梯子状态不稳定
3. 服务端负载过高 3. 服务端负载过高
### 解决方案 ### 解决方案
* 检查本地网络连接 - 检查本地网络连接
* 检查代理或梯子状态 - 检查代理或梯子状态
* 必要时尝试直连网络 - 必要时切换至直连网络
* 查看[服务状态页](<https://status.ikuncode.cc/status/api>)确认服务可用性 - 查看 [oneinai 服务状态页](<https://status.oneinai.cc/status/api>) 确认服务可用性
* * * ---
## 十、API Error 503 ## 五、API Error 503
### 错误说明 ### 错误说明
当前分组服务不可用。 当前 oneinai 分组服务暂时不可用。
### 解决方案 ### 解决方案
1. 切换至其他可用服务分组 1. 切换至其他可用的服务分组
2. 通过状态页确认分组状态 2. 通过状态页确认分组的实时状态
**服务状态查看** ：<https://status.ikuncode.cc/status/api> **服务状态查看**：<https://status.oneinai.cc/status/api>
* * * ---
## 十一、Gemini CLI 报错 400 ## 六、Gemini CLI 报错 400
### 问题说明 ### 问题说明
@ -119,28 +104,25 @@
直接重开会话即可解决。 直接重开会话即可解决。
* * * ---
## 十二、Claude Code 2.0.73 版本内容割裂 ## 七、Claude Code 2.0.73 版本内容割裂
### 问题说明 ### 问题说明
在 2.0.73 版本中出现对话/内容割裂问题。 在 2.0.73 版本中出现对话 / 内容割裂的问题。
### 解决方案：回退版本 ### 解决方案：回退版本
bash ```bash
npm install -g @anthropic-ai/claude-code@2.0.72
```
回退到稳定的 2.0.72 版本即可恢复。
npm install -g @anthropic-ai/claude-code@2.0.72 ---
1 ## 八、关闭 Claude Code 自动更新
回退到稳定的 2.0.72 版本。
* * *
## 十三、如何关闭 Claude Code 自动更新
### 问题描述 ### 问题描述
@ -150,100 +132,74 @@ bash
在 `settings.json` 中添加以下环境变量： 在 `settings.json` 中添加以下环境变量：
json ```json
{
"env": {
{ "DISABLE_AUTOUPDATER": "1"
"env": { }
"DISABLE_AUTOUPDATER": "1" }
} ```
}
1
2
3
4
5
或在系统环境变量中设置： 或在系统环境变量中设置：
bash ```bash
# macOS / Linux
export DISABLE_AUTOUPDATER=1
```
```powershell
# Windows PowerShell
$Env:DISABLE_AUTOUPDATER = "1"
```
# macOS/Linux ---
export DISABLE_AUTOUPDATER=1
# Windows PowerShell ## 排查技巧总结
$Env:DISABLE_AUTOUPDATER = "1"
1
2
3
4
5
* * *
## 🔧 排查技巧总结
### 快速诊断流程 ### 快速诊断流程
1. ✅ 查看[服务状态页](<https://status.ikuncode.cc/status/api>) 1. 查看 [oneinai 服务状态页](<https://status.oneinai.cc/status/api>)
2. ✅ 检查环境变量配置 2. 检查环境变量配置
3. ✅ 验证令牌是否有效 3. 验证令牌是否有效
4. ✅ 检查网络和代理状态 4. 检查网络和代理状态
5. ✅ 查看 Token 余额 5. 查看 Token 余额
6. ✅ 尝试重新开启会话 6. 尝试重新开启会话
### 常用调试命令 ### 常用调试命令
#### Claude Code #### Claude Code
bash ```bash
/status # 查看当前会话状态
/context # 查看上下文 Token 使用
/status # 查看当前会话状态 /clear # 清空当前会话
/context # 查看上下文 Token 使用 ```
/clear # 清空当前会话
1
2
3
### 环境变量检查 ### 环境变量检查
#### Windows #### Windows
powershell ```powershell
# 查看所有 ANTHROPIC 相关变量
Get-ChildItem Env: | Where-Object { $_.Name -like "*ANTHROPIC*" }
```
#### macOS / Linux
# 查看所有 ANTHROPIC 相关变量 ```bash
Get-ChildItem Env: | Where-Object {$_.Name -like "*ANTHROPIC*"} # 查看所有 ANTHROPIC 相关变量
env | grep ANTHROPIC
```
1 ---
2
#### macOS/Linux ## 获取帮助
bash
# 查看所有 ANTHROPIC 相关变量
env | grep ANTHROPIC
1
2
* * *
## 📮 获取帮助
如果以上方法都无法解决您的问题，请： 如果以上方法都无法解决您的问题，请：
* 📧 查看[售前售后](</support/after-sales>)联系客服 - 加入 Telegram 群组：<https://t.me/oneinai>
* 💬 加入 Telegram 群组：<https://t.me/ikuncode> - 查看 [常见问题 FAQ](</support/faq>)
* 📖 查看[常见问题 FAQ](</support/faq>)
* * * ---
_本文档持续更新中，如有新的疑难杂症欢迎反馈..._ _本文档持续更新中，如有新的疑难杂症欢迎反馈。_

205
apidoc/tools/cc-switch.md
View File

@ -1,162 +1,171 @@
# CC-Switch 快速配置工具 # CC-Switch 快速配置工具
**All-in-One AI CLI 管理器 - 桌面应用程序** **All-in-One AI CLI 管理器 — 跨平台桌面应用**
## 🔗 相关链接 ## 🔗 相关链接
资源| 地址 | 资源 | 地址 |
---|--- | --- | --- |
GitHub 发布页| [cc-switch/releases](<https://github.com/farion1231/cc-switch/releases>) | GitHub 发布页 | [cc-switch/releases](https://github.com/farion1231/cc-switch/releases) |
CC-Switch 文档站| [ccswitch.lovable.app](<https://ccswitch.lovable.app/>) | CC-Switch 文档站 | [ccswitch.io](https://www.ccswitch.io/zh/docs) |
| oneinai 控制台 | <https://api.oneinai.com/console/token> |
## 🎯 工具介绍 ## 🎯 工具介绍
CC-Switch 是一款跨平台桌面应用程序，统一管理 Claude Code、Codex 和 Gemini CLI 三大 AI 编程工具。通过直观的图形界面，实现配置切换、MCP 服务器管理、系统提示和 Claude Skills 管理。 CC-Switch 是一款跨平台桌面应用，统一管理 **Claude Code**、**Codex** 和 **Gemini CLI** 三大 AI 编程工具。通过直观的图形界面，让你在多个供应商配置之间一键切换，并集中管理 MCP 服务器、系统提示和 Claude Skills。
💡 核心功能 > 💡 **核心功能**
> - 一键切换不同 AI 工具的供应商配置
> - API 端点速度测试与质量指示器
> - 多预设系统提示管理
> - MCP 服务器统一架构管理
> - Claude Skills 发现与安装系统
> - 配置自动备份与恢复（保留最近 10 个）
> - 深度链接协议支持（`ccswitch://`）
> - 环境变量冲突检测
• 一键切换不同 AI 工具的提供商配置 • API 端点速度测试与质量指示器 • 多预设系统提示管理 • MCP 服务器统一架构管理 • Claude Skills 发现与安装系统 • 配置备份/恢复（自动保留最近10个） • 深度链接协议支持（`ccswitch://`） • 环境变量冲突检测 ![CC-Switch 软件界面](https://minio.oneinai.com/oneinai/images/docs/cc-switch/cc-switch01.png)
![CC-Switch 软件界面](https://docs.ikuncode.cc/images/tu6.png)
## 📦 安装方法 ## 📦 安装方法
### 🖥️ Windows 平台 ### 🖥️ Windows 平台
#### 方法一：MSI 安装器（推荐） **方法一：MSI 安装器（推荐）**
1. 访问项目发布页：<https://github.com/farion1231/cc-switch/releases> 1. 访问 [Releases 页面](https://github.com/farion1231/cc-switch/releases)
2. 下载最新版本的 `.msi` 安装器 2. 下载最新版本的 `.msi` 安装器
3. 运行安装器，按照向导完成安装 3. 运行安装器，按向导完成安装
4. 安装完成后从开始菜单启动 CC-Switch 4. 从开始菜单启动 CC-Switch
#### 方法二：便携版（无需安装） **方法二：便携版（免安装）**
1. 下载 `.zip` 便携版压缩包 1. 下载 `.zip` 便携版压缩包
2. 解压到任意目录 2. 解压到任意目录
3. 运行 `cc-switch.exe` 即可使用 3. 双击 `cc-switch.exe` 即可使用
### 🍏 macOS 平台 ### 🍏 macOS 平台
#### 推荐方式：Homebrew 安装 **推荐方式：Homebrew 安装**
bash ```bash
# 添加 tap 源
brew tap farion1231/ccswitch
# 安装 cc-switch
brew install --cask cc-switch
```
# 添加 tap 源 **手动安装**
brew tap farion1231/ccswitch
# 安装 cc-switch 1. 访问 [Releases 页面](https://github.com/farion1231/cc-switch/releases)
brew install --cask cc-switch 2. 下载 `.dmg` 安装包
3. 打开 DMG，将 CC-Switch 拖入「应用程序」文件夹
1 4. 从启动台或「应用程序」启动
2
3
4
5
#### 手动安装
1. 访问 [Releases 页面](<https://github.com/farion1231/cc-switch/releases>)
2. 下载 `.dmg` 安装包
3. 打开 DMG 文件，将 CC-Switch 拖入应用程序文件夹
4. 从启动台或应用程序文件夹启动
### 🐧 Linux 平台 ### 🐧 Linux 平台
#### Debian/Ubuntu 系列（推荐） **Debian / Ubuntu 系列（推荐）**
bash ```bash
sudo dpkg -i cc-switch_*.deb
sudo apt-get install -f # 修复依赖
```
**AppImage 通用版本**
sudo dpkg -i cc-switch_*.deb ```bash
sudo apt-get install -f # 修复依赖 chmod +x cc-switch_*.AppImage
./cc-switch_*.AppImage
```
1 **Arch Linux（AUR）**
2
#### AppImage 通用版本 ```bash
paru -S cc-switch-bin
bash # 或使用 yay
yay -S cc-switch-bin
```
chmod +x cc-switch_*.AppImage
./cc-switch_*.AppImage
1
2
#### Arch Linux（AUR）
bash
paru -S cc-switch-bin
# 或使用 yay
yay -S cc-switch-bin
1
2
3
## 🚀 快速开始 ## 🚀 快速开始
### 第一步：初始化设置 ### 第一步：初始化设置
打开 CC-Switch，进入「设置」页面，在「通用」标签下将「窗口行为」中的所有开关全部打开，确保自启动、Claude Code 插件集成、托盘最小化等功能正常生效。 打开 CC-Switch，进入「设置 → 通用」，将「窗口行为」中的所有开关全部启用，确保自启动、Claude Code 插件集成、托盘最小化等功能正常生效。
![CC-Switch 初始化设置界面](https://docs.ikuncode.cc/images/cc-switch-init-settings.png) ![CC-Switch 初始化设置界面](https://minio.oneinai.com/oneinai/images/docs/cc-switch/cc-switch02.png)
💡 推荐配置 > 💡 **推荐配置**
> 建议启用以下选项以获得最佳体验：
> - 开机自启
> - 静默启动
> - 应用到 Claude Code 插件
> - 跳过初次安装确认
> - 关闭时最小化到托盘
建议将「窗口行为」中的所有开关全部启用，以获得最佳使用体验：开机自启、静默启动、应用到 Claude Code 插件、跳过初次安装确认、关闭时最小化到托盘。 ### 第二步：添加供应商配置
### 第二步：添加提供商配置 **1. 添加 Claude / Gemini 供应商**
1. 点击右上角的加号按钮来添加提供商(Claude/Gemini) 点击右上角的「+」按钮，进入添加面板。
![添加新供应商配置界面](https://docs.ikuncode.cc/images/cc-switch-add-provider.png) ![添加 Claude / Gemini 供应商](https://minio.oneinai.com/oneinai/images/docs/cc-switch/cc-switch03.png)
💡 Gemini 用户 > 💡 **Gemini 用户提示**
> 使用 Gemini CLI 时，请在 oneinai 平台创建 **Gemini 分组**的令牌，而非 Claude 分组。
如果使用的是 Gemini CLI，请在平台创建**对应的** 令牌，而非 Claude 分组。 **2. 添加 Codex 供应商**
2. 点击右上角的加号按钮来添加提供商(Codex) 切换到 Codex 标签后，同样点击右上角「+」按钮添加。
![添加新供应商配置界面](https://docs.ikuncode.cc/images/cc-switch-add-provider2.png) ![添加 Codex 供应商](https://minio.oneinai.com/oneinai/images/docs/cc-switch/cc-switch04.png)
3. 点击「保存」完成配置 **3. 保存配置**
⚠️ 重要提示 填写完成后点击「保存」即可。
不同的AI工具（Claude Code、Codex、Gemini CLI）需要不同的令牌组配置。 请在[监测站](<https://status.ikuncode.cc/>)中选择合适的分组创建令牌。 > ⚠️ **重要提示**
> 不同 AI 工具（Claude Code / Codex / Gemini CLI）需要使用**不同的令牌组**。请在[监测站](https://status.oneinai.com/)中确认模型状态后，再选择合适的分组创建令牌。
### 第三步：切换提供商 ### 第三步：切换供应商
1. 在提供商列表中选择要使用的配置 | 操作方式 | 步骤 |
2. 点击「启用」按钮 | --- | --- |
3. **或** 使用系统托盘图标进行即时切换 | **应用内切换** | 在供应商列表中选择目标配置 → 点击「启用」 |
| **托盘快捷切换** | 右键点击托盘图标 → 选择对应工具的供应商 |
**系统托盘快速切换：** > ℹ️ **生效说明**
> Claude Code 支持热重载，切换后立即生效；Codex 和 Gemini CLI 需要重启工具才能应用新配置。
* 右键点击系统托盘中的 CC-Switch 图标 ### 第四步：开始使用
* 从菜单中直接选择要切换的提供商
* 配置立即生效（Claude Code支持热重载，其它的可能需要重新启动）
### 第四步：应用配置 切换完成后，启动对应的 AI 工具即可享受新配置。
切换配置后，关闭并重新启动对应的 AI 工具即可自动应用新配置。 ## 📖 进阶使用
## 📖 完整文档 ### 系统托盘菜单
更多详细配置和高级功能，请参阅 [CC-Switch 官方完整文档](<https://www.ccswitch.io/zh/docs?section=getting-started>)。 - 右键点击托盘图标可看到分类列表（Claude / Codex / Gemini）
- 直接点击对应分类下的供应商即可切换
- 无需打开主界面，提升日常切换效率
### API 速度测试
在供应商详情页可以一键测试 API 端点的连接速度，并以颜色直观展示质量等级，帮你快速选出最优节点。
### 配置备份与恢复
CC-Switch 会自动保留最近 10 个配置版本，意外修改后可一键回滚到任意历史版本。
## 📚 完整文档
更多高级功能与详细说明，请参阅 [CC-Switch 官方文档](https://www.ccswitch.io/zh/docs)。
## 🔗 项目资源 ## 🔗 项目资源
* **GitHub 仓库** ：<https://github.com/farion1231/cc-switch> - **GitHub 仓库**：<https://github.com/farion1231/cc-switch>
* **问题反馈** ：[GitHub Issues](<https://github.com/farion1231/cc-switch/issues>) - **问题反馈**：[GitHub Issues](https://github.com/farion1231/cc-switch/issues)
* **最新版本** ：[Releases 页面](<https://github.com/farion1231/cc-switch/releases>) - **最新版本**：[Releases 页面](https://github.com/farion1231/cc-switch/releases)
🎉 开始使用！ ---
现在您可以使用 CC-Switch 轻松管理多个 AI 编程工具的配置了。 享受高效的开发体验！ 🎉 **开始使用！** 现在你可以用 CC-Switch 轻松管理多个 AI 编程工具的配置，享受高效的开发体验。