agent/cc-switch
1
0
Fork 0
mirror of https://github.com/farion1231/cc-switch.git synced 2026-06-16 13:34:04 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
09f67c1b383cbc2475f5678cce9688299a32b5ee
cc-switch/docs/user-manual/en/README.md
T
Jason ddde7f13b3 - docs: update user manual for v3.15.0 
- Sync zh/en/ja manuals with Claude Desktop and Hermes support

- Update install requirements, official channels, and release asset guidance

- Document Usage Hero, Codex OAuth live models, Save Anyway, Hermes sessions, and Warp launch

- Correct tray and app-scope descriptions to match current implementation
2026-05-18 16:59:13 +08:00

7.0 KiB
Raw Blame History

CC Switch User Manual

All-in-One Assistant for Claude Code / Claude Desktop / Codex / Gemini CLI / OpenCode / OpenClaw / Hermes

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. 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 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, backfill mechanism
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. Proxy & High Availability

File Description
4.1-service.md Start proxy, configuration, running status
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 Model test, health check, latency testing

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

Version Information

  • Documentation version: v3.15.0
  • Last updated: 2026-05-16
  • Applicable to CC Switch v3.15.0+

v3.15.0 Highlights

  • First-class Claude Desktop panel: supports third-party providers, direct / model mapping modes, Copilot / Codex OAuth reuse, and 3P profile writing. See 2.6 Claude Desktop
  • Role-based model mapping: adapts Claude Desktop model validation with Sonnet / Opus / Haiku routes and supports1m
  • Claude Desktop local routing: provides a local gateway at 127.0.0.1:15721/claude-desktop for providers that need conversion
  • Routing support badges: Claude Code / Codex provider cards indicate whether a provider can be served through Local Routing
  • Codex OAuth live model discovery: ChatGPT Codex providers fetch available models from the ChatGPT backend on demand
  • Filter-driven Usage Hero: shows cache-normalized real total tokens and cache hit rate, updating with date / provider / model filters — see 4.4 Usage Statistics
  • Lightweight Mode: Destroys the main window when minimizing to tray — near-zero idle footprint. See 1.5 Personalization
  • 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
  • Codex OAuth Reverse Proxy: Reuse your ChatGPT account's Codex service inside Claude Code — see 2.1 Add Provider
  • Per-App Tray Submenus: Claude / Codex / Gemini submenus show the current provider and available usage summaries — see 2.2 Switch Provider
  • Skills Discovery & Batch Updates: SHA-256 update detection, batch updates, skills.sh public registry search — see 3.3 Skills Management
  • Full URL Endpoint Mode: Advanced option to treat base_url as the full upstream endpoint — see 2.1 Add Provider
  • OpenCode / OpenClaw Stream Check Coverage: Stream Check covers Claude / Codex / Gemini / OpenCode / OpenClaw — see 4.5 Model Test

Contributing

Feel free to submit Issues or PRs to improve the documentation:

Reference in New Issue View Git Blame Copy Permalink