Skip to content

Commit 1320880

Browse files
author
Yongmao Luo
committed
docs(readme): add remote management usage guide
1 parent d80a73a commit 1320880

3 files changed

Lines changed: 57 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ Modern AI-powered coding relies on CLI tools like Claude Code, Codex, Gemini CLI
179179

180180
### System & Platform
181181

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

263264
> **Note**: On first launch, you can manually import existing CLI tool configs as the default provider.
264265
266+
### Remote Management
267+
268+
Control CC Switch from any browser on your network.
269+
270+
1. **Enable**: Settings → Remote Management → toggle **Enabled**
271+
2. **Access**: Open `http://localhost:4000` in any browser (default port; changeable in settings)
272+
3. **Tailscale**: Optionally enable Tailscale to access from outside your local network
273+
274+
**API Endpoints** (`http://localhost:4000/api/`)
275+
276+
| Method | Endpoint | Description |
277+
|--------|----------|-------------|
278+
| GET | `/health` | Server status |
279+
| GET | `/providers` | List all providers |
280+
| GET | `/current` | Current active provider |
281+
| POST | `/switch` | Switch provider (body: `{ provider_id }`) |
282+
| GET | `/events` | SSE stream for real-time updates |
283+
265284
## Download & Installation
266285

267286
### System Requirements

README_JA.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ CC Switch ユーザー限定特典: 専用リンクからご<a href="https://d
182182

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

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

266267
> **補足**: 初回起動時に、既存の CLI ツール設定を手動でインポートしてデフォルトプロバイダとして使用できます。
267268
269+
### リモート管理
270+
271+
同一ネットワーク内の任意のブラウザから CC Switch を制御できます。
272+
273+
1. **有効化**: 設定 → リモート管理 → **有効** をオン
274+
2. **アクセス**: ブラウザで `http://localhost:4000` を開く(デフォルトポート。設定で変更可能)
275+
3. **Tailscale**: 必要に応じて Tailscale を有効化し、外部ネットワークからのアクセスを可能にする
276+
277+
**API エンドポイント** (`http://localhost:4000/api/`)
278+
279+
| メソッド | エンドポイント | 説明 |
280+
|----------|---------------|------|
281+
| GET | `/health` | サーバー状態 |
282+
| GET | `/providers` | プロバイダ一覧を取得 |
283+
| GET | `/current` | 現在アクティブなプロバイダを取得 |
284+
| POST | `/switch` | プロバイダを切り替え(リクエストボディ:`{ provider_id }`|
285+
| GET | `/events` | SSE リアルタイム更新ストリーム |
286+
268287
## ダウンロード & インストール
269288

270289
### システム要件

README_ZH.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ Claude Code / Codex / Gemini 官方渠道低至 3.8 / 0.2 / 0.9 折,充值更
179179

180180
### 系统与平台
181181

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

265266
> **注意**:首次启动可以手动导入现有 CLI 工具配置作为默认供应商。
266267
268+
### 远程管理
269+
270+
从局域网内任何浏览器控制 CC Switch。
271+
272+
1. **启用**:设置 → 远程管理 → 打开**启用**开关
273+
2. **访问**:在浏览器中打开 `http://localhost:4000`(默认端口,可在设置中修改)
274+
3. **Tailscale**:可选开启 Tailscale,实现外网访问
275+
276+
**API 接口** (`http://localhost:4000/api/`)
277+
278+
| 方法 | 接口 | 说明 |
279+
|------|------|------|
280+
| GET | `/health` | 服务器状态 |
281+
| GET | `/providers` | 获取所有供应商列表 |
282+
| GET | `/current` | 获取当前激活的供应商 |
283+
| POST | `/switch` | 切换供应商(请求体:`{ provider_id }`|
284+
| GET | `/events` | SSE 实时更新流 |
285+
267286
## 下载安装
268287

269288
### 系统要求

0 commit comments

Comments
 (0)