mirror of https://github.com/farion1231/cc-switch.git synced 2026-04-23 09:29:13 +08:00

Files

Dex Miller 0fcb1b01e2 docs: add user manual documentation (#979 )

* 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>

2026-02-09 15:01:15 +08:00

3.2 KiB

Raw Blame History

1.5 个性化配置

本节介绍如何根据个人偏好配置 CC Switch。

打开设置

点击左上角 ⚙️ 按钮
或使用快捷键 Cmd/Ctrl + ,

语言设置

CC Switch 支持三种语言：

语言	说明
简体中文	默认语言
English	英文界面
日本語	日文界面

切换语言后立即生效，无需重启。

主题设置

选项	说明
跟随系统	自动匹配系统的深色/浅色模式
浅色	始终使用浅色主题
深色	始终使用深色主题

窗口行为

开机自启

开启后，系统启动时自动运行 CC Switch。

Windows：通过注册表实现
macOS：通过 LaunchAgent 实现
Linux：通过 XDG autostart 实现

关闭行为

选项	说明
最小化到托盘	点击关闭按钮时隐藏到系统托盘
直接退出	点击关闭按钮时完全退出应用

推荐使用「最小化到托盘」，方便通过托盘快速切换供应商。

Claude 插件集成

开启后，CC Switch 在切换供应商时会自动同步配置到 VS Code 中的 Claude Code 插件（写入 ~/.claude/config.json 的 primaryApiKey）。

💡 使用场景：如果你同时使用 Claude Code CLI 和 VS Code 插件，开启此选项可以保持两者配置一致。

跳过 Claude 引导

开启后，跳过 Claude Code 的新手引导流程，适合已熟悉 Claude Code 的用户。

⚠️ 注意：此选项会写入 ~/.claude/settings.json 的 skipIntroduction 字段。

目录配置

应用配置目录

CC Switch 自身数据的存储位置，默认为 ~/.cc-switch/。

CLI 工具目录

可以自定义各 CLI 工具的配置目录：

配置	默认值	说明
Claude 目录	`~/.claude/`	Claude Code 配置目录
Codex 目录	`~/.codex/`	Codex 配置目录
Gemini 目录	`~/.gemini/`	Gemini CLI 配置目录

⚠️ 注意：修改目录后需要重启应用，且对应的 CLI 工具也需要配置相同的目录。

数据管理

导出配置

点击「导出」按钮，保存包含以下内容的备份文件：

所有供应商配置
MCP 服务器配置
Prompts 预设
应用设置

备份文件格式为 JSON，可以用文本编辑器查看。

导入配置

点击「选择文件」
选择之前导出的备份文件
点击「导入」
确认覆盖现有配置

⚠️ 注意：导入会覆盖现有配置，建议先导出当前配置作为备份。

关于页面

设置 → 关于 Tab

版本信息

显示当前 CC Switch 版本号，支持：

查看发布说明
检查更新
下载并安装新版本

本地环境检查

自动检测已安装的 CLI 工具版本：

工具	检测内容
Claude	当前版本、最新版本
Codex	当前版本、最新版本
Gemini	当前版本、最新版本

点击「刷新」按钮可重新检测。

一键安装命令

提供快速安装/更新 CLI 工具的命令：

npm i -g @anthropic-ai/claude-code@latest
npm i -g @openai/codex@latest
npm i -g @google/gemini-cli@latest

点击「复制」按钮可复制到剪贴板。

3.2 KiB Raw Blame History Unescape Escape