mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-04-25 19:32:39 +08:00
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>
112 lines
4.1 KiB
Markdown
112 lines
4.1 KiB
Markdown
# CC Switch 用户手册
|
||
|
||
> Claude Code / Codex / Gemini CLI / OpenCode 全方位辅助工具
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
📚 CC Switch 用户手册
|
||
│
|
||
├── 1. 快速入门
|
||
│ ├── 1.1 软件介绍
|
||
│ ├── 1.2 安装指南
|
||
│ ├── 1.3 界面概览
|
||
│ ├── 1.4 快速上手
|
||
│ └── 1.5 个性化配置
|
||
│
|
||
├── 2. 供应商管理
|
||
│ ├── 2.1 添加供应商
|
||
│ ├── 2.2 切换供应商
|
||
│ ├── 2.3 编辑供应商
|
||
│ ├── 2.4 排序与复制
|
||
│ └── 2.5 用量查询
|
||
│
|
||
├── 3. 扩展功能
|
||
│ ├── 3.1 MCP 服务器管理
|
||
│ ├── 3.2 Prompts 提示词管理
|
||
│ └── 3.3 Skills 技能管理
|
||
│
|
||
├── 4. 代理与高可用
|
||
│ ├── 4.1 代理服务
|
||
│ ├── 4.2 应用接管
|
||
│ ├── 4.3 故障转移
|
||
│ ├── 4.4 用量统计
|
||
│ └── 4.5 模型检查
|
||
│
|
||
└── 5. 常见问题
|
||
├── 5.1 配置文件说明
|
||
├── 5.2 FAQ
|
||
├── 5.3 深度链接协议
|
||
└── 5.4 环境变量冲突
|
||
```
|
||
|
||
## 文件列表
|
||
|
||
### 1. 快速入门
|
||
|
||
| 文件 | 内容 |
|
||
|------|------|
|
||
| [1.1-introduction.md](./1-getting-started/1.1-introduction.md) | 软件介绍、核心功能、支持平台 |
|
||
| [1.2-installation.md](./1-getting-started/1.2-installation.md) | Windows/macOS/Linux 安装指南 |
|
||
| [1.3-interface.md](./1-getting-started/1.3-interface.md) | 界面布局、导航栏、供应商卡片说明 |
|
||
| [1.4-quickstart.md](./1-getting-started/1.4-quickstart.md) | 5 分钟快速上手教程 |
|
||
| [1.5-settings.md](./1-getting-started/1.5-settings.md) | 语言、主题、目录、云同步配置 |
|
||
|
||
### 2. 供应商管理
|
||
|
||
| 文件 | 内容 |
|
||
|------|------|
|
||
| [2.1-add.md](./2-providers/2.1-add.md) | 使用预设、自定义配置、统一供应商 |
|
||
| [2.2-switch.md](./2-providers/2.2-switch.md) | 主界面切换、托盘切换、生效方式 |
|
||
| [2.3-edit.md](./2-providers/2.3-edit.md) | 编辑配置、修改 API Key、回填机制 |
|
||
| [2.4-sort-duplicate.md](./2-providers/2.4-sort-duplicate.md) | 拖拽排序、复制供应商、删除 |
|
||
| [2.5-usage-query.md](./2-providers/2.5-usage-query.md) | 用量查询、剩余额度、多套餐显示 |
|
||
|
||
### 3. 扩展功能
|
||
|
||
| 文件 | 内容 |
|
||
|------|------|
|
||
| [3.1-mcp.md](./3-extensions/3.1-mcp.md) | MCP 协议、添加服务器、应用绑定 |
|
||
| [3.2-prompts.md](./3-extensions/3.2-prompts.md) | 创建预设、激活切换、智能回填 |
|
||
| [3.3-skills.md](./3-extensions/3.3-skills.md) | 发现技能、安装卸载、仓库管理 |
|
||
|
||
### 4. 代理与高可用
|
||
|
||
| 文件 | 内容 |
|
||
|------|------|
|
||
| [4.1-service.md](./4-proxy/4.1-service.md) | 启动代理、配置项、运行状态 |
|
||
| [4.2-takeover.md](./4-proxy/4.2-takeover.md) | 应用接管、配置修改、状态指示 |
|
||
| [4.3-failover.md](./4-proxy/4.3-failover.md) | 故障转移队列、熔断器、健康状态 |
|
||
| [4.4-usage.md](./4-proxy/4.4-usage.md) | 用量统计、趋势图表、定价配置 |
|
||
| [4.5-model-test.md](./4-proxy/4.5-model-test.md) | 模型检查、健康检测、延迟测试 |
|
||
|
||
### 5. 常见问题
|
||
|
||
| 文件 | 内容 |
|
||
|------|------|
|
||
| [5.1-config-files.md](./5-faq/5.1-config-files.md) | CC Switch 存储、CLI 配置文件格式 |
|
||
| [5.2-questions.md](./5-faq/5.2-questions.md) | 常见问题解答 |
|
||
| [5.3-deeplink.md](./5-faq/5.3-deeplink.md) | 深度链接协议、生成和使用方法 |
|
||
| [5.4-env-conflict.md](./5-faq/5.4-env-conflict.md) | 环境变量冲突检测与处理 |
|
||
|
||
## 快速链接
|
||
|
||
- **新用户**：从 [1.1 软件介绍](./1-getting-started/1.1-introduction.md) 开始
|
||
- **安装问题**：查看 [1.2 安装指南](./1-getting-started/1.2-installation.md)
|
||
- **配置供应商**：查看 [2.1 添加供应商](./2-providers/2.1-add.md)
|
||
- **使用代理**：查看 [4.1 代理服务](./4-proxy/4.1-service.md)
|
||
- **遇到问题**：查看 [5.2 FAQ](./5-faq/5.2-questions.md)
|
||
|
||
## 版本信息
|
||
|
||
- 文档版本：v3.10.3
|
||
- 最后更新：2026-02-09
|
||
- 适用于 CC Switch v3.10.0+
|
||
|
||
## 贡献
|
||
|
||
欢迎提交 Issue 或 PR 改进文档：
|
||
|
||
- [GitHub Issues](https://github.com/farion1231/cc-switch/issues)
|
||
- [GitHub Repository](https://github.com/farion1231/cc-switch)
|