@jsonstudio/rcc 0.89.1959 → 0.89.1968

package/README.md

@@ -65,37 +65,208 @@ npm uninstall -g @jsonstudio/rcc
 
 ## 使用
 
-### 1) 初始化配置并启动
+### 1) 初始化（推荐用 `rcc`）
+
+默认配置路径：
+- macOS / Linux：`~/.routecodex/config.json`
+- Windows：`%USERPROFILE%\\.routecodex\\config.json`
+
+默认初始化（会把内置脱敏 quickstart 配置复制到目标路径）：
+
+```bash
+rcc init
+```
+
+按 provider 模板直接生成 v2（覆盖默认复制流程）：
 
 ```bash
-routecodex init
-routecodex start
+rcc init --providers deepseek-web,tab,qwen --default-provider deepseek-web --camoufox --force
 ```
 
-或使用 release CLI：
+说明：
+- `--providers` 使用 init 内置 provider id（见下文鉴权表）。
+- `--camoufox` 会显式触发 Camoufox 环境准备（即使当前 provider 不强依赖）。
+- `--force` 会先备份旧配置到 `config.json.bak*` 再重写。
+
+如果你使用 dev CLI，把 `rcc` 替换成 `routecodex` 即可。
+
+#### 1.1 推荐顺序（先 `--camoufox`，再 provider 化）
+
+推荐按这 3 步执行：
+
+1. 先跑 `rcc init --camoufox`
+2. 再用 `rcc init --config ... --force` 把默认/v1 配置转换为 provider 分文件（v2）
+3. 最后配置 key/token 并启动
+
+示例：
+
+```bash
+# Step 1: 先做 camoufox 环境检查/准备
+rcc init --camoufox
+
+# Step 2: rcc init 已自动写入默认 quickstart；这里执行 v1 -> v2 转换
+rcc init --config ~/.routecodex/config.json --force
+
+# Step 3: 配置密钥与 token 后启动
+rcc init --list-current-providers
+rcc start --config ~/.routecodex/config.json
+```
+
+Step 2 完成后，provider 会拆分到：
+- `~/.routecodex/provider/<providerId>/config.v2.json`
+
+Step 3（配置密钥/token）的最小动作：
+- API Key 类：设置环境变量（如 `OPENAI_API_KEY` / `TAB_API_KEY` / `GLM_API_KEY`）
+- OAuth 类：执行 `rcc oauth qwen-auto qwen`、`rcc oauth gemini-auto gemini-cli`、`rcc oauth antigravity-auto antigravity`
+- DeepSeek：在 `~/.routecodex/auth/deepseek-account-1.json` 写入 `mobile/password`，启动后自动回填 `access_token`
+
+Windows PowerShell 对应写法：
+
+```powershell
+rcc init --camoufox
+rcc init --config "$env:USERPROFILE\.routecodex\config.json" --force
+rcc init --list-current-providers
+rcc start --config "$env:USERPROFILE\.routecodex\config.json"
+```
+
+### 2) Camoufox 初始化（macOS / Windows）
+
+`rcc init --camoufox` 会自动检查/安装 Camoufox。你也可以先手工准备：
+
+macOS:
+
+```bash
+python3 -m pip install --user -U camoufox
+python3 -m camoufox path
+```
+
+Windows (PowerShell):
+
+```powershell
+py -3 -m pip install --user -U camoufox
+py -3 -m camoufox path
+```
+
+可选环境变量（当 Python 不在默认命令路径时）：
+- `ROUTECODEX_PYTHON` / `RCC_PYTHON`：指定 Python 可执行文件路径
+- `ROUTECODEX_CAMOUFOX_AUTO_INSTALL=0`：关闭自动安装（默认开启）
+
+验证 Camoufox profile + 指纹是否可打开：
+
+```bash
+rcc camoufox antigravity-oauth-1-alias1.json
+```
+
+### 3) macOS / Windows 环境变量写法
+
+macOS/Linux (zsh/bash):
+
+```bash
+export OPENAI_API_KEY="your_openai_key"
+export TAB_API_KEY="your_tab_key"
+export GLM_API_KEY="your_glm_key"
+```
+
+Windows PowerShell（当前会话）：
+
+```powershell
+$env:OPENAI_API_KEY="your_openai_key"
+$env:TAB_API_KEY="your_tab_key"
+$env:GLM_API_KEY="your_glm_key"
+```
+
+Windows PowerShell（持久化）：
+
+```powershell
+setx OPENAI_API_KEY "your_openai_key"
+setx TAB_API_KEY "your_tab_key"
+setx GLM_API_KEY "your_glm_key"
+```
+
+API key 类 provider 的常用环境变量（按 init 模板）：
+- `OPENAI_API_KEY`
+- `TAB_API_KEY`
+- `GLM_API_KEY`
+- `KIMI_API_KEY`
+- `MODELSCOPE_API_KEY`
+- `MIMO_API_KEY`
+
+### 4) 按 init 内置 provider 配置鉴权
+
+下表对应 `rcc init --list-providers` 的内置模板：
+
+| Provider ID | 默认 auth 类型 | 你需要做什么 |
+|------|------|------|
+| `openai` | `apikey` | 设置 `OPENAI_API_KEY` |
+| `tab` | `apikey` (responses) | 设置 `TAB_API_KEY` |
+| `deepseek-web` | `deepseek-account` (`tokenFile` entries) | 准备 `~/.routecodex/auth/deepseek-account-*.json` |
+| `glm` | `apikey` | 设置 `GLM_API_KEY` |
+| `glm-anthropic` | `apikey` (`/v1/messages`) | 设置 `GLM_API_KEY` |
+| `kimi` | `apikey` | 设置 `KIMI_API_KEY` |
+| `modelscope` | `apikey` | 设置 `MODELSCOPE_API_KEY` |
+| `lmstudio` | `apikey` (本地) | 通常可留空或填本地网关 key |
+| `qwen` | `qwen-oauth` (`tokenFile=default`) | 先跑 OAuth 生成 token |
+| `iflow` | `iflow-cookie` | 准备 `~/.routecodex/auth/iflow-work.cookie` |
+| `mimo` | `apikey` | 设置 `MIMO_API_KEY` |
+| `gemini-cli` | `gemini-cli-oauth` (`entries[].tokenFile`) | 先跑 OAuth 生成 token |
+| `antigravity` | `antigravity-oauth` (`entries[].tokenFile`) | 先跑 OAuth 生成 token |
+
+OAuth 认证命令（常用）：
+
+```bash
+rcc oauth qwen-auto qwen
+rcc oauth gemini-auto gemini-cli
+rcc oauth antigravity-auto antigravity
+```
+
+DeepSeek 单文件凭据 + token（同一文件）示例：
+
+```json
+{
+  "mobile": "13800000000",
+  "password": "your_password",
+  "access_token": ""
+}
+```
+
+放在 `~/.routecodex/auth/deepseek-account-1.json` 后，启动时会自动登录并回填 `access_token`。
+
+### 5) 脱敏快速配置（来自当前线上配置）
+
+已提供脱敏模板：
+- `configsamples/config.v1.quickstart.sanitized.json`
+
+快速使用：
 
 ```bash
 rcc init
-rcc start
+rcc start --config ~/.routecodex/config.json
 ```
 
-默认配置路径：
-- macOS / Linux：`~/.routecodex/config.json`
-- Windows：`%USERPROFILE%\\.routecodex\\config.json`
+此模板已经脱敏（API key、token、账号别名），保留了可直接复用的路由结构和 provider 组合。
 
-`routecodex init` / `rcc init` 会在 `~/.routecodex/` 生成默认 `config.json`，并把常用文档复制到 `~/.routecodex/docs`。
+#### 5.1) 用 `rcc init` 把本地 v1 配置转换为 v2
 
-如果配置文件已存在，需要重新生成模板：
+如果你要把 `configsamples/config.v1.quickstart.sanitized.json` 本地化成 v2（provider 分文件 + `virtualrouterMode: v2`），推荐直接用：
 
 ```bash
-routecodex init --force
-# 或
-rcc init --force
+rcc init
+rcc init --config ~/.routecodex/config.json --force
 ```
 
-它会先备份旧配置为 `config.json.bak`（或 `config.json.bak.N`），再生成新模板。
+说明：
+- `rcc init` 会检测到这是 v1 配置并执行迁移。
+- `--force` 会跳过交互确认，适合脚本化/CI。
+- 迁移后会生成 `~/.routecodex/provider/<providerId>/config.v2.json`，并备份原始 v1 文件为 `config.json.bak*`。
+
+可选检查：
+
+```bash
+rcc init --list-current-providers
+rcc start --config ~/.routecodex/config.json
+```
 
-### 2) 调用 API（示例）
+### 6) 调用 API（示例）
 
 健康检查：
 
@@ -173,6 +344,7 @@ curl http://127.0.0.1:5555/v1/messages \
 ## 参考配置
 
 - `configsamples/config.reference.json`
+- `configsamples/config.v1.quickstart.sanitized.json`
 - `configsamples/provider/*/config.v1.json`
 
 ## 相关链接