mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-10-26 01:34:51 +08:00
Jason
efd236a474
Bring the zh, en and ja user manuals up to the v4.0.4 interface: the sidebar layout, the six Settings groups, the Direct / Routing / Aggregation connection modes, Accounts, and the Apps page. Old Settings paths (Advanced, Routing, Auth) and takeover wording are gone. - Add 4.6 Aggregation Mode in all three languages and list it in the manual indexes. - Rewrite 1.3 Interface Overview and 1.5 Settings around the new layout; refresh provider, extension, routing, usage and FAQ pages. - Use the v4.0 release screenshots where they fit and leave TODO(v4 screenshot) markers elsewhere. - Update the version section of each manual index to v4.0.4. - Remove the 40 v3 screenshots that are no longer referenced.
6.6 KiB
6.6 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
│ └── 4.6 Aggregation Mode
│
└── 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 | Sidebar layout, connection mode tabs, provider cards |
| 1.4-quickstart.md | 5-minute quick start tutorial |
| 1.5-settings.md | The six Settings groups: General, App config, Local routing, Network, Data, About |
2. Provider Management
| File | Description |
|---|---|
| 2.1-add.md | Using presets, custom configuration, universal providers |
| 2.2-switch.md | Direct / Routing / Aggregation, 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 prompts, enable/switch, target files |
| 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 |
| 4.6-aggregation.md | Aggregation mode, default provider, ccs- prefix, Codex restart |
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: v4.0.4
- Last updated: 2026-10-07
- Applicable to CC Switch v4.0.4+
Recent Major Changes (v4.0)
- Redesigned interface: the top navigation is replaced by a left sidebar, with separate pages for Usage, Accounts, MCP, Skills, Prompts, Sessions, and Apps; Settings is split into six groups: General, App config, Local routing, Network, Data, About — see 1.3 Interface Overview and 1.5 Personalization
- Three connection modes: Direct / Routing / Aggregation: chosen at the top of each app page; going back to direct is one step — see 2.2 Switch Provider
- New Aggregation mode: Claude Code and Codex can mix models from several providers in one session — see 4.6 Aggregation Mode
- Switching only changes key fields: everything other than the address, key, model, and other key fields is left as is; common config snippets are no longer used — see 2.3 Edit Provider
- Accounts: ChatGPT, GitHub Copilot, xAI, and other sign-ins are managed in one place under Accounts in the sidebar — see 1.5 Personalization
- Apps page: install and upgrade each CLI tool, and choose which apps show in the sidebar — see 1.2 Installation Guide
- For the full list of changes, see the v4.0 release notes
Contributing
Feel free to submit Issues or PRs to improve the documentation: