mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-07-24 12:44:18 +08:00
Jason
a058ebeafc
Refresh the user manual to cover the v3.13.0 feature set so users can discover and correctly use new functionality without cross-referencing the release notes. All three language versions are updated line-by-line symmetric. Highlights: - Lightweight Mode: tray-only running state added in 1.5-settings, with a comparison table against "Minimize to tray" and a new OAuth Auth Center (Beta) section - Quota & Balance display restructured in 2.5-usage-query: split into auto-query (Claude/Codex/Gemini official, Copilot, Codex OAuth) vs manual-enable (Token Plan, third-party balances). Explains why manual enabling is required: the same API URL may expose both plan-quota and balance query modes - Codex OAuth reverse proxy: full usage guide in 2.1-add with two entry points (Add Provider panel / OAuth Auth Center), Device Code login flow, token auto-refresh, multi-account management, quota display, common failures, and risk notice - Full URL Endpoint Mode: new advanced option in 2.1-add - Per-app tray submenus: 2.2-switch refactored to reflect the 5-app submenu structure and cross-link to Lightweight Mode - Skills workflow: remove obsolete "automatic update not supported" section in 3.3-skills, add SHA-256 update detection, single/batch update, storage location switch, and skills.sh registry search - Directory picker for Claude terminal resume in 3.4-sessions - Usage stats in 4.4-usage: document the new CLI session log source (no proxy required) and per-app filtering for Claude/Codex/Gemini; note CNY->USD pricing corrections and MiniMax quota fixes - Stream Check coverage extended to OpenCode/OpenClaw in 4.5-model-test - New FAQs in 5.2-questions: quota visibility (auto vs manual), Codex OAuth risks and login flow, deep link wake in Lightweight Mode - v3.13.0 highlights navigation block added to top-level README and each per-language README; version bumped to v3.13.0 / 2026-04-08
126 lines
5.8 KiB
Markdown
126 lines
5.8 KiB
Markdown
# CC Switch User Manual
|
|
|
|
> All-in-One Assistant for Claude Code / Codex / Gemini CLI / OpenCode / OpenClaw
|
|
|
|
## 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
|
|
│
|
|
├── 3. Extensions
|
|
│ ├── 3.1 MCP Server Management
|
|
│ ├── 3.2 Prompts Management
|
|
│ ├── 3.3 Skills Management
|
|
│ ├── 3.4 Session Manager
|
|
│ └── 3.5 Workspace & Memory
|
|
│
|
|
├── 4. Proxy & High Availability
|
|
│ ├── 4.1 Proxy Service
|
|
│ ├── 4.2 App Takeover
|
|
│ ├── 4.3 Failover
|
|
│ ├── 4.4 Usage Statistics
|
|
│ └── 4.5 Model Test
|
|
│
|
|
└── 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](./1-getting-started/1.1-introduction.md) | Introduction, core features, supported platforms |
|
|
| [1.2-installation.md](./1-getting-started/1.2-installation.md) | Windows/macOS/Linux installation guide |
|
|
| [1.3-interface.md](./1-getting-started/1.3-interface.md) | Interface layout, navigation bar, provider cards |
|
|
| [1.4-quickstart.md](./1-getting-started/1.4-quickstart.md) | 5-minute quick start tutorial |
|
|
| [1.5-settings.md](./1-getting-started/1.5-settings.md) | Language, theme, directories, cloud sync settings |
|
|
|
|
### 2. Provider Management
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| [2.1-add.md](./2-providers/2.1-add.md) | Using presets, custom configuration, universal providers |
|
|
| [2.2-switch.md](./2-providers/2.2-switch.md) | Main UI switching, tray switching, activation methods |
|
|
| [2.3-edit.md](./2-providers/2.3-edit.md) | Edit configuration, modify API Key, backfill mechanism |
|
|
| [2.4-sort-duplicate.md](./2-providers/2.4-sort-duplicate.md) | Drag-to-reorder, duplicate provider, delete |
|
|
| [2.5-usage-query.md](./2-providers/2.5-usage-query.md) | Usage query, remaining balance, multi-plan display |
|
|
|
|
### 3. Extensions
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| [3.1-mcp.md](./3-extensions/3.1-mcp.md) | MCP protocol, add servers, app binding |
|
|
| [3.2-prompts.md](./3-extensions/3.2-prompts.md) | Create presets, activate/switch, smart backfill |
|
|
| [3.3-skills.md](./3-extensions/3.3-skills.md) | Discover skills, install/uninstall, repository management |
|
|
| [3.4-sessions.md](./3-extensions/3.4-sessions.md) | Session Manager: browse, search, resume, delete sessions |
|
|
| [3.5-workspace.md](./3-extensions/3.5-workspace.md) | Workspace files and daily memory (OpenClaw) |
|
|
|
|
### 4. Proxy & High Availability
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| [4.1-service.md](./4-proxy/4.1-service.md) | Start proxy, configuration, running status |
|
|
| [4.2-takeover.md](./4-proxy/4.2-takeover.md) | App takeover, configuration changes, status indicators |
|
|
| [4.3-failover.md](./4-proxy/4.3-failover.md) | Failover queue, circuit breaker, health status |
|
|
| [4.4-usage.md](./4-proxy/4.4-usage.md) | Usage statistics, trend charts, pricing configuration |
|
|
| [4.5-model-test.md](./4-proxy/4.5-model-test.md) | Model test, health check, latency testing |
|
|
|
|
### 5. FAQ
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| [5.1-config-files.md](./5-faq/5.1-config-files.md) | CC Switch storage, CLI configuration file formats |
|
|
| [5.2-questions.md](./5-faq/5.2-questions.md) | Frequently asked questions |
|
|
| [5.3-deeplink.md](./5-faq/5.3-deeplink.md) | Deep link protocol, generation and usage |
|
|
| [5.4-env-conflict.md](./5-faq/5.4-env-conflict.md) | Environment variable conflict detection and resolution |
|
|
|
|
## Quick Links
|
|
|
|
- **New users**: Start with [1.1 Introduction](./1-getting-started/1.1-introduction.md)
|
|
- **Installation issues**: See [1.2 Installation Guide](./1-getting-started/1.2-installation.md)
|
|
- **Configure providers**: See [2.1 Add Provider](./2-providers/2.1-add.md)
|
|
- **Using proxy**: See [4.1 Proxy Service](./4-proxy/4.1-service.md)
|
|
- **Having trouble**: See [5.2 FAQ](./5-faq/5.2-questions.md)
|
|
|
|
## Version Information
|
|
|
|
- Documentation version: v3.13.0
|
|
- Last updated: 2026-04-08
|
|
- Applicable to CC Switch v3.13.0+
|
|
|
|
### v3.13.0 Highlights
|
|
|
|
- **Lightweight Mode**: Destroys the main window when minimizing to tray — near-zero idle footprint. See [1.5 Personalization](./1-getting-started/1.5-settings.md)
|
|
- **Quota & Balance Display**: Official subscriptions (Claude/Codex/Gemini/Copilot/Codex OAuth) auto-display quotas; Token Plan and third-party balances use built-in templates with one-click enable — see [2.5 Usage Query](./2-providers/2.5-usage-query.md)
|
|
- **Codex OAuth Reverse Proxy**: Reuse your ChatGPT account's Codex service inside Claude Code — see [2.1 Add Provider](./2-providers/2.1-add.md)
|
|
- **Per-App Tray Submenus**: Five independent app submenus to prevent tray overflow — see [2.2 Switch Provider](./2-providers/2.2-switch.md)
|
|
- **Skills Discovery & Batch Updates**: SHA-256 update detection, batch updates, skills.sh public registry search — see [3.3 Skills Management](./3-extensions/3.3-skills.md)
|
|
- **Full URL Endpoint Mode**: Advanced option to treat `base_url` as the full upstream endpoint — see [2.1 Add Provider](./2-providers/2.1-add.md)
|
|
- **OpenCode / OpenClaw Stream Check Coverage**: Stream Check panel extended to all five apps — see [4.5 Model Test](./4-proxy/4.5-model-test.md)
|
|
|
|
## Contributing
|
|
|
|
Feel free to submit Issues or PRs to improve the documentation:
|
|
|
|
- [GitHub Issues](https://github.com/farion1231/cc-switch/issues)
|
|
- [GitHub Repository](https://github.com/farion1231/cc-switch)
|