mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-08-02 10:21:16 +08:00
docs: add OpenClaw coverage and complete settings docs for user manual
- Add OpenClaw as the 5th supported app across all doc chapters (1-3, 5) - Add OpenClaw provider presets table to 2.1-add.md (30 presets) - Add OpenClaw config section to 5.1-config-files.md (JSON5 format) - Complete 1.5-settings.md with missing sections: app visibility, skill sync method, terminal settings, proxy tab, WebDAV cloud sync, backup/restore, and log configuration - Fix deeplink parser.rs to accept 'opencode' and 'openclaw' app types - Update 5.3-deeplink.md with new app type parameters - Remove incorrect OpenCode references from proxy docs (4.1-4.4)
This commit is contained in:
@@ -2,14 +2,14 @@
|
||||
|
||||
## 什么是 CC Switch
|
||||
|
||||
CC Switch 是一款跨平台桌面应用,专为使用 AI 编程工具的开发者设计。它帮助你统一管理 **Claude Code**、**Codex**、**Gemini CLI**、**OpenCode** 四大 AI 编程工具的配置。
|
||||
CC Switch 是一款跨平台桌面应用,专为使用 AI 编程工具的开发者设计。它帮助你统一管理 **Claude Code**、**Codex**、**Gemini CLI**、**OpenCode** 和 **OpenClaw** 五大 AI 编程工具的配置。
|
||||
|
||||
## 解决什么问题
|
||||
|
||||
在日常开发中,你可能会遇到这些痛点:
|
||||
|
||||
- **多供应商切换麻烦**:使用不同的 API 供应商(官方、中转服务商),需要手动修改配置文件
|
||||
- **配置分散难管理**:Claude、Codex、Gemini、OpenCode 各有独立的配置文件,格式不同
|
||||
- **配置分散难管理**:Claude、Codex、Gemini、OpenCode、OpenClaw 各有独立的配置文件,格式不同
|
||||
- **无法监控用量**:不知道 API 调用了多少次,花了多少钱
|
||||
- **服务不稳定**:单一供应商出问题时,整个工作流中断
|
||||
|
||||
@@ -43,6 +43,7 @@ CC Switch 通过统一的界面解决这些问题。
|
||||
| **Codex** | OpenAI 的代码生成工具 |
|
||||
| **Gemini CLI** | Google 的 AI 命令行工具 |
|
||||
| **OpenCode** | 开源 AI 编程终端工具 |
|
||||
| **OpenClaw** | 开源 AI 编程助手(多供应商网关) |
|
||||
|
||||
## 支持的平台
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
| ① | Logo | 点击访问 GitHub 项目页 |
|
||||
| ② | 设置按钮 | 打开设置页面(快捷键 `Cmd/Ctrl + ,`) |
|
||||
| ③ | 代理开关 | 启动/停止本地代理服务 |
|
||||
| ④ | 应用切换器 | 切换 Claude / Codex / Gemini / OpenCode |
|
||||
| ④ | 应用切换器 | 切换 Claude / Codex / Gemini / OpenCode / OpenClaw |
|
||||
| ⑤ | 功能区 | Skills / Prompts / MCP 入口 |
|
||||
| ⑥ | 添加按钮 | 添加新供应商 |
|
||||
|
||||
@@ -23,6 +23,7 @@
|
||||
- **Codex** - 管理 Codex 配置
|
||||
- **Gemini** - 管理 Gemini CLI 配置
|
||||
- **OpenCode** - 管理 OpenCode 配置
|
||||
- **OpenClaw** - 管理 OpenClaw 配置
|
||||
|
||||
切换后,供应商列表会显示对应应用的配置。
|
||||
|
||||
@@ -99,7 +100,7 @@ CC Switch 在系统托盘显示图标,提供快速操作入口。
|
||||
| 菜单项 | 功能 |
|
||||
|--------|------|
|
||||
| 打开主界面 | 显示主窗口并聚焦 |
|
||||
| 应用分组 | 按 Claude/Codex/Gemini/OpenCode 分组显示供应商 |
|
||||
| 应用分组 | 按 Claude/Codex/Gemini/OpenCode/OpenClaw 分组显示供应商 |
|
||||
| 供应商列表 | 点击切换,当前启用的显示勾选标记 |
|
||||
| 退出 | 完全退出应用 |
|
||||
|
||||
|
||||
@@ -11,21 +11,21 @@
|
||||
|
||||
CC Switch 支持三种语言:
|
||||
|
||||
| 语言 | 说明 |
|
||||
|------|------|
|
||||
| 语言 | 说明 |
|
||||
| -------- | -------- |
|
||||
| 简体中文 | 默认语言 |
|
||||
| English | 英文界面 |
|
||||
| 日本語 | 日文界面 |
|
||||
| English | 英文界面 |
|
||||
| 日本語 | 日文界面 |
|
||||
|
||||
切换语言后立即生效,无需重启。
|
||||
|
||||
## 主题设置
|
||||
|
||||
| 选项 | 说明 |
|
||||
|------|------|
|
||||
| 选项 | 说明 |
|
||||
| -------- | --------------------------- |
|
||||
| 跟随系统 | 自动匹配系统的深色/浅色模式 |
|
||||
| 浅色 | 始终使用浅色主题 |
|
||||
| 深色 | 始终使用深色主题 |
|
||||
| 浅色 | 始终使用浅色主题 |
|
||||
| 深色 | 始终使用深色主题 |
|
||||
|
||||
## 窗口行为
|
||||
|
||||
@@ -39,10 +39,10 @@ CC Switch 支持三种语言:
|
||||
|
||||
### 关闭行为
|
||||
|
||||
| 选项 | 说明 |
|
||||
|------|------|
|
||||
| 选项 | 说明 |
|
||||
| ------------ | ---------------------------- |
|
||||
| 最小化到托盘 | 点击关闭按钮时隐藏到系统托盘 |
|
||||
| 直接退出 | 点击关闭按钮时完全退出应用 |
|
||||
| 直接退出 | 点击关闭按钮时完全退出应用 |
|
||||
|
||||
推荐使用「最小化到托盘」,方便通过托盘快速切换供应商。
|
||||
|
||||
@@ -58,6 +58,37 @@ CC Switch 支持三种语言:
|
||||
|
||||
> ⚠️ **注意**:此选项会写入 `~/.claude/settings.json` 的 `skipIntroduction` 字段。
|
||||
|
||||
### 应用可见性
|
||||
|
||||
选择在应用切换器中显示哪些应用。每个应用可以独立开关,但至少保留一个。
|
||||
|
||||
可配置的应用:Claude、Codex、Gemini、OpenCode、OpenClaw。
|
||||
|
||||
> 💡 **使用场景**:如果你只使用 Claude Code 和 Codex CLI,可以隐藏其他应用,保持界面简洁。
|
||||
|
||||
### Skills 同步方式
|
||||
|
||||
设置技能安装到各应用目录时的同步方式:
|
||||
|
||||
| 方式 | 说明 |
|
||||
| ----------------- | ---------------------------------------------------- |
|
||||
| 软链接(Symlink) | 创建符号链接指向技能源文件,占用空间小,更新实时同步 |
|
||||
| 复制(Copy) | 将技能文件完整复制到目标目录 |
|
||||
|
||||
> 💡 **推荐**:默认使用软链接方式。如果遇到权限问题,可切换为复制方式。
|
||||
|
||||
### 终端设置
|
||||
|
||||
选择 CC Switch 打开终端时使用的终端应用程序。
|
||||
|
||||
支持的终端(按平台):
|
||||
|
||||
| 平台 | 终端选项 |
|
||||
| ------- | ------------------------------------------------------------------ |
|
||||
| macOS | Terminal、iTerm2、Alacritty、Kitty、Ghostty、WezTerm |
|
||||
| Windows | CMD、PowerShell、Windows Terminal |
|
||||
| Linux | GNOME Terminal、Konsole、Xfce4 Terminal、Alacritty、Kitty、Ghostty |
|
||||
|
||||
## 目录配置
|
||||
|
||||
### 应用配置目录
|
||||
@@ -68,11 +99,13 @@ CC Switch 自身数据的存储位置,默认为 `~/.cc-switch/`。
|
||||
|
||||
可以自定义各 CLI 工具的配置目录:
|
||||
|
||||
| 配置 | 默认值 | 说明 |
|
||||
|------|--------|------|
|
||||
| Claude 目录 | `~/.claude/` | Claude Code 配置目录 |
|
||||
| Codex 目录 | `~/.codex/` | Codex 配置目录 |
|
||||
| Gemini 目录 | `~/.gemini/` | Gemini CLI 配置目录 |
|
||||
| 配置 | 默认值 | 说明 |
|
||||
| ------------- | -------------- | -------------------- |
|
||||
| Claude 目录 | `~/.claude/` | Claude Code 配置目录 |
|
||||
| Codex 目录 | `~/.codex/` | Codex 配置目录 |
|
||||
| Gemini 目录 | `~/.gemini/` | Gemini CLI 配置目录 |
|
||||
| OpenCode 目录 | `~/.opencode/` | OpenCode 配置目录 |
|
||||
| OpenClaw 目录 | `~/.openclaw/` | OpenClaw 配置目录 |
|
||||
|
||||
> ⚠️ **注意**:修改目录后需要重启应用,且对应的 CLI 工具也需要配置相同的目录。
|
||||
|
||||
@@ -98,6 +131,89 @@ CC Switch 自身数据的存储位置,默认为 `~/.cc-switch/`。
|
||||
|
||||
> ⚠️ **注意**:导入会覆盖现有配置,建议先导出当前配置作为备份。
|
||||
|
||||
## 代理设置
|
||||
|
||||
设置 → 代理 Tab
|
||||
|
||||
代理 Tab 集中管理所有代理相关功能:
|
||||
|
||||
### 本地代理
|
||||
|
||||
启动/停止本地代理服务,配置监听地址和端口。详见 [4.1 代理服务](../4-proxy/4.1-service.md)。
|
||||
|
||||
### 故障转移
|
||||
|
||||
按应用(Claude/Codex/Gemini)配置故障转移队列和自动切换策略。详见 [4.3 故障转移](../4-proxy/4.3-failover.md)。
|
||||
|
||||
### 定价矫正器
|
||||
|
||||
配置模型定价矫正规则,用于代理计费统计的校准。
|
||||
|
||||
### 全局出站代理
|
||||
|
||||
配置 CC Switch 的出站 HTTP/HTTPS 代理,适用于需要通过代理访问外部 API 的场景。
|
||||
|
||||
## 高级设置
|
||||
|
||||
设置 → 高级 Tab
|
||||
|
||||
### 配置目录
|
||||
|
||||
自定义各应用的配置文件目录。详见下方「目录配置」章节。
|
||||
|
||||
### 数据管理
|
||||
|
||||
导入/导出配置备份。详见下方「数据管理」章节。
|
||||
|
||||
### 备份与恢复
|
||||
|
||||
管理自动备份:
|
||||
|
||||
| 配置 | 说明 |
|
||||
| -------- | -------------------------- |
|
||||
| 备份间隔 | 自动备份的时间间隔(小时) |
|
||||
| 保留数量 | 保留的备份份数 |
|
||||
|
||||
支持查看备份列表和从备份恢复。
|
||||
|
||||
### 云同步(WebDAV)
|
||||
|
||||
通过 WebDAV 协议在多台设备间同步配置。
|
||||
|
||||
| 配置项 | 说明 |
|
||||
| -------- | ------------------------------------- |
|
||||
| 服务预设 | 坚果云 / Nextcloud / 群晖 / 自定义 |
|
||||
| 服务地址 | WebDAV 服务器 URL |
|
||||
| 用户名 | 登录用户名 |
|
||||
| 密码 | 登录密码(应用专用密码) |
|
||||
| 远程目录 | 远程存储路径(默认 `cc-switch-sync`) |
|
||||
| 配置名称 | 设备配置文件名(默认 `default`) |
|
||||
| 自动同步 | 开启后自动上传变更 |
|
||||
|
||||
操作:
|
||||
|
||||
- **测试连接**:验证 WebDAV 配置是否正确
|
||||
- **保存**:保存配置并自动测试
|
||||
- **上传**:将本地数据上传到远程
|
||||
- **下载**:从远程下载数据到本地
|
||||
|
||||
> ⚠️ **注意**:上传会覆盖远程数据,下载会覆盖本地数据。操作前请确认。
|
||||
|
||||
### 日志配置
|
||||
|
||||
| 配置项 | 说明 |
|
||||
| -------- | ----------------------------------- |
|
||||
| 启用日志 | 开启/关闭应用日志记录 |
|
||||
| 日志级别 | error / warn / info / debug / trace |
|
||||
|
||||
日志级别说明:
|
||||
|
||||
- **error** - 仅记录错误
|
||||
- **warn** - 记录警告和错误
|
||||
- **info** - 记录一般信息(推荐)
|
||||
- **debug** - 记录调试信息
|
||||
- **trace** - 记录所有详细信息
|
||||
|
||||
## 关于页面
|
||||
|
||||
设置 → 关于 Tab
|
||||
@@ -105,6 +221,7 @@ CC Switch 自身数据的存储位置,默认为 `~/.cc-switch/`。
|
||||
### 版本信息
|
||||
|
||||
显示当前 CC Switch 版本号,支持:
|
||||
|
||||
- 查看发布说明
|
||||
- 检查更新
|
||||
- 下载并安装新版本
|
||||
@@ -113,11 +230,13 @@ CC Switch 自身数据的存储位置,默认为 `~/.cc-switch/`。
|
||||
|
||||
自动检测已安装的 CLI 工具版本:
|
||||
|
||||
| 工具 | 检测内容 |
|
||||
|------|----------|
|
||||
| Claude | 当前版本、最新版本 |
|
||||
| Codex | 当前版本、最新版本 |
|
||||
| Gemini | 当前版本、最新版本 |
|
||||
| 工具 | 检测内容 |
|
||||
| -------- | ------------------ |
|
||||
| Claude | 当前版本、最新版本 |
|
||||
| Codex | 当前版本、最新版本 |
|
||||
| Gemini | 当前版本、最新版本 |
|
||||
| OpenCode | 当前版本、最新版本 |
|
||||
| OpenClaw | 当前版本、最新版本 |
|
||||
|
||||
点击「刷新」按钮可重新检测。
|
||||
|
||||
@@ -129,6 +248,8 @@ CC Switch 自身数据的存储位置,默认为 `~/.cc-switch/`。
|
||||
npm i -g @anthropic-ai/claude-code@latest
|
||||
npm i -g @openai/codex@latest
|
||||
npm i -g @google/gemini-cli@latest
|
||||
npm i -g opencode@latest
|
||||
npm i -g openclaw@latest
|
||||
```
|
||||
|
||||
点击「复制」按钮可复制到剪贴板。
|
||||
|
||||
Reference in New Issue
Block a user