mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-10-26 01:34:51 +08:00
Jason
aa99584851
Brings the README FAQ (English, Japanese, German) and the English and Japanese user manuals in line with the Chinese master text. - README FAQ: switching no longer touches plugins, hooks and other shared settings; a model changed in the client resets on switching back; routing keeps the direct provider and writes it back on exit; the device-local files; the restart note now covers Gemini CLI. - Manual: the config editor section replaces backfill; the add dialog follows the same rules; quick toggles are marked global or per provider; the keys each app's switch changes; config ownership, malformed files and the first-write backup; routing writes back the direct provider; the Codex login is restored when switching back to an official card; Gemini auth follows the provider type.
6.3 KiB
6.3 KiB
CC Switch User Manual
All-in-One Assistant for Claude Code / Claude Desktop / Codex / Gemini CLI / Grok Build / OpenCode / OpenClaw / Hermes / Pi / MiniMax Code
Table of Contents
📚 CC Switch User Manual
│
├── 1. Getting Started
│ ├── 1.1 Introduction
│ ├── 1.2 Installation Guide
│ ├── 1.3 Interface Overview
│ ├── 1.4 Quick Start
│ └── 1.5 Personalization
│
├── 2. Provider Management
│ ├── 2.1 Add Provider
│ ├── 2.2 Switch Provider
│ ├── 2.3 Edit Provider
│ ├── 2.4 Sort & Duplicate
│ ├── 2.5 Usage Query
│ └── 2.6 Claude Desktop
│
├── 3. Extensions
│ ├── 3.1 MCP Server Management
│ ├── 3.2 Prompts Management
│ ├── 3.3 Skills Management
│ ├── 3.4 Session Manager
│ └── 3.5 Workspace & Memory
│
├── 4. Local Routing & High Availability
│ ├── 4.1 Local Routing Service
│ ├── 4.2 App Routing
│ ├── 4.3 Failover
│ ├── 4.4 Usage Statistics
│ └── 4.5 Connectivity Check
│
└── 5. FAQ
├── 5.1 Configuration Files
├── 5.2 FAQ
├── 5.3 Deep Link Protocol
└── 5.4 Environment Variable Conflicts
File List
1. Getting Started
| File | Description |
|---|---|
| 1.1-introduction.md | Introduction, core features, supported platforms |
| 1.2-installation.md | Windows/macOS/Linux installation guide |
| 1.3-interface.md | Interface layout, navigation bar, provider cards |
| 1.4-quickstart.md | 5-minute quick start tutorial |
| 1.5-settings.md | Language, theme, directories, cloud sync settings |
2. Provider Management
| File | Description |
|---|---|
| 2.1-add.md | Using presets, custom configuration, universal providers |
| 2.2-switch.md | Main UI switching, tray switching, activation methods |
| 2.3-edit.md | Edit configuration, modify API Key, global settings and edit conflicts |
| 2.4-sort-duplicate.md | Drag-to-reorder, duplicate provider, delete |
| 2.5-usage-query.md | Usage query, remaining balance, multi-plan display |
| 2.6-claude-desktop.md | Claude Desktop third-party providers, direct mode, and model mapping |
3. Extensions
| File | Description |
|---|---|
| 3.1-mcp.md | MCP protocol, add servers, app binding |
| 3.2-prompts.md | Create presets, activate/switch, smart backfill |
| 3.3-skills.md | Discover skills, install/uninstall, repository management |
| 3.4-sessions.md | Session Manager: browse, search, resume, delete sessions |
| 3.5-workspace.md | Workspace files and daily memory (OpenClaw) |
4. Local Routing & High Availability
| File | Description |
|---|---|
| 4.1-service.md | Start local routing, configuration, API format conversion |
| 4.2-routing.md | App routing, configuration changes, status indicators |
| 4.3-failover.md | Failover queue, circuit breaker, health status |
| 4.4-usage.md | Usage statistics, trend charts, pricing configuration |
| 4.5-model-test.md | Connectivity check, check parameters |
5. FAQ
| File | Description |
|---|---|
| 5.1-config-files.md | CC Switch storage, CLI configuration file formats |
| 5.2-questions.md | Frequently asked questions |
| 5.3-deeplink.md | Deep link protocol, generation and usage |
| 5.4-env-conflict.md | Environment variable conflict detection and resolution |
Quick Links
- New users: Start with 1.1 Introduction
- Installation issues: See 1.2 Installation Guide
- Configure providers: See 2.1 Add Provider
- Use Claude Desktop: See 2.6 Claude Desktop
- Use local routing: See 4.1 Local Routing Service
- Having trouble: See 5.2 FAQ
Version Information
- Documentation version: v3.20.4
- Last updated: 2026-09-26
- Applicable to CC Switch v3.20.4+
Recent Major Changes
- New managed apps: Grok Build (v3.18.0), Pi (v3.20.0), and MiniMax Code (v3.20.4), bringing the total to 10 managed apps — see 1.1 Introduction
- Official Codex presets now connect directly via native Responses: DeepSeek, Zhipu GLM (v3.20.2), Kimi (v3.20.3), and others no longer need local routing for protocol conversion — see 2.1 Add Provider
- Codex switching writes only config.toml: third-party API keys are no longer written to
auth.json(v3.20.1) — see 1.5 Personalization → Codex App Enhancements - "Upstream Format" replaces the "Needs Local Routing" toggle (v3.16.5) — see 2.1 Add Provider
- Connectivity check replaces model test: it only checks whether the address is reachable and no longer sends real model requests (v3.16.3) — see 4.5 Connectivity Check
- Usage statistics without local routing: usage is imported from each tool's local session logs — see 4.4 Usage Statistics
- Cloud sync supports S3-compatible storage — see 1.5 Personalization
Contributing
Feel free to submit Issues or PRs to improve the documentation: