mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-06-16 13:34:04 +08:00
Dex Miller
0fcb1b01e2
* 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. * fix(docs): align user manual with v3.10.3 codebase - Add OpenCode as 4th supported app throughout all docs - Fix proxy default port 15762 → 15721 - Update Claude presets (9 → 26), Codex (3 → 10), Gemini (3 → 7) - Add OpenCode presets (25 entries) - Fix timeout defaults and ranges (stream first byte 60s/90s, etc.) - Fix circuit breaker defaults with per-app values (Claude vs general) - Fix Skills support: all 4 apps, not just Claude/Codex - Remove non-existent Gemini authMode field - Fix prompt deletion behavior: enabled prompts cannot be deleted - Remove non-existent Legacy deeplink protocol, use V1 only - Fix DB table names (usage_logs → proxy_request_logs) and add missing tables - Fix migration version v3.8.0 → v3.7.0 - Add missing V1 deeplink parameters (config, configFormat, etc.) - Update doc version v3.9.1 → v3.10.3 - Add claude-opus-4-1 to pricing table - Fix recovery wait time range 10-300 → 0-300 --------- Co-authored-by: Jason <farion1231@gmail.com>
93 lines
2.9 KiB
Markdown
93 lines
2.9 KiB
Markdown
# 1.4 快速上手
|
|
|
|
本节帮助你在 5 分钟内完成首次配置。
|
|
|
|
## 第一步：添加供应商
|
|
|
|
1. 点击主界面右上角的 **+** 按钮
|
|
2. 在「预设」下拉框中选择你的供应商
|
|
- 常用预设：智谱 GLM、MiniMax、DeepSeek、Kimi、PackyCode
|
|
- 或选择「自定义」手动配置
|
|
3. 填写 **API Key**
|
|
4. 点击「添加」
|
|
|
|
|
|
|
|
> 💡 **提示**：预设会自动填充端点地址，你只需要填写 API Key。
|
|
|
|
## 第二步：切换供应商
|
|
|
|
添加完成后，供应商会出现在列表中。
|
|
|
|
**方式一：主界面切换**
|
|
- 点击供应商卡片的「启用」按钮
|
|
|
|
**方式二：托盘快速切换**
|
|
- 右键系统托盘图标
|
|
- 直接点击供应商名称
|
|
|
|
## 第三步：生效方式
|
|
|
|
切换供应商后，各 CLI 工具的生效方式不同：
|
|
|
|
| 应用 | 生效方式 |
|
|
|------|----------|
|
|
| Claude Code | ✅ 即时生效（支持热重载） |
|
|
| Codex | 需关闭并重新打开终端 |
|
|
| Gemini | ✅ 即时生效（每次请求重新读取配置） |
|
|
|
|
### Claude Code 首次安装提示
|
|
|
|
如果 Claude Code 首次启动时提示需要**登录**或显示初始化引导，请在 CC Switch 中开启「跳过 Claude Code 初次安装确认」选项：
|
|
|
|
1. 打开 CC Switch「设置 → 通用」
|
|
2. 开启「跳过 Claude Code 初次安装确认」开关
|
|
3. 重新启动 Claude Code
|
|
|
|
|
|
|
|
> ⚠️ **注意**：此选项会写入 `~/.claude/settings.json` 的 `skipIntroduction` 字段，跳过官方的新手引导流程。
|
|
|
|
## 验证配置
|
|
|
|
重启后，启动对应的 CLI 工具并输入简单的问题进行测试：
|
|
|
|
```bash
|
|
# Claude Code - 启动后输入测试问题
|
|
claude
|
|
> 你好，请简单介绍一下自己
|
|
|
|
# Codex - 启动后输入测试问题
|
|
codex
|
|
> 你好，请简单介绍一下自己
|
|
|
|
# Gemini - 启动后输入测试问题
|
|
gemini
|
|
> 你好，请简单介绍一下自己
|
|
```
|
|
|
|
如果 AI 能正常回复，说明配置成功。
|
|
|
|
## 下一步
|
|
|
|
恭喜！你已经完成了基础配置。接下来可以：
|
|
|
|
- [添加更多供应商](../2-providers/2.1-add.md) - 配置多个供应商方便切换
|
|
- [配置 MCP 服务器](../3-extensions/3.1-mcp.md) - 扩展 AI 工具的能力
|
|
- [设置系统提示词](../3-extensions/3.2-prompts.md) - 自定义 AI 的行为
|
|
- [开启代理服务](../4-proxy/4.1-service.md) - 监控用量和自动故障转移
|
|
|
|
## 常见问题
|
|
|
|
### 切换后不生效？
|
|
|
|
确保重启了终端或 CLI 工具。配置文件在切换时已经更新，但运行中的程序不会自动重新加载。
|
|
|
|
### 找不到预设？
|
|
|
|
如果你的供应商不在预设列表中，选择「自定义」手动配置。参考 [添加供应商](../2-providers/2.1-add.md) 了解配置格式。
|
|
|
|
### 如何恢复官方登录？
|
|
|
|
选择「官方登录」预设（Claude/Codex）或「Google 官方」预设（Gemini），重启客户端后按登录流程操作。
|