@jsonstudio/rcc 0.89.1205 → 0.89.1457

package/docs/INSTALLATION_AND_QUICKSTART.md

@@ -0,0 +1,74 @@
+# 安装与快速上手（rcc / routecodex）
+
+## 1) npm 安装（Release，推荐）
+
+```bash
+npm install -g @jsonstudio/rcc
+rcc --version
+```
+
+升级/卸载：
+
+```bash
+npm update -g @jsonstudio/rcc
+npm uninstall -g @jsonstudio/rcc
+```
+
+## 2) 初始化配置（自动生成）
+
+默认会写入：`~/.routecodex/config.json`
+
+交互式（推荐）：
+
+```bash
+rcc init
+```
+
+初始化成功后，`rcc init` 会把内置文档复制到：`~/.routecodex/docs`
+
+非交互式（CI/脚本）：
+
+```bash
+rcc init --providers openai,tab --default-provider tab
+```
+
+查看内置 provider 列表：
+
+```bash
+rcc init --list-providers
+```
+
+生成后你需要把 `apiKey` / `tokenFile` / `cookieFile` 按需补齐（脱敏模板会用 `YOUR_API_KEY_HERE` 占位）。
+
+参考配置：
+- `configsamples/config.reference.json`
+- `configsamples/provider/*/config.v1.json`
+
+## 3) 启动服务器
+
+```bash
+rcc start
+```
+
+自定义配置路径：
+
+```bash
+rcc start --config ./config.json
+```
+
+## 4) 验证服务可用
+
+```bash
+curl http://127.0.0.1:5555/health
+curl http://127.0.0.1:5555/ready
+```
+
+## 5) Dev Worktree（本仓库）构建与全局安装
+
+```bash
+npm --prefix sharedmodule/llmswitch-core run build
+npm run build:dev
+npm run install:global
+```
+
+> 注意：`routecodex` 仅用于本地/调试，严禁发布到 npm；release 只能用 `@jsonstudio/rcc`。

package/docs/INSTRUCTION_MARKUP.md

@@ -0,0 +1,89 @@
+# `<** ... **>` 指令语法说明
+
+RouteCodex 支持在用户消息中写入“指令标记”，用于影响 Virtual Router / servertool 行为。
+
+## 基本格式
+
+- 指令块：`<** ... **>`
+- 可以在一条 user 消息中写多个指令块
+- `stopMessage` / `clock:clear` 只允许从“最新一条 user 消息”生效（避免重放历史导致重复设置）
+
+## 1) clear（清空路由状态）
+
+清除本会话的 sticky/黑名单/allowlist 等状态：
+
+```text
+<**clear**>
+```
+
+## 2) stopMessage（停止提示消息）
+
+设置 stopMessage（默认最多触发 1 次）：
+
+```text
+<**stopMessage:继续**>
+```
+
+设置 stopMessage + 次数：
+
+```text
+<**stopMessage:"继续",3**>
+```
+
+清除 stopMessage：
+
+```text
+<**stopMessage:clear**>
+```
+
+### stopMessage 文件引用（file://）
+
+支持从 `~/.routecodex` 下读取相对路径文件内容作为 stopMessage：
+
+```text
+<**stopMessage:<file://stopMessage/message1.md>**>
+```
+
+含义：读取 `~/.routecodex/stopMessage/message1.md` 的内容，并把文件内容作为 stopMessage 文本（会按 mtime/size 做缓存）。
+
+## 3) clock（定时任务）
+
+清除当前 session 的所有定时任务：
+
+```text
+<**clock:clear**>
+```
+
+> clock servertool 的详细行为与持久化说明见 `docs/SERVERTOOL_CLOCK_DESIGN.md`。
+
+## 4) provider 路由指令
+
+### 允许列表（whitelist）
+
+只允许命中指定 provider（逗号分隔）：
+
+```text
+<**!glm,tab**>
+```
+
+`<**glm**>` 等价于 `<**!glm**>`（只写 providerId 时按 allowlist 处理）。
+
+### disable / enable（临时下线/上线）
+
+```text
+<**#tab**>      # disable
+<**@tab**>      # enable
+```
+
+### force（强制命中 provider.model）
+
+```text
+<**tab.gpt-5.2**>
+```
+
+### prefer（优先命中 provider.model；不可用则回退到正常路由）
+
+```text
+<**!tab.gpt-5.2**>
+```
+