mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-07-24 12:44:18 +08:00
makoMakoGo
693c3872f0
* docs(usage): document pricing model matching rules * docs: refresh user manual for current app support * docs: clarify Hermes configuration files * docs: align feature docs with visible app support
191 lines
7.0 KiB
Markdown
191 lines
7.0 KiB
Markdown
# 1.3 Interface Overview
|
|
|
|
## Main Interface Layout
|
|
|
|
|
|
|
|
## Top Navigation Bar
|
|
|
|
| # | Element | Description |
|
|
|---|---------|-------------|
|
|
| 1 | Logo | Click to visit the GitHub project page |
|
|
| 2 | Settings Button | Open the settings page (shortcut `Cmd/Ctrl + ,`) |
|
|
| 3 | Proxy Toggle | Start/stop the local proxy service |
|
|
| 4 | App Switcher | Switch between Claude / Claude Desktop / Codex / Gemini / OpenCode / OpenClaw / Hermes |
|
|
| 5 | Feature Area | App-specific feature entry points |
|
|
| 6 | Add Button | Add a new provider |
|
|
|
|
### App Switcher
|
|
|
|
Click the dropdown menu to switch the currently managed application:
|
|
|
|
- **Claude** - Manage Claude Code configuration
|
|
- **Claude Desktop** - Manage Claude Desktop third-party providers and official mode
|
|
- **Codex** - Manage Codex configuration
|
|
- **Gemini** - Manage Gemini CLI configuration
|
|
- **OpenCode** - Manage OpenCode configuration
|
|
- **OpenClaw** - Manage OpenClaw configuration
|
|
- **Hermes** - Manage Hermes Agent providers and Memory
|
|
|
|
After switching, the provider list displays the configurations for the selected application.
|
|
|
|
### Feature Area Buttons
|
|
|
|
| Button | Function | Visibility |
|
|
|--------|----------|------------|
|
|
| Skills | Skill extension management | Claude / Codex / Gemini / OpenCode / Hermes |
|
|
| Prompts | System prompt management | Claude / Codex / Gemini / OpenCode |
|
|
| MCP | MCP server management | Claude / Codex / Gemini / OpenCode / Hermes |
|
|
|
|
## Provider Cards
|
|
|
|
Each provider is displayed as a card, containing the following elements from left to right:
|
|
|
|
### Card Elements (Left to Right)
|
|
|
|
| # | Element | Icon | Description |
|
|
|---|---------|------|-------------|
|
|
| 1 | Drag Handle | ≡ | Hold and drag up/down to reorder providers |
|
|
| 2 | Provider Icon | - | Displays provider brand icon with customizable color |
|
|
| 3 | Provider Info | - | Name, notes/endpoint URL (clickable to open website) |
|
|
| 4 | Usage Info | - | Shows remaining balance; displays plan count for multi-plan |
|
|
| 5 | Enable Button | - | Switch to this provider |
|
|
| 6 | Edit Button | - | Edit provider configuration |
|
|
| 7 | Duplicate Button | - | Duplicate provider (create a copy) |
|
|
| 8 | Speed Test Button | - | Test model availability and response speed |
|
|
| 9 | Usage Query | - | Configure usage query script |
|
|
| 10 | Delete Button | - | Delete provider (disabled when currently active) |
|
|
|
|
> **Tip**: The action buttons area (5-10) appears on hover and is hidden by default to keep the interface clean.
|
|
|
|
Starting from v3.15.0, some Claude Code and Codex provider cards also show a **Local Routing support badge**, helping you quickly identify providers that can be served through local routing.
|
|
|
|
### Button Details
|
|
|
|
| Button | State Changes | Notes |
|
|
|--------|---------------|-------|
|
|
| **Enable** | Shows checkmark and disables when active | Changes to "Join/Joined" in failover mode |
|
|
| **Edit** | Always available | Opens edit panel to modify configuration |
|
|
| **Duplicate** | Always available | Creates a copy with `copy` suffix |
|
|
| **Speed Test** | Shows loading animation during test | Only available when proxy service is running |
|
|
| **Usage Query** | Always available | Configure custom usage query script |
|
|
| **Delete** | Semi-transparent/disabled when active | Must switch to another provider first |
|
|
|
|
### Card States
|
|
|
|
| State | Border Color | Description |
|
|
|-------|--------------|-------------|
|
|
| **Currently Active** | Blue border | Current provider in normal mode |
|
|
| **Proxy Active** | Green border | Provider actually in use during proxy takeover mode |
|
|
| **Normal** | Default border | Inactive provider |
|
|
| **In Failover** | Shows priority badge | e.g., P1, P2 indicates failover priority |
|
|
|
|
### Health Status Badges
|
|
|
|
In proxy mode, providers in the failover queue display health status:
|
|
|
|
| Badge | Color | Description |
|
|
|-------|-------|-------------|
|
|
| Healthy | Green | 0 consecutive failures |
|
|
| Warning | Yellow | 1-2 consecutive failures |
|
|
| Unhealthy | Red | 3+ consecutive failures, may trigger circuit breaker |
|
|
|
|
|
|
## System Tray
|
|
|
|
CC Switch displays an icon in the system tray, providing quick access to operations.
|
|
|
|
### Tray Menu Structure
|
|
|
|
|
|
|
|
### Menu Functions
|
|
|
|
| Menu Item | Function |
|
|
|-----------|----------|
|
|
| Open Main Window | Show and focus the main window |
|
|
| App Submenus | Collapsible submenus grouped by Claude/Codex/Gemini (e.g., "Claude · PackyCode"), with current provider and cached usage summaries when available |
|
|
| Provider List | Inside each submenu, click to switch; currently active shows a checkmark |
|
|
| Lightweight Mode | Toggle checkbox to enter/exit tray-only mode |
|
|
| Quit | Fully exit the application |
|
|
|
|
> **Note**: Each tray submenu title shows the current provider name (e.g., "Claude · PackyCode"). Apps with no configured providers show a disabled "(no providers)" entry. The tray currently focuses on Claude / Codex / Gemini, the apps that support proxy routing and usage summaries; main-window app visibility is still controlled by the App Visibility setting.
|
|
|
|
### Multi-language Support
|
|
|
|
The tray menu supports four languages, automatically switching based on settings:
|
|
|
|
| Language | Open Main Window | Quit |
|
|
|----------|-----------------|------|
|
|
| Simplified Chinese | 打开主界面 | 退出 |
|
|
| Traditional Chinese | 開啟主介面 | 退出 |
|
|
| English | Open main window | Quit |
|
|
| Japanese | メインウィンドウを開く | 終了 |
|
|
|
|
### Lightweight Mode
|
|
|
|
The tray menu includes a **Lightweight Mode** toggle (checkbox). When enabled:
|
|
|
|
- The main window is closed to free up resources
|
|
- The app continues running in the system tray only
|
|
- You can still switch providers via the tray submenus
|
|
- On macOS, the Dock icon is also hidden
|
|
|
|
To exit Lightweight Mode, uncheck the toggle or click "Open main window" — the main window will be rebuilt and shown.
|
|
|
|
### Use Cases
|
|
|
|
Switching providers via the tray menu doesn't require opening the main window, suitable for:
|
|
|
|
- Frequently switching providers
|
|
- Quick operations when the main window is minimized
|
|
- Managing configurations while running in the background
|
|
- Running in Lightweight Mode for minimal resource usage
|
|
|
|
## Settings Page
|
|
|
|
The settings page is divided into multiple tabs:
|
|
|
|
### General Tab
|
|
|
|
- Language settings (Simplified Chinese/Traditional Chinese/English/Japanese)
|
|
- Theme settings (System/Light/Dark)
|
|
- Window behavior (launch on startup, close behavior)
|
|
|
|
### Advanced Tab
|
|
|
|
- Configuration directory settings
|
|
- Proxy service configuration
|
|
- Failover settings
|
|
- Pricing configuration
|
|
- Data import/export
|
|
|
|
### Usage Tab
|
|
|
|
- Request statistics overview
|
|
- Trend charts
|
|
- Request logs
|
|
- Provider/model statistics
|
|
|
|
### About Tab
|
|
|
|
- Version information
|
|
- Update check
|
|
- Open source license
|
|
|
|
## Keyboard Shortcuts
|
|
|
|
| Shortcut | Function |
|
|
|----------|----------|
|
|
| `Cmd/Ctrl + ,` | Open Settings |
|
|
| `Cmd/Ctrl + F` | Search providers |
|
|
| `Esc` | Close dialog/search |
|
|
|
|
## Search
|
|
|
|
Press `Cmd/Ctrl + F` to open the search bar:
|
|
|
|
- Search by name, notes, or URL
|
|
- Real-time provider list filtering
|
|
- Press `Esc` to close search
|