Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ Modern AI-powered coding relies on CLI tools like Claude Code, Codex, Gemini CLI

### System & Platform

- **Remote Management** — Built-in HTTP server with Web UI and REST API for switching providers from any device on your network
- **Cloud sync** — Custom config directory (Dropbox, OneDrive, iCloud, NAS) and WebDAV server sync
- **Deep Link** (`ccswitch://`) — Import providers, MCP servers, prompts, and skills via URL
- Dark / Light / System theme, auto-launch, auto-updater, atomic writes, auto-backups, i18n (zh/en/ja)
Expand Down Expand Up @@ -262,6 +263,24 @@ For detailed guides on every feature, check out the **[User Manual](docs/user-ma

> **Note**: On first launch, you can manually import existing CLI tool configs as the default provider.

### Remote Management

Control CC Switch from any browser on your network.

1. **Enable**: Settings → Remote Management → toggle **Enabled**
2. **Access**: Open `http://localhost:4000` in any browser (default port; changeable in settings)
3. **Tailscale**: Optionally enable Tailscale to access from outside your local network

**API Endpoints** (`http://localhost:4000/api/`)

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/health` | Server status |
| GET | `/providers` | List all providers |
| GET | `/current` | Current active provider |
| POST | `/switch` | Switch provider (body: `{ provider_id }`) |
| GET | `/events` | SSE stream for real-time updates |

## Download & Installation

### System Requirements
Expand Down
19 changes: 19 additions & 0 deletions README_JA.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ CC Switch ユーザー限定特典: 専用リンクからご<a href="https://d

### システム & プラットフォーム

- **リモート管理** -- 内蔵 HTTP サーバー。Web UI と REST API を提供し、同一ネットワーク内の任意のデバイスからプロバイダを切り替え可能
- **クラウド同期** -- カスタム設定ディレクトリ(Dropbox、OneDrive、iCloud、NAS)および WebDAV サーバー同期
- **Deep Link** (`ccswitch://`) -- URL 経由でプロバイダ、MCP サーバー、Prompts、Skills をワンクリックインポート
- ダーク / ライト / システムテーマ、自動起動、自動アップデーター、アトミック書き込み、自動バックアップ、多言語対応(中/英/日)
Expand Down Expand Up @@ -265,6 +266,24 @@ CC Switch は「最小限の介入」という設計原則に従っています

> **補足**: 初回起動時に、既存の CLI ツール設定を手動でインポートしてデフォルトプロバイダとして使用できます。

### リモート管理

同一ネットワーク内の任意のブラウザから CC Switch を制御できます。

1. **有効化**: 設定 → リモート管理 → **有効** をオン
2. **アクセス**: ブラウザで `http://localhost:4000` を開く(デフォルトポート。設定で変更可能)
3. **Tailscale**: 必要に応じて Tailscale を有効化し、外部ネットワークからのアクセスを可能にする

**API エンドポイント** (`http://localhost:4000/api/`)

| メソッド | エンドポイント | 説明 |
|----------|---------------|------|
| GET | `/health` | サーバー状態 |
| GET | `/providers` | プロバイダ一覧を取得 |
| GET | `/current` | 現在アクティブなプロバイダを取得 |
| POST | `/switch` | プロバイダを切り替え(リクエストボディ:`{ provider_id }`)|
| GET | `/events` | SSE リアルタイム更新ストリーム |

## ダウンロード & インストール

### システム要件
Expand Down
19 changes: 19 additions & 0 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ Claude Code / Codex / Gemini 官方渠道低至 3.8 / 0.2 / 0.9 折,充值更

### 系统与平台

- **远程管理** — 内置 HTTP 服务器,提供 Web UI 和 REST API,可在局域网内任何设备上切换供应商
- **云同步** — 自定义配置目录(Dropbox、OneDrive、iCloud、坚果云、NAS)及 WebDAV 服务器同步
- **Deep Link** (`ccswitch://`) — 通过 URL 一键导入供应商、MCP 服务器、提示词和技能
- 深色 / 浅色 / 跟随系统主题、开机自启、自动更新、原子写入、自动备份、国际化(中/英/日)
Expand Down Expand Up @@ -264,6 +265,24 @@ CC Switch macOS 版本已通过 Apple 代码签名和公证,可直接下载安

> **注意**:首次启动可以手动导入现有 CLI 工具配置作为默认供应商。

### 远程管理

从局域网内任何浏览器控制 CC Switch。

1. **启用**:设置 → 远程管理 → 打开**启用**开关
2. **访问**:在浏览器中打开 `http://localhost:4000`(默认端口,可在设置中修改)
3. **Tailscale**:可选开启 Tailscale,实现外网访问

**API 接口** (`http://localhost:4000/api/`)

| 方法 | 接口 | 说明 |
|------|------|------|
| GET | `/health` | 服务器状态 |
| GET | `/providers` | 获取所有供应商列表 |
| GET | `/current` | 获取当前激活的供应商 |
| POST | `/switch` | 切换供应商(请求体:`{ provider_id }`)|
| GET | `/events` | SSE 实时更新流 |

## 下载安装

### 系统要求
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"msw": "^2.11.6",
"postcss": "^8.4.49",
"prettier": "^3.6.2",
"puppeteer": "^24.42.0",
"tailwindcss": "^3.4.17",
"typescript": "^5.3.0",
"vite": "^7.3.0",
Expand Down
Loading