Private
Public Access
1
0

docs: 更新 API 分组说明、客户端推荐及重启终端提醒
All checks were successful
Deploy to Cloudflare Pages / deploy (push) Successful in 1m4s

- 文档新增 ccmax/cc2api 分组说明:cc2api 推荐优先使用(Claude 系列,无客户端限制),ccmax 仅限 Claude Code
- 推荐 OpenCode、OpenClaw 作为 cc2api 客户端,GPT 模型推荐 v1/responses 端点
- Cherry Studio 兼容性说明更新:支持所有模型,仅 ccmax 分组 Claude 模型不可用
- 所有脚本重启终端提示改为中文
- 三个工具文档页及快速开始页添加重启终端 warning 框
This commit is contained in:
2026-02-25 17:13:22 +08:00
parent a443b11326
commit 7c4d947400
17 changed files with 283 additions and 543 deletions

View File

@@ -81,13 +81,13 @@ Cherry Studio 是一款支持多服务商集成的 AI 对话客户端,目前
## 六、提醒
> ⚠️ **特别注意以下模型的使用:**
> ⚠️ **注意:** Cherry Studio 支持所有模型,但 **ccmax 分组的 Claude 模型不可用**ccmax 只能用于 Claude Code。请使用 cc2api 等其他分组。
| 模型 | 建议 |
| -------------------- | -------------------------------------- |
| **Claude 系列** | 不要在这里用,去 Claude Code (CC) 使用 |
| **GPT 5.1/5.2 系列** | 只能在 Codex 内使用 |
| **Gemini 系列** | ✅ 推荐使用 |
| 模型 | 备注 |
| --- | --- |
| **Gemini 系列** | ✅ 完美支持 |
| **Claude 系列** | ✅ 使用 **cc2api** 等分组即可(勿用 ccmax 分组) |
| **GPT 系列** | ✅ 支持;推荐 `v1/responses` 端点 |
---
@@ -97,4 +97,4 @@ Cherry Studio 是一款支持多服务商集成的 AI 对话客户端,目前
2. 添加提供商:名称填 `XCodeCLI`,类型选 `Gemini`
3. 填写 API Key 和地址 `https://api2.xcodecli.com`
4. 生成高清图时:关闭流式输出 + 配置自定义参数
5. 优先使用 Gemini 系列模型,暂不支持 Claude、GPT 系列模型
5. Cherry Studio 支持所有模型,但 ccmax 分组的 Claude 模型不可用GPT 模型推荐使用 `v1/responses` 端点

View File

@@ -19,6 +19,14 @@ $key='你的密钥'; iwr -useb https://gitea.sususu.cf/sususu/xcodecli-shells/ra
:::
> 请将命令中的 `你的密钥` 替换为你的实际 API 密钥。
::: warning ⚠️ 配置完成后请重启终端
脚本会自动配置环境变量(`ANTHROPIC_AUTH_TOKEN` 等),但需要**重启终端**才能生效。
- **macOS / Linux**:重新打开终端,或执行 `source ~/.zshrc`(或 `source ~/.bashrc`
- **Windows**:重新打开 PowerShell 窗口
如果不重启Claude Code 首次启动时可能无法读取 API 密钥。
:::
## 手动配置说明

View File

@@ -19,6 +19,12 @@ $key='你的密钥'; iwr -useb https://gitea.sususu.cf/sususu/xcodecli-shells/ra
:::
> 请将命令中的 `你的密钥` 替换为你的实际 API 密钥。
::: warning ⚠️ 配置完成后请重启终端
脚本会自动配置环境变量,但需要**重启终端**才能生效。
- **macOS / Linux**:重新打开终端,或执行 `source ~/.zshrc`(或 `source ~/.bashrc`
- **Windows**:重新打开 PowerShell 窗口
:::
## 手动配置说明

View File

@@ -19,6 +19,12 @@ $key='你的密钥'; iwr -useb https://gitea.sususu.cf/sususu/xcodecli-shells/ra
:::
> 请将命令中的 `你的密钥` 替换为你的实际 API 密钥。
::: warning ⚠️ 配置完成后请重启终端
脚本会自动配置环境变量,但需要**重启终端**才能生效。
- **macOS / Linux**:重新打开终端,或执行 `source ~/.zshrc`(或 `source ~/.bashrc`
- **Windows**:重新打开 PowerShell 窗口
:::
## 手动配置说明

View File

@@ -32,6 +32,13 @@ $key='你的密钥'; iwr -useb https://gitea.sususu.cf/sususu/xcodecli-shells/ra
> 💡 **提示**:请将命令中的 `你的密钥` 替换为你的实际 API 密钥。
::: warning ⚠️ 配置完成后请重启终端
脚本会自动写入环境变量,但需要**重启终端**才能生效。否则工具首次启动时可能无法读取 API 密钥。
- **macOS / Linux**:重新打开终端,或执行 `source ~/.zshrc`(或 `source ~/.bashrc`
- **Windows**:重新打开 PowerShell 窗口
:::
### 脚本执行流程
1. **环境检测**:检查 Node.js 等必要运行时。如果缺失,脚本会尝试引导安装(如 fnm
@@ -56,3 +63,35 @@ $key='你的密钥'; iwr -useb https://gitea.sususu.cf/sususu/xcodecli-shells/ra
2. `https://api.xcodecli.com` (备用)
所有的工具都会统一配置使用同一个有效的 API 端点。
## API 分组说明
XCodeCLI 提供两个 API 分组,适用于不同的使用场景:
### cc2api — 推荐使用
- **包含模型**Claude 系列
- **适用客户端**:无限制,所有支持 OpenAI 兼容 API 的客户端均可使用(包括 Claude Code
- **特点****所有客户端优先选择此分组**
推荐搭配以下客户端使用:
| 客户端 | 类型 | 说明 |
| :--- | :--- | :--- |
| **[OpenCode](https://opencode.ai/)** | 终端 AI 编码代理 | 开源,支持 75+ LLM 供应商Claude Code 的最佳替代方案。提供终端、桌面端和 IDE 插件 |
| **[OpenClaw](https://openclaw.ai/)** | 个人 AI 助手 | 开源,连接 WhatsApp / Telegram / Slack 等消息平台,支持浏览器自动化、邮件、日历等操作 |
| **[Cherry Studio](https://www.cherry-ai.com/)** | 可视化对话客户端 | 多服务商集成,详见 [配置教程](/cherry-studio-nanobana) |
::: tip 💡 GPT 系列模型
GPT 系列模型推荐使用 `v1/responses` 端点以获得最佳效果。
:::
### ccmax — 仅限 Claude Code
- **包含模型**Claude 系列(与 cc2api 相同)
- **适用客户端****只能**用于 Claude Code
- **何时使用**Claude Code 使用 cc2api 遇到兼容性问题时再切换
::: danger ⚠️ 注意
ccmax **只能**用于 Claude Code请勿用于其他客户端。
:::

View File

@@ -69,7 +69,7 @@ function copyCommand() {
</div>
</div>
<p class="tip">💡 提示:运行前请将命令中的 <code>你的密钥</code> 替换为实际 API Key</p>
<p class="tip">💡 提示:运行前请将命令中的 <code>你的密钥</code> 替换为实际 API Key。<strong>配置完成后请重启终端</strong>,否则工具可能无法读取 API 密钥。</p>
</div>
@@ -79,13 +79,9 @@ function copyCommand() {
<p class="desc">在 Cherry Studio 中使用 XCodeCLI 服务,享受可视化的对话体验。</p>
::: danger ⚠️ 重要提示:模型兼容性
**Cherry Studio 支持 Gemini 系列模型!**
-**Claude 模型**:暂不支持在 Cherry Studio 中使用(请在 Claude Code 内使用)
-**GPT 模型**:暂不支持在 Cherry Studio 中使用(请在 Codex 内使用)
-**Gemini 模型**:完美支持
:::
::: tip 💡 Cherry Studio 模型兼容性
Cherry Studio 支持所有模型,但注意 **ccmax 分组的 Claude 模型不可用**ccmax 只能用于 Claude Code。Claude 模型请使用 **cc2api** 分组。
:::
### 配置参数
@@ -105,6 +101,37 @@ function copyCommand() {
<div class="setup-section">
## 2.5 API 分组说明
<p class="desc">XCodeCLI 提供多个 API 分组,适用于不同的使用场景。</p>
::: warning 🔑 分组区别
- **cc2api 分组(推荐)**:提供 Claude 系列模型,无客户端限制,可自由搭配各种客户端
- **ccmax 分组**:提供 Claude 系列模型,但**只能用于 Claude Code**
:::
### cc2api — 推荐使用
cc2api 分组包含 **Claude 系列模型**,无客户端限制。推荐搭配以下工具:
| 客户端 | 类型 | 说明 |
| :--- | :--- | :--- |
| **[OpenCode](https://opencode.ai/)** | 终端 AI 编码代理 | 开源,支持 75+ LLM 供应商,可作为 Claude Code 的替代方案。支持终端、桌面端和 IDE 插件 |
| **[OpenClaw](https://openclaw.ai/)** | 个人 AI 助手 | 开源,连接 WhatsApp / Telegram / Slack 等消息平台,支持浏览器自动化、邮件、日历等操作 |
| **[Cherry Studio](https://www.cherry-ai.com/)** | 可视化对话客户端 | 支持多服务商集成,详见 [配置教程](/cherry-studio-nanobana) |
::: tip 💡 GPT 系列模型
GPT 系列模型推荐使用 `v1/responses` 端点以获得最佳效果。
:::
### ccmax — 仅限 Claude Code
ccmax 分组同样提供 Claude 系列模型,但**只能**用于 Claude Code不支持其他客户端。如果你使用 Claude Code 且 cc2api 遇到兼容性问题,可尝试切换到 ccmax。
</div>
<div class="setup-section">
## 3. 参考信息
### CLI 配置文件位置