mirror of
https://github.com/farion1231/cc-switch.git
synced 2026-07-24 12:44:18 +08:00
docs: update user manual to v3.12.3 with new features coverage (en/zh/ja)
Add documentation for features introduced since v3.12.0: New docs: - 3.4 Session Manager: browse, search, resume, delete sessions - 3.5 Workspace & Daily Memory: OpenClaw workspace file editing Updated docs: - Add Lightweight Mode to interface overview and FAQ - Add tray submenu structure (providers grouped by app) - Add API Format selection (Anthropic/OpenAI Chat/OpenAI Responses) - Add Auto-Fetch Models button documentation - Add Claude Common Config quick toggles - Add Codex 1M Context Window toggle - Add Skill backup/restore lifecycle - Expand Backup Management panel documentation - Update WebDAV sync to v2 protocol with dual-layer versioning - Add OpenCode/OpenClaw to quickstart activation table - Update README version to v3.12.3 All changes synced across en, zh, and ja locales.
This commit is contained in:
Jason
@@ -100,10 +100,13 @@ CC Switch displays an icon in the system tray, providing quick access to operati
|
||||
| Menu Item | Function |
|
||||
|-----------|----------|
|
||||
| Open Main Window | Show and focus the main window |
|
||||
| App Groups | Providers grouped by Claude/Codex/Gemini/OpenCode/OpenClaw |
|
||||
| Provider List | Click to switch; currently active one shows a checkmark |
|
||||
| App Submenus | Collapsible submenus grouped by Claude/Codex/Gemini (e.g., "Claude · PackyCode") |
|
||||
| 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 app submenu title shows the current provider name (e.g., "Claude · PackyCode"). Apps with no configured providers show a disabled "(no providers)" entry. App visibility is controlled by the App Visibility setting.
|
||||
|
||||
### Multi-language Support
|
||||
|
||||
The tray menu supports three languages, automatically switching based on settings:
|
||||
@@ -114,6 +117,17 @@ The tray menu supports three languages, automatically switching based on setting
|
||||
| English | Open main window | Quit |
|
||||
| Japanese | Open main window | Quit |
|
||||
|
||||
### 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:
|
||||
@@ -121,6 +135,7 @@ Switching providers via the tray menu doesn't require opening the main window, s
|
||||
- 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
|
||||
|
||||
|
||||
@@ -35,6 +35,8 @@ After switching providers, each CLI tool activates differently:
|
||||
| Claude Code | Instant effect (supports hot reload) |
|
||||
| Codex | Requires closing and reopening the terminal |
|
||||
| Gemini | Instant effect (re-reads config on each request) |
|
||||
| OpenCode | Requires closing and reopening the terminal |
|
||||
| OpenClaw | Requires closing and reopening the terminal |
|
||||
|
||||
### Claude Code First Launch Prompt
|
||||
|
||||
@@ -64,6 +66,14 @@ codex
|
||||
# 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.
|
||||
|
||||
@@ -167,37 +167,74 @@ Import/export configuration backups. See the "Data Management" section above for
|
||||
|
||||
### Backup & Restore
|
||||
|
||||
Manage automatic backups:
|
||||
The Backup Management panel provides full control over database backups.
|
||||
|
||||
| Setting | Description |
|
||||
|---------|-------------|
|
||||
| Backup Interval | Time interval for automatic backups (hours) |
|
||||
| Retention Count | Number of backups to retain |
|
||||
#### Auto-Backup Settings
|
||||
|
||||
Supports viewing the backup list and restoring from backups.
|
||||
| Setting | Options | Default |
|
||||
|---------|---------|---------|
|
||||
| Backup Interval | Disabled, 6h, 12h, 24h, 48h, 7d | 24 hours |
|
||||
| Retention Count | 3, 5, 10, 15, 20, 30, 50 | 10 backups |
|
||||
|
||||
When an interval is set, CC Switch automatically backs up the database on schedule. Older backups beyond the retention count are automatically removed.
|
||||
|
||||
#### Backup List
|
||||
|
||||
The panel displays all existing backups with:
|
||||
- **Display name** (auto-generated from timestamp, e.g., `db_backup_20260315_143000`)
|
||||
- **Creation time**
|
||||
- **File size** (e.g., "1.5 MB")
|
||||
|
||||
#### Backup Operations
|
||||
|
||||
| Action | Description |
|
||||
|--------|-------------|
|
||||
| **Backup Now** | Create a backup immediately |
|
||||
| **Restore** | Restore the database from a selected backup. A safety backup of the current database is created automatically before restoring |
|
||||
| **Rename** | Change the backup's display name |
|
||||
| **Delete** | Permanently remove a backup (with confirmation) |
|
||||
|
||||
> **Important**: Restoring a backup overwrites the current database. A safety backup is always created before the restore operation, so you can recover if needed.
|
||||
|
||||
### Cloud Sync (WebDAV)
|
||||
|
||||
Sync configurations across multiple devices via the WebDAV protocol.
|
||||
Sync configurations across multiple devices via the WebDAV protocol. Uses **v2 protocol** with dual-layer versioning for improved reliability.
|
||||
|
||||
| Setting | Description |
|
||||
|---------|-------------|
|
||||
| Service Preset | Jianguoyun / Nextcloud / Synology / Custom |
|
||||
| Server URL | WebDAV server URL |
|
||||
| Username | Login username |
|
||||
| Password | Login password (app-specific password) |
|
||||
| Password | Login password (app-specific password; saved credentials are preserved if left unchanged) |
|
||||
| Remote Directory | Remote storage path (default: `cc-switch-sync`) |
|
||||
| Profile Name | Device profile name (default: `default`) |
|
||||
| Auto Sync | Automatically upload changes when enabled |
|
||||
| Auto Sync | Enable automatic synchronization on a configurable interval |
|
||||
|
||||
Operations:
|
||||
#### Operations
|
||||
|
||||
- **Test Connection**: Verify WebDAV configuration is correct
|
||||
- **Save**: Save configuration and auto-test
|
||||
- **Upload**: Upload local data to the remote server
|
||||
- **Download**: Download data from the remote server to local
|
||||
| Action | Description |
|
||||
|--------|-------------|
|
||||
| **Test Connection** | Verify WebDAV URL, username, and password are valid |
|
||||
| **Upload** | Upload local database to remote. Shows progress spinner |
|
||||
| **Download** | Download remote database. Shows remote snapshot info (protocol version, DB version, timestamp, size) before confirming. A safety backup of the local database is created automatically before overwriting |
|
||||
|
||||
> **Note**: Upload will overwrite remote data, and download will overwrite local data. Please confirm before proceeding.
|
||||
#### Auto-Sync
|
||||
|
||||
When **Auto Sync** is enabled:
|
||||
- A confirmation dialog is shown on first activation
|
||||
- CC Switch automatically syncs the database to WebDAV at the configured interval
|
||||
- Sync status is displayed in the panel
|
||||
|
||||
#### Remote Snapshot Info
|
||||
|
||||
Before downloading, CC Switch displays details about the remote snapshot:
|
||||
- Protocol version (v2)
|
||||
- Database compatibility version
|
||||
- Timestamp of the remote backup
|
||||
- File size
|
||||
- Compatibility status (warning if incompatible)
|
||||
|
||||
> **Note**: Upload overwrites remote data, and download overwrites local data. A safety backup is always created before downloading.
|
||||
|
||||
### Log Configuration
|
||||
|
||||
|
||||
@@ -152,6 +152,22 @@ Presets are pre-configured provider templates that only require an API Key to us
|
||||
| AWS Bedrock | AWS Bedrock service |
|
||||
| OpenAI Compatible | OpenAI-compatible interface |
|
||||
|
||||
## Auto-Fetch Models
|
||||
|
||||
When adding or editing a provider, you can auto-fetch available models from the provider's endpoint:
|
||||
|
||||
1. Ensure the **API Key** and **Endpoint URL** are filled in
|
||||
2. Click the **Fetch Models** button (download icon) next to the model input field
|
||||
3. CC Switch calls the provider's `/v1/models` endpoint to retrieve the model list
|
||||
4. Select a model from the dropdown, grouped by vendor
|
||||
|
||||
This feature works for any provider that supports the OpenAI-compatible `/v1/models` API. It is available for Claude, Codex, Gemini, OpenCode, and OpenClaw providers.
|
||||
|
||||
**Common errors:**
|
||||
- **Authentication failed (401/403)**: Check your API Key
|
||||
- **Endpoint not supported (404/405)**: The provider does not expose a `/v1/models` endpoint
|
||||
- **Timeout**: The endpoint is slow to respond; try again later
|
||||
|
||||
## Custom Configuration
|
||||
|
||||
After selecting the "Custom" preset, you need to manually edit the JSON configuration.
|
||||
@@ -316,6 +332,45 @@ Batch import from SQL backup files:
|
||||
|
||||
## Advanced Options
|
||||
|
||||
### API Format (Claude Only)
|
||||
|
||||
When adding a Claude provider that uses a third-party API, you may need to select the correct **API Format** in the Advanced Options section:
|
||||
|
||||
| Format | Description | When to Use |
|
||||
|--------|-------------|-------------|
|
||||
| **Anthropic Messages** | Native Anthropic API format (default) | Direct Anthropic API or compatible proxies |
|
||||
| **OpenAI Chat Completions** | OpenAI Chat API format, auto-converted by proxy | Provider only supports OpenAI Chat format |
|
||||
| **OpenAI Responses API** | OpenAI Responses API format, auto-converted by proxy | Provider only supports OpenAI Responses format |
|
||||
|
||||
> **Note**: API format conversion is handled by the proxy service. When using non-Anthropic formats, the proxy must be running with takeover enabled for correct request/response conversion. See [4.1 Proxy Service](../4-proxy/4.1-service.md) for details.
|
||||
|
||||
The Advanced Options section auto-expands when a non-default API format is configured.
|
||||
|
||||
### Claude Common Config Toggles
|
||||
|
||||
When editing Claude providers, a set of **quick toggles** is available above the JSON editor:
|
||||
|
||||
| Toggle | Effect | Config Change |
|
||||
|--------|--------|---------------|
|
||||
| **Hide Attribution** | Clears commit/PR attribution metadata | Sets `attribution: {commit: "", pr: ""}` |
|
||||
| **Enable Teammates** | Enables the agent teams feature | Sets `env.CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS = "1"` |
|
||||
| **Enable Tool Search** | Enables tool search functionality | Sets `env.ENABLE_TOOL_SEARCH = "true"` |
|
||||
| **High Effort** | Sets effort level to high | Sets `effortLevel = "high"` |
|
||||
| **Disable Auto Upgrade** | Prevents Claude Code auto-updates | Sets `env.DISABLE_AUTOUPDATER = "1"` |
|
||||
|
||||
When a toggle is unchecked, its corresponding config entry is removed entirely. Changes are reflected in the JSON editor in real-time.
|
||||
|
||||
Additionally, the **Write Common Config** checkbox enables merging a global config snippet into the provider. Click **Edit Common Config** to customize the shared snippet.
|
||||
|
||||
### Codex 1M Context Window
|
||||
|
||||
When adding a Codex provider, an **Enable 1M Context Window** toggle is available:
|
||||
|
||||
- **When enabled**: Sets `model_context_window = 1000000` and auto-fills `model_auto_compact_token_limit = 900000` in config.toml
|
||||
- **When disabled**: Removes both fields
|
||||
|
||||
The auto-compact limit can be customized in the text field that appears when the toggle is on.
|
||||
|
||||
### Custom Icon
|
||||
|
||||
Click the icon area to the left of the name to:
|
||||
|
||||
@@ -26,10 +26,12 @@ Quickly switch providers via the system tray without opening the main interface.
|
||||
### Steps
|
||||
|
||||
1. Right-click the CC Switch icon in the system tray
|
||||
2. Find the corresponding app (Claude/Codex/Gemini/OpenCode) in the menu
|
||||
2. Hover over the corresponding app submenu (e.g., "Claude · CurrentProvider")
|
||||
3. Click the provider name you want to switch to
|
||||
4. Switching completes with a brief tray notification
|
||||
|
||||
> Providers are organized into collapsible submenus by app type (Claude/Codex/Gemini). The submenu title shows the currently active provider name.
|
||||
|
||||
### Tray Menu Structure
|
||||
|
||||
|
||||
|
||||
@@ -52,6 +52,20 @@ When editing the currently active provider, a special "backfill" mechanism appli
|
||||
|
||||
This ensures CC Switch and CLI tool configurations stay in sync.
|
||||
|
||||
## Auto-Fetch Models
|
||||
|
||||
When editing a provider, you can auto-fetch the available model list from the provider's endpoint:
|
||||
|
||||
1. Ensure the API Key and endpoint URL are filled in
|
||||
2. Click the **Fetch Models** button (download icon) next to the model input field
|
||||
3. Select a model from the grouped dropdown
|
||||
|
||||
See [2.1 Add Provider — Auto-Fetch Models](./2.1-add.md#auto-fetch-models) for full details.
|
||||
|
||||
## Common Config Toggles (Claude)
|
||||
|
||||
When editing a Claude provider, quick toggle switches are available above the JSON editor for common settings like Tool Search, Disable Auto Upgrade, Teammates, and High Effort. See [2.1 Add Provider — Claude Common Config Toggles](./2.1-add.md#claude-common-config-toggles) for details.
|
||||
|
||||
## Modify API Key
|
||||
|
||||
When editing a provider, you can modify the key directly in the **API Key** input field:
|
||||
|
||||
@@ -118,8 +118,27 @@ Installation copies the skill folder to your local machine:
|
||||
|
||||
### Uninstall Effect
|
||||
|
||||
- Deletes the local skill folder
|
||||
- Updates installation status
|
||||
- **Automatic backup**: Before deletion, the skill is backed up to `~/.cc-switch/skill-backups/`
|
||||
- Removes the skill from all app directories (Claude, Codex, Gemini, OpenCode)
|
||||
- Removes the skill from the SSOT directory (`~/.cc-switch/skills/`)
|
||||
- Deletes the skill record from the database
|
||||
|
||||
### Restore from Backup
|
||||
|
||||
If you need to restore a previously uninstalled skill:
|
||||
|
||||
1. Open the Skills page
|
||||
2. Click the **Restore from Backup** button
|
||||
3. Select the backup you want to restore from the list (shows skill name and backup date)
|
||||
4. The skill is restored and enabled for the current app
|
||||
|
||||
### Delete Backups
|
||||
|
||||
To remove old skill backups:
|
||||
|
||||
1. In the restore dialog, find the backup you want to remove
|
||||
2. Click the **Delete** button next to the backup entry
|
||||
3. Confirm deletion — this cannot be undone
|
||||
|
||||
## Repository Management
|
||||
|
||||
|
||||
@@ -0,0 +1,131 @@
|
||||
# 3.4 Session Manager
|
||||
|
||||
The Session Manager lets you browse, search, and manage conversation sessions from all supported CLI tools in one place.
|
||||
|
||||
## Supported Applications
|
||||
|
||||
| Application | Session Storage Location |
|
||||
|-------------|--------------------------|
|
||||
| Claude Code | `~/.cache/claude/projects/*.jsonl` |
|
||||
| Codex | Codex config sessions directory |
|
||||
| OpenCode | `~/.local/share/opencode/` (JSON or SQLite) |
|
||||
| OpenClaw | `~/.openclaw/agents/<agent>/sessions/*.jsonl` |
|
||||
| Gemini CLI | `~/.cache/gemini/tmp/<project_hash>/chats/` |
|
||||
|
||||
## Opening the Session Manager
|
||||
|
||||
Click the **Sessions** button in the main navigation bar toolbar.
|
||||
|
||||
> **Note**: The Sessions button is visible for all five supported applications.
|
||||
|
||||
## Interface Layout
|
||||
|
||||
The Session Manager uses a **two-column layout**:
|
||||
|
||||
- **Left panel**: Session list with search and filter toolbar
|
||||
- **Right panel**: Selected session details with conversation history
|
||||
|
||||
### Session List (Left Panel)
|
||||
|
||||
Each session entry displays:
|
||||
- Provider icon
|
||||
- Session title
|
||||
- Last active time (relative format, e.g., "5 min ago")
|
||||
|
||||
### Session Details (Right Panel)
|
||||
|
||||
When a session is selected, the right panel shows:
|
||||
- **Title**: Derived from session title, project directory name, or session ID
|
||||
- **Last active date/time**: Full timestamp
|
||||
- **Project directory**: Clickable to copy full path (shows basename with tooltip for full path)
|
||||
- **Resume command**: Displayed in monospace style when available
|
||||
- **Conversation history**: Full message transcript
|
||||
|
||||
## Search & Filtering
|
||||
|
||||
### Full-Text Search
|
||||
|
||||
Use the search box at the top of the left panel to search across:
|
||||
- Session ID
|
||||
- Title
|
||||
- Summary
|
||||
- Project directory
|
||||
- Source file path
|
||||
|
||||
The search supports prefix matching and filters results in real-time. Press **Esc** to clear the search.
|
||||
|
||||
### Provider Filtering
|
||||
|
||||
Click the provider filter dropdown (top-right of left panel) to filter by application:
|
||||
- **All** — Show sessions from all providers
|
||||
- **Claude Code**
|
||||
- **Codex**
|
||||
- **OpenCode**
|
||||
- **OpenClaw**
|
||||
- **Gemini CLI**
|
||||
|
||||
The filter can be combined with search.
|
||||
|
||||
### Refresh
|
||||
|
||||
Click the refresh button (circular arrow icon) to re-scan all provider directories for new or deleted sessions.
|
||||
|
||||
## Session Actions
|
||||
|
||||
### Resume Session
|
||||
|
||||
Click the **Resume** button (play icon) on a selected session to continue the conversation.
|
||||
|
||||
**On macOS:**
|
||||
- CC Switch launches your preferred terminal with the resume command
|
||||
- The terminal opens in the session's project directory
|
||||
- If terminal launch fails, the command is copied to your clipboard instead
|
||||
|
||||
**Supported terminals (macOS):** Terminal.app, iTerm2, Ghostty, Kitty, WezTerm, Alacritty
|
||||
|
||||
**On other platforms:**
|
||||
- The resume command is copied to your clipboard
|
||||
- Paste it into your terminal to resume
|
||||
|
||||
> The Resume button is disabled if the session has no resume command available.
|
||||
|
||||
### Delete Session
|
||||
|
||||
Click the **Delete** button (trash icon) to permanently remove a session file. A confirmation dialog is shown before deletion.
|
||||
|
||||
> Sessions without a local source path (e.g., immutable sessions) cannot be deleted.
|
||||
|
||||
### Batch Operations
|
||||
|
||||
For managing multiple sessions at once:
|
||||
|
||||
1. Click the **Batch Mode** button (checkbox icon) in the left panel toolbar
|
||||
2. Select sessions using the checkboxes that appear
|
||||
3. Use **Select All** to select all filtered results, or **Clear** to deselect
|
||||
4. Click **Batch Delete** (red trash icon) to delete all selected sessions
|
||||
|
||||
A confirmation dialog shows the count before deletion. Results report the number of successful deletions and any failures.
|
||||
|
||||
## Conversation History
|
||||
|
||||
### Message Display
|
||||
|
||||
Messages are color-coded by role:
|
||||
- **User** messages: Green, left-aligned
|
||||
- **AI** (Assistant) messages: Blue, right-aligned
|
||||
- **System** messages: Amber
|
||||
- **Tool** messages: Purple
|
||||
|
||||
### Table of Contents
|
||||
|
||||
For longer conversations, a Table of Contents is available:
|
||||
- **Desktop (XL+ screens)**: Sidebar on the right showing user message previews
|
||||
- **Smaller screens**: Floating button (list icon) at bottom-right that opens a dialog
|
||||
|
||||
Click any entry to scroll to that message, which is briefly highlighted.
|
||||
|
||||
## Tips
|
||||
|
||||
- Sessions are sorted by last activity time (newest first)
|
||||
- The session count badge updates as you search and filter
|
||||
- OpenCode sessions may come from both JSON files and SQLite database — duplicates are automatically deduplicated
|
||||
@@ -0,0 +1,85 @@
|
||||
# 3.5 Workspace Files & Daily Memory
|
||||
|
||||
## Overview
|
||||
|
||||
The Workspace panel provides file management and daily memory features for **OpenClaw**. It allows you to edit workspace configuration files and maintain a daily memory journal.
|
||||
|
||||
> This feature is specific to OpenClaw. The Workspace button appears in the navigation bar when OpenClaw is the selected application.
|
||||
|
||||
## Workspace Files
|
||||
|
||||
### File Location
|
||||
|
||||
All workspace files are stored in `~/.openclaw/workspace/`.
|
||||
|
||||
Click the directory path at the top of the panel to open it in your file manager.
|
||||
|
||||
### Available Files
|
||||
|
||||
CC Switch manages 9 workspace files, each serving a specific purpose:
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| **AGENTS.md** | Agents definition and configuration |
|
||||
| **SOUL.md** | System soul/personality settings |
|
||||
| **USER.md** | User profile information |
|
||||
| **IDENTITY.md** | Identity and role definition |
|
||||
| **TOOLS.md** | Available tools configuration |
|
||||
| **MEMORY.md** | System memory |
|
||||
| **HEARTBEAT.md** | Heartbeat configuration |
|
||||
| **BOOTSTRAP.md** | Bootstrap sequence |
|
||||
| **BOOT.md** | Boot configuration |
|
||||
|
||||
### File Status
|
||||
|
||||
Each file shows a status indicator:
|
||||
- **Green checkmark**: File exists on disk
|
||||
- **Empty circle**: File does not exist yet (will be created on first save)
|
||||
|
||||
### Editing Files
|
||||
|
||||
1. Click any file card to open the Markdown editor
|
||||
2. Edit the content
|
||||
3. Click **Save** to write changes to disk
|
||||
|
||||
If the file doesn't exist yet, it will be created on first save.
|
||||
|
||||
## Daily Memory
|
||||
|
||||
The Daily Memory feature provides a date-organized journal system stored in `~/.openclaw/workspace/memory/`.
|
||||
|
||||
### Accessing Daily Memory
|
||||
|
||||
Click the **Daily Memory** card in the Workspace Files grid to open the memory panel.
|
||||
|
||||
### File List
|
||||
|
||||
The panel displays all daily memory files sorted by date (newest first). Each entry shows:
|
||||
- **Date** (formatted from filename, e.g., `2026-04-01.md`)
|
||||
- **File size**
|
||||
- **Preview** (first 2 lines of content)
|
||||
|
||||
### Create Today's Note
|
||||
|
||||
Click the **Create Today** button to:
|
||||
- Open a new note with today's date (`YYYY-MM-DD.md`)
|
||||
- If today's note already exists, it opens for editing
|
||||
- The file is persisted only after you click Save
|
||||
|
||||
### Search
|
||||
|
||||
Search across all daily memory files:
|
||||
|
||||
1. Press **Cmd/Ctrl+F** or click the search icon
|
||||
2. Enter your search term
|
||||
3. Results show matching files with:
|
||||
- Match count per file
|
||||
- Snippet preview from the matching line
|
||||
- File date and size
|
||||
|
||||
Press **Esc** to close the search.
|
||||
|
||||
### Edit & Delete
|
||||
|
||||
- **Edit**: Click a file entry to open it in the Markdown editor
|
||||
- **Delete**: Hover over a file entry and click the delete icon. A confirmation dialog is shown — deletion cannot be undone.
|
||||
@@ -150,6 +150,20 @@ base_url = "http://127.0.0.1:15721/v1"
|
||||
GOOGLE_GEMINI_BASE_URL=http://127.0.0.1:15721
|
||||
```
|
||||
|
||||
## API Format Conversion
|
||||
|
||||
The proxy supports automatic API format conversion for providers configured with non-Anthropic formats. This allows you to use providers that only support OpenAI-compatible APIs with Claude Code.
|
||||
|
||||
| Provider API Format | Proxy Behavior |
|
||||
|---------------------|----------------|
|
||||
| **Anthropic Messages** | Pass-through (no conversion) |
|
||||
| **OpenAI Chat Completions** | Converts Anthropic requests to OpenAI Chat format and responses back |
|
||||
| **OpenAI Responses API** | Converts Anthropic requests to OpenAI Responses format and responses back |
|
||||
|
||||
The API format is configured per-provider in the [Advanced Options](../2-providers/2.1-add.md#api-format-claude-only) when adding or editing a Claude provider.
|
||||
|
||||
> **Note**: Format conversion requires the proxy to be running with app takeover enabled. The conversion handles both streaming and non-streaming requests.
|
||||
|
||||
## Stop the Proxy
|
||||
|
||||
### Option 1: Main Interface Toggle
|
||||
|
||||
@@ -12,12 +12,11 @@ Customizable location in settings (for cloud sync).
|
||||
|
||||
```
|
||||
~/.cc-switch/
|
||||
├── cc-switch.db # SQLite database
|
||||
├── cc-switch.db # SQLite database (SSOT)
|
||||
├── settings.json # Device-level settings
|
||||
└── backups/ # Automatic backups
|
||||
├── backup-20251230-120000.json
|
||||
├── backup-20251229-180000.json
|
||||
└── ...
|
||||
├── skills/ # Skill SSOT directory
|
||||
├── skill-backups/ # Skill backups (created on uninstall)
|
||||
└── db_backup_*.db # Database backups
|
||||
```
|
||||
|
||||
### Database Contents
|
||||
|
||||
@@ -183,6 +183,16 @@ chmod +x CC-Switch-*.AppImage
|
||||
2. Manually download and install the latest version
|
||||
3. If using Homebrew: `brew upgrade --cask cc-switch`
|
||||
|
||||
## Lightweight Mode
|
||||
|
||||
### How to Enter Lightweight Mode?
|
||||
|
||||
Toggle "Lightweight Mode" from the system tray menu. The main window closes, and CC Switch runs as a tray-only app. Toggle again or click "Open main window" to exit.
|
||||
|
||||
### App Uses Less Memory in Lightweight Mode?
|
||||
|
||||
Yes. Lightweight Mode destroys the main window and its web view, reducing memory usage significantly while keeping tray menu functionality available.
|
||||
|
||||
## Getting Help
|
||||
|
||||
### Submit an Issue
|
||||
|
||||
@@ -24,7 +24,9 @@ CC Switch User Manual
|
||||
├── 3. Extensions
|
||||
│ ├── 3.1 MCP Server Management
|
||||
│ ├── 3.2 Prompts Management
|
||||
│ └── 3.3 Skills Management
|
||||
│ ├── 3.3 Skills Management
|
||||
│ ├── 3.4 Session Manager
|
||||
│ └── 3.5 Workspace & Memory
|
||||
│
|
||||
├── 4. Proxy & High Availability
|
||||
│ ├── 4.1 Proxy Service
|
||||
@@ -69,6 +71,8 @@ CC Switch User Manual
|
||||
| [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
|
||||
|
||||
@@ -99,9 +103,9 @@ CC Switch User Manual
|
||||
|
||||
## Version Information
|
||||
|
||||
- Documentation version: v3.12.0
|
||||
- Last updated: 2026-03-09
|
||||
- Applicable to CC Switch v3.12.0+
|
||||
- Documentation version: v3.12.3
|
||||
- Last updated: 2026-04-04
|
||||
- Applicable to CC Switch v3.12.3+
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user