Files
cc-switch/docs/user-manual/2-providers/2.1-add.md
YoVinchen 11cc4e815b docs: add user manual documentation
Add comprehensive user manual covering getting started, provider management,
extensions (MCP/prompts/skills), proxy configuration, and FAQ sections.
Includes screenshots and a README index.
2026-02-09 12:28:45 +08:00

6.3 KiB
Raw Blame History

2.1 添加供应商

打开添加面板

点击主界面右上角的 + 按钮,打开添加供应商面板。

面板分为两个 Tab

  • 应用专属供应商仅用于当前选中的应用Claude/Codex/Gemini
  • 统一供应商:跨应用共享的配置

使用预设添加

预设是预先配置好的供应商模板,只需填写 API Key 即可使用。

操作步骤

  1. 在「预设」下拉框中选择供应商
  2. 名称和端点会自动填充
  3. 填写你的 API Key
  4. (可选)填写备注
  5. 点击「添加」

常用预设

Claude 预设

预设名称 说明
官方登录 使用 Anthropic 官方账号登录
DeepSeek DeepSeek-V3.2 模型
智谱 GLM 智谱 AI 的 GLM-4.7 模型
Qwen Coder 通义千问(阿里云百炼)
Kimi k2 Moonshot Kimi-k2 模型
MiniMax MiniMax-M2.1 模型
PackyCode PackyCode 中转服务
OpenRouter 聚合路由服务
自定义 手动配置所有参数

标注为官方合作伙伴

Codex 预设

预设名称 说明
官方登录 使用 OpenAI 官方账号登录
PackyCode PackyCode 中转服务
自定义 手动配置所有参数

Gemini 预设

预设名称 说明
Google 官方 使用 Google OAuth 登录
PackyCode PackyCode 中转服务
自定义 手动配置所有参数

自定义配置

选择「自定义」预设后,需要手动编辑 JSON 配置。

Claude 配置格式

{
  "env": {
    "ANTHROPIC_API_KEY": "your-api-key",
    "ANTHROPIC_BASE_URL": "https://api.example.com"
  }
}
字段 必填 说明
ANTHROPIC_API_KEY API 密钥
ANTHROPIC_BASE_URL 自定义端点地址
ANTHROPIC_AUTH_TOKEN 替代 API_KEY 的认证方式

Codex 配置格式

Codex 使用两个配置文件:

1. auth.json~/.codex/auth.json- 存储 API 密钥:

{
  "OPENAI_API_KEY": "your-api-key"
}

2. config.toml~/.codex/config.toml- 存储模型和端点配置:

# 基础配置
model_provider = "custom"
model = "gpt-5.2"
model_reasoning_effort = "high"
disable_response_storage = true

# 自定义供应商配置
[model_providers.custom]
name = "custom"
base_url = "https://api.example.com/v1"
wire_api = "responses"
requires_openai_auth = true

auth.json 字段说明

字段 必填 说明
OPENAI_API_KEY API 密钥

config.toml 字段说明

字段 必填 说明
model_provider 模型提供商名称(需与 [model_providers.xxx] 匹配)
model 使用的模型(如 gpt-5.2gpt-4o
model_reasoning_effort 推理强度:low / medium / high
disable_response_storage 是否禁用响应存储
base_url API 端点地址
wire_api API 协议类型(通常为 responses
requires_openai_auth 是否使用 OpenAI 认证方式

Gemini 配置格式

{
  "env": {
    "GEMINI_API_KEY": "your-api-key",
    "GOOGLE_GEMINI_BASE_URL": "https://api.example.com"
  },
  "authMode": "api_key"
}
字段 必填 说明
GEMINI_API_KEY API 密钥
GOOGLE_GEMINI_BASE_URL 自定义端点地址
GEMINI_MODEL 指定模型
authMode 认证模式:api_keyoauth

统一供应商

统一供应商可以跨 Claude/Codex/Gemini 共享配置,适用于支持多种 API 格式的中转服务。

创建统一供应商

  1. 切换到「统一供应商」Tab
  2. 点击「添加统一供应商」
  3. 填写通用配置:
    • 名称
    • API Key
    • 端点地址
  4. 勾选要同步的应用Claude/Codex/Gemini
  5. 保存

同步机制

统一供应商会自动同步到勾选的应用:

  • 修改统一供应商后,所有关联应用的配置同步更新
  • 删除统一供应商后,关联的应用配置也会删除

保存并同步

编辑统一供应商时,可以选择:

操作 说明
保存 仅保存配置,不立即同步
保存并同步 保存配置并立即同步到所有启用的应用

手动同步

如果需要手动触发同步:

  1. 在统一供应商卡片上点击「同步」按钮
  2. 确认同步操作
  3. 配置会覆盖各应用中关联的供应商

导入供应商

CC Switch 支持两种方式导入供应商配置:

方式一:深度链接导入

通过 ccswitch:// 协议链接一键导入:

  1. 点击或访问深度链接
  2. CC Switch 自动打开并显示导入确认
  3. 预览配置信息
  4. 点击「确认导入」

获取深度链接

方式二:数据库备份导入

从 SQL 备份文件批量导入:

  1. 打开「设置 → 高级 → 数据管理」
  2. 点击「选择文件」
  3. 选择之前导出的 .sql 备份文件
  4. 点击「导入」
  5. 确认覆盖现有配置

导入内容

  • 所有供应商配置
  • MCP 服务器配置
  • Prompts 预设
  • 用量日志

⚠️ 注意:导入会覆盖现有数据库,建议先导出当前配置作为备份。导出的文件名格式为 cc-switch-export-{时间戳}.sql

高级选项

自定义图标

点击名称左侧的图标区域,可以:

  • 选择预设图标
  • 自定义图标颜色

网站链接

填写供应商的官网或控制台地址,方便快速访问:

  • 点击供应商卡片的链接图标可直接打开
  • 用于查看余额、获取 API Key 等

备注

添加备注信息,如:

  • 账号用途(个人/工作)
  • 套餐信息
  • 到期时间

备注会显示在供应商卡片上,也支持搜索。

端点测速

添加供应商后,可以对 API 端点进行速度测试:

  1. 点击供应商卡片的「测速」按钮
  2. 在测速面板中添加多个端点 URL
  3. 点击「测速」执行测试
  4. 选择延迟最低的端点

测速结果

  • 🟢 绿色:延迟 < 500ms优秀
  • 🟡 黄色:延迟 500-1000ms一般
  • 🔴 红色:延迟 > 1000ms较慢

image-20260108005327817