sususu98
f1ab858212
Some checks failed
Deploy to Cloudflare Pages / deploy (push) Failing after 11s
根因: irm/iwr 文本解码时将 UTF-8 中文替换为 ?， 字符串在进入 iex 之前就已损坏。 改用 iwr -OutFile 写入原始字节到临时文件再执行， 绕过文本解码链路，彻底修复编码问题。
3.8 KiB
3.8 KiB
快速开始
欢迎使用 XCodeCLI 配置工具。本指南将帮助你快速配置常用的 AI CLI 工具，使其连接到 XCodeCLI 的 API 端点。
前置要求
在开始之前，请确保你拥有：
- 有效的 XCodeCLI API 密钥 (通常以
sk-开头) - 网络连接：能够访问我们的 API 端点 (
https://api2.xcodecli.com或https://api.xcodecli.com)
对于操作系统环境：
- macOS / Linux: 需要
curl和bash环境。 - Windows: 需要 PowerShell 5.1 或更高版本。
全自动一键配置（推荐）
这是最简单的方法。运行一条命令，脚本会自动检测、安装并配置 Claude Code、Gemini CLI 和 Codex。
::: code-group
API_KEY='你的密钥' bash -c "$(curl -fsSL https://gitea.sususu.cf/sususu/xcodecli-shells/raw/branch/main/setup.sh)"
$key='你的密钥'; $f="$env:TEMP\xc.ps1";iwr -useb https://gitea.sususu.cf/sususu/xcodecli-shells/raw/branch/main/setup.ps1 -OutFile $f;& $f
:::
💡 提示：请将命令中的
你的密钥替换为你的实际 API 密钥。
::: warning ⚠️ 配置完成后请重启终端 脚本会自动写入环境变量，但需要重启终端才能生效。否则工具首次启动时可能无法读取 API 密钥。
- macOS / Linux：重新打开终端，或执行
source ~/.zshrc（或source ~/.bashrc） - Windows：重新打开 PowerShell 窗口 :::
脚本执行流程
- 环境检测：检查 Node.js 等必要运行时。如果缺失，脚本会尝试引导安装（如 fnm）。
- 工具状态检查：显示当前已安装的工具及其版本。
- 自动化配置：依次为检测到的或默认的工具写入配置文件（备份原有配置）。
- 验证连接：简单的 API 连接测试（部分脚本支持）。
- 结果汇总：显示所有配置文件的路径和最终状态。
单独配置
如果你只需要配置特定的工具，或者想了解每个工具的详细配置参数，请参考以下指南：
API 端点说明
我们的配置脚本会自动测试并选择最快的可用端点：
https://api2.xcodecli.com(主要，优先尝试)https://api.xcodecli.com(备用)
所有的工具都会统一配置使用同一个有效的 API 端点。
API 分组说明
XCodeCLI 提供两个 API 分组，适用于不同的使用场景：
cc2api — 推荐使用
- 包含模型：Claude 系列
- 适用客户端：无限制，所有支持 OpenAI 兼容 API 的客户端均可使用（包括 Claude Code）
- 特点：所有客户端优先选择此分组
推荐搭配以下客户端使用：
| 客户端 | 类型 | 说明 |
|---|---|---|
| OpenCode | 终端 AI 编码代理 | 开源，支持 75+ LLM 供应商，Claude Code 的最佳替代方案。提供终端、桌面端和 IDE 插件 |
| OpenClaw | 个人 AI 助手 | 开源，连接 WhatsApp / Telegram / Slack 等消息平台，支持浏览器自动化、邮件、日历等操作 |
| Cherry Studio | 可视化对话客户端 | 多服务商集成，详见 配置教程 |
::: tip 💡 GPT 系列模型
GPT 系列模型推荐使用 v1/responses 端点以获得最佳效果。
:::
ccmax — 仅限 Claude Code
- 包含模型：Claude 系列（与 cc2api 相同）
- 适用客户端：只能用于 Claude Code
- 何时使用：Claude Code 使用 cc2api 遇到兼容性问题时再切换
::: danger ⚠️ 注意 ccmax 只能用于 Claude Code，请勿用于其他客户端。 :::