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.8 KiB
1.4 Quick Start
This section helps you complete the initial setup in 5 minutes.
Step 1: Add a Provider
- Select the tool you want to manage in the left sidebar, then click the + (Add Provider) button in the top-right corner of the page
- Select your provider under "Provider Preset"
- Common presets: Zhipu GLM, MiniMax, DeepSeek, Kimi, PackyCode
- Or select "Custom" for manual configuration
- Enter your API Key
- Click "Add"
💡 Tip: The add panel supports searching by Chinese name and domain, and different plans and regions of the same provider are merged into one row. Presets auto-fill the endpoint URL, so you only need to enter your API Key.
Step 2: Switch Provider
After adding, the provider appears in the list.
Option 1: Switch from the app page
- Click the "Switch" button on the provider card, and its status changes to "In use"
- OpenCode, OpenClaw, Hermes, and MiniMax Code are coexist apps: the button is "Add" (for Pi, "Enable"), and you can add multiple providers at the same time
Option 2: Quick switch via system tray
- Right-click the CC Switch icon in the system tray
- Each tool has one row showing "name · mode · provider · quota"; click a provider name directly in the submenu (supported for Claude Code, Claude Desktop, Codex, Gemini CLI, and Grok Build)
Step 3: Activation
After switching providers, each CLI tool activates differently:
| Application | Activation Method |
|---|---|
| Claude Code | ✅ Instant effect (supports hot reload) |
| Claude Desktop | Requires restarting Claude Desktop |
| Codex | Requires closing and reopening the terminal |
| Gemini | Requires restarting Gemini CLI |
| Grok Build | Requires restarting Grok Build |
| OpenCode | Requires closing and reopening the terminal |
| OpenClaw | Requires closing and reopening the terminal |
| Hermes / Pi / MiniMax Code | Once added, the provider is written into the tool's configuration; for Pi and MiniMax Code, choose the model to use inside the tool; for Hermes, click "Enable" on the card to make it the current provider |
In Routing mode, switching providers for Claude Code, Codex, Gemini CLI, and Grok Build takes effect immediately for subsequent requests; however, if the switch changes the model, Codex, Gemini CLI, and Grok Build may still need a restart.
Direct, Routing, and Aggregation (Optional)
The pages of Claude Code, Codex, Gemini CLI, and Grok Build have "Direct / Routing" tabs at the top, and Claude Code and Codex also have "Aggregation". Clicking a tab only changes what you are viewing and does not change any configuration; to actually switch, click the button on the page that spells out the consequences: "Start routing" or "Switch to Aggregation", and "Back to direct" to return to Direct.
- Direct (default): The client connects to the provider directly; choose it for everyday use
- Routing: Requests go through CC Switch on this machine (default
127.0.0.1:15721), which can convert API formats and do failover. Choose it if you want to use an OpenAI- or Gemini-format provider in Claude Code, or Claude in Codex - Aggregation: Puts models from several providers into one model list, and a request goes to whichever provider owns the model you pick; no failover
Routing and Aggregation need CC Switch to keep running; quitting CC Switch automatically returns to Direct, and it reconnects the next time you start it. Official subscriptions do not go through routing (Codex's OpenAI Official is the exception). See Enable local routing for details.
Claude Code First Launch Prompt
If Claude Code prompts you to log in or shows an onboarding wizard on first launch, enable the "Skip Claude Code first-run confirmation" option in CC Switch:
- Open CC Switch "Settings → App config" and find the Claude Code block
- Enable the "Skip Claude Code first-run confirmation" toggle
- Restart Claude Code
⚠️ Note: This option writes
hasCompletedOnboarding: trueto~/.claude.json, skipping the official first-run confirmation flow.
Verify Configuration
After restarting, launch the corresponding CLI tool and enter a simple question to test:
# Claude Code - enter a test question after launching
claude
> Hello, please briefly introduce yourself
# Codex - enter a test question after launching
codex
> Hello, please briefly introduce yourself
# Gemini - enter a test question after launching
gemini
> Hello, please briefly introduce yourself
# OpenCode - enter a test question after launching
opencode
> Hello, please briefly introduce yourself
# OpenClaw - enter a test question after launching
openclaw
> Hello, please briefly introduce yourself
If the AI responds normally, the configuration is successful.
Note
: On first launch, CC Switch automatically imports the existing configuration of Claude Code, Codex, Gemini CLI, and Grok Build as a provider named
default, and adds an official provider for these tools and Claude Desktop. Your original configuration is not lost.
Next Steps
Congratulations! You have completed the basic configuration. Next, you can:
- Add more providers - Configure multiple providers for easy switching
- Configure MCP servers - Extend AI tool capabilities
- Set up system prompts - Customize AI behavior
- Enable local routing - Use providers that need format conversion, and enable automatic failover
- Manage AI coding tools - Install and upgrade tools on the sidebar "Apps" page, and choose which apps show in the sidebar
- View usage statistics - Track request counts, tokens, and costs
Common Issues
Not taking effect after switching?
Make sure you restarted the terminal or CLI tool. The configuration file is updated at switch time, but running programs do not automatically reload it.
Can't find a preset?
If your provider is not in the preset list, select "Custom" for manual configuration. See Add Provider for configuration format details.
How to restore official login?
The provider lists for Claude Code, Claude Desktop, Codex, Gemini CLI, and Grok Build each come with a built-in official provider (such as Claude Official, OpenAI Official, Google Official, and Grok Official). Switch to it, restart the client, and follow the tool's own login flow. If it is missing from the list (for example, because you deleted it or upgraded from an older version), you can add it again from the presets.