@tunnelbox/claude-code 0.1.1 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/README.md +97 -80
  2. package/README.zh-CN.md +137 -0
  3. package/dist/index.mjs +1645 -242
  4. package/official-plugin/.claude-plugin/plugin.json +10 -10
  5. package/official-plugin/bin/tunnelbox +4 -4
  6. package/official-plugin/bin/tunnelbox.cmd +3 -3
  7. package/official-plugin/bin/tunnelbox.mjs +332 -274
  8. package/official-plugin/hooks/hooks.json +26 -16
  9. package/official-plugin/skills/pair/SKILL.md +12 -12
  10. package/official-plugin/skills/status/SKILL.md +10 -0
  11. package/package.json +43 -38
  12. package/official-plugin/commands/pair.md +0 -10
  13. package/official-plugin/commands/status.md +0 -9
package/README.md CHANGED
@@ -1,120 +1,137 @@
1
1
  # @tunnelbox/claude-code
2
2
 
3
- tunnelbox 的 **Claude Code 适配器**（B 类，独立进程）：手机远程驱动电脑上的 Claude Code（会话/流式/工具审批/中止/删除），复用 `@tunnelbox/core`（RelayClient/状态/二维码）。
3
+ [English](README.md) · [简体中文](README.zh-CN.md)
4
+
5
+ **Official website:** [www.tunnelbox.top](https://www.tunnelbox.top)
6
+
7
+ **tunnelbox Claude Code adapter (standalone daemon):** drive Claude Code on your computer from your phone — sessions, streaming, tool approval, abort, delete. It runs as a background Node process that dials **out** to a relay only (no public IP, no port forwarding).
4
8
 
5
9
  ```
6
- 手机 PWA ──WSS──► relay ──WSS──► 本适配器（电脑上常驻 Node 进程）
10
+ Phone app ──WSS──► relay ──WSS──► tunnelbox-claude-code (this adapter)
7
11
  └─ @anthropic-ai/claude-agent-sdk query()
8
- └─ 拉起本机 claude CLI 子进程
12
+ └─ spawns your local claude CLI
9
13
  ```
10
14
 
11
- ## 前置条件
15
+ ## Quick start (install → run → pair → use)
16
+
17
+ Follow these steps once on a computer that has Claude Code installed and signed in.
12
18
 
13
- - Node.js ≥ 22（`RelayClient` 依赖全局 `WebSocket`）；
14
- - 本机已安装并登录 **Claude Code CLI**（`claude --version` 可用、`~/.claude/.credentials.json` 存在）。SDK 每次 `query()` 会在本机拉起 `claude` 子进程。
19
+ ### Step 0 — Prepare your phone
15
20
 
16
- > 适配器运行在**电脑**上，与 opencode/dsh 一样只向中继发出站 WebSocket；手机端无需安装任何 Claude SDK。
21
+ Install the tunnelbox App (Android & iOS) from the official website: **https://www.tunnelbox.top**
17
22
 
18
- ## 构建与运行
23
+ - Sign in / create an account when prompted.
24
+
25
+ ### Step 1 — Install the adapter on your computer
26
+
27
+ Prerequisites: Node.js ≥ 22, and **Claude Code CLI** installed & signed in (`claude --version`, `~/.claude/.credentials.json` exists). The adapter drives your local `claude` binary — the phone never needs Claude installed.
19
28
 
20
29
  ```bash
21
- cd plugin && npm install # workspaces 根（含 claude-code 及 claude-agent-sdk）
22
- cd claude-code && npm run build # 产出 dist/index.mjs
23
- node dist/index.mjs # 或 npm start
30
+ npm install -g @tunnelbox/claude-code
24
31
  ```
25
32
 
26
- > 首次运行时若 SDK 缺失会提示先 `npm install`。
33
+ ### Step 2 — Run it
34
+
35
+ ```bash
36
+ tunnelbox-claude-code
37
+ ```
38
+
39
+ On first start the adapter connects to the relay and prints a **pairing QR code + pairing code** in the terminal.
40
+
41
+ ### Step 3 — Pair with your phone
42
+
43
+ In the phone app tap **Scan to pair** and scan the terminal QR code (or type the pairing code manually). The code is single-use and valid for about 10 minutes.
27
44
 
28
- ## 配置
45
+ - Once bound, the adapter prints "connected account — open the app and pick this computer" on later starts and does not refresh the code.
46
+ - Want a fresh code any time? Run `tunnelbox-claude-code --pair`.
29
47
 
30
- | 配置 | 默认 | 说明 |
48
+ ### Step 4 — Use it from your phone
49
+
50
+ In the app, open this computer and you can start new sessions, send messages, watch streaming output (text + thinking), approve risky tool calls, answer Claude's structured questions, and abort a running session.
51
+
52
+ ## Configuration
53
+
54
+ | Env var | Default | Description |
31
55
  |---|---|---|
32
- | `TUNNELBOX_RELAY_URL` | state 里保存的地址（`~/.config/opencode/remote-state.claude-code.json`） | 中继地址（如 `wss://chat.example.com`） |
33
- | `TUNNELBOX_CWD` | `process.cwd()` | 默认工作区；也可在手机上通过工作区列表切换 |
34
- | `TUNNELBOX_CLAUDE_MODE` | `default` | 每回合 `permissionMode`：`default/plan/acceptEdits/bypassPermissions/dontAsk/auto`。`bypassPermissions` 全放行且能力位 `permission=false`（危险，慎用） |
35
- | `TUNNELBOX_CLAUDE_MODEL` | claude 默认 | 模型覆盖（`options.model`） |
36
- | `TUNNELBOX_CLAUDE_THINKING` | claude 默认 | `off \| adaptive \| enabled[:budget]` → `options.thinking` / `maxThinkingTokens` |
37
- | `TUNNELBOX_CLAUDE_MAX_THINKING_TOKENS` | - | 思考 token 上限 |
38
- | `TUNNELBOX_CLAUDE_ENV_*` | - | 透传给 claude 子进程的环境变量（前缀去掉，如 `TUNNELBOX_CLAUDE_ENV_ANTHROPIC_BASE_URL=…` → `options.env`） |
39
- | `TUNNELBOX_CLAUDE_DIALOG_KINDS` | 空 | `request_user_dialog` kind 白名单（逗号分隔，实验性，需实测后填真实 kind） |
40
- | `TUNNELBOX_CLAUDE_PLUGIN_DIR` | 包内 `official-plugin/` | 覆盖要加载的**官方 Claude Code 插件**目录（Agent SDK `options.plugins`） |
41
- | `TUNNELBOX_CLAUDE_WARM` | 关 | 开启 CLI 子进程预热（alpha） |
56
+ | `TUNNELBOX_RELAY_URL` | saved relay URL | Relay address (e.g. `wss://chat.example.com`) |
57
+ | `TUNNELBOX_CWD` | `process.cwd()` | Default workspace; switch per-session from the phone workspace picker |
58
+ | `TUNNELBOX_CLAUDE_MODE` | `default` | Per-turn `permissionMode`: `default/plan/acceptEdits/bypassPermissions/dontAsk/auto`. `bypassPermissions` allows everything (dangerous) and reports `permission=false` |
59
+ | `TUNNELBOX_CLAUDE_MODEL` | claude default | Model override (`options.model`) |
60
+ | `TUNNELBOX_CLAUDE_THINKING` | claude default | `off \| adaptive \| enabled[:budget]` |
61
+ | `TUNNELBOX_CLAUDE_MAX_THINKING_TOKENS` | - | Thinking token budget |
62
+ | `TUNNELBOX_CLAUDE_ENV_*` | - | Extra env vars passed to the claude subprocess (prefix stripped, e.g. `TUNNELBOX_CLAUDE_ENV_ANTHROPIC_BASE_URL=…`) |
63
+ | `TUNNELBOX_CLAUDE_DIALOG_KINDS` | empty | Whitelist of `request_user_dialog` kinds (experimental) |
64
+ | `TUNNELBOX_CLAUDE_ASK_USER_QUESTION` | on | Claude `AskUserQuestion` → phone structured question card; set `0` to disable (auto-reject) |
65
+ | `TUNNELBOX_CLAUDE_PLUGIN_DIR` | bundled `official-plugin/` | Claude Code plugin directory loaded via `options.plugins` |
42
66
 
43
67
  ```bash
44
- TUNNELBOX_RELAY_URL=wss://chat.example.com TUNNELBOX_CWD=D:/workspace/project \
45
- TUNNELBOX_CLAUDE_MODE=default TUNNELBOX_CLAUDE_THINKING=adaptive node dist/index.mjs
68
+ TUNNELBOX_RELAY_URL=wss://chat.example.com TUNNELBOX_CWD=D:/workspace/project tunnelbox-claude-code
46
69
  ```
47
70
 
48
- > 模式为会话级：`session.prompt.agent:"plan"` 会把该会话切到 plan 模式，`"build"` 切回默认。
71
+ > Sessions are per-agent: sending `plan` mode switches that session to plan mode; `build` switches back.
49
72
 
50
- ## 能力位（agent.info.capabilities）
73
+ ## Capabilities
51
74
 
52
- | 能力 | 值 | 实现 |
75
+ | Capability | Value | Notes |
53
76
  |---|---|---|
54
- | streaming | true | `includePartialMessages` 流事件（text/thinking delta）→ `message.part` |
55
- | thinking | true | 模型开启思考时 `thinking_delta` → thinking 部件 |
56
- | permission | 默认 true | `canUseTool` → 手机审批（离线/断线/超时 fail-closed 拒绝）；`mode=bypassPermissions` 时为 false（不注册 canUseTool） |
57
- | commands | true | 适配器命令 `/new` `/help` |
58
- | abort | **true** | `AbortController.abort()` 中止本次回合 |
77
+ | streaming | ✅ | `includePartialMessages` stream events → live deltas |
78
+ | thinking | ✅ | `thinking_delta` → thinking parts |
79
+ | permission | ✅ default | `canUseTool` → phone approval card (fail-closed); `false` under `mode=bypassPermissions` |
80
+ | commands | ✅ | `/new`, `/help` |
81
+ | abort | ✅ | `session.abort` interrupts the running turn (resident process stays alive) |
82
+ | workspaces | ✅ | per-session `cwd` |
59
83
 
60
- ## 会话与工作区
84
+ ## Phone approval (security)
61
85
 
62
- - **会话 id = Claude 会话 UUID**：新会话由适配器生成 UUID（`query options.sessionId` 固定 id，首次 prompt 落盘）；也能在列表里看到并 resume 你在终端里开过的既有会话。
63
- - 数据源：`claude-agent-sdk` 的 `listSessions / getSessionInfo / getSessionMessages / deleteSession`（不手读 JSONL），会话/凭证沿用 `~/.claude`，与本地 Claude Code 互不干扰。
64
- - 工作区 = 会话的 `cwd`；跨会话并行（每会话一个 `query`/`AbortController`），同一会话运行中禁止再发。
65
- - 每轮对话是**一条手机消息 = 一次 query**（resume 式续聊），首次拉起 CLI 有秒级延迟属正常；回合结束会广播 `session.updated`（标题/时间），手机端原地 patch。
66
- - 历史拉取会把 `tool_result` 折叠成独立的 `role:"tool"` 卡（结果截断 ≤2KB）；断线期间的流式增量不补发，重连后由手机重拉 `session.messages` 恢复。
86
+ - Approval goes through `canUseTool`: relay online → push approval card (allow / deny / always-allow); **relay offline / 120s timeout / aborted → always denied (fail-closed)** — never auto-approved. Pending approvals are cleared immediately on disconnect.
87
+ - Approval cards show Claude's native prompt (`title`/`description`).
88
+ - While the phone is online it decides first — the adapter is headless, so there is no local fallback when offline (requests are denied).
67
89
 
68
- ## 工具审批（安全）
90
+ ## Sessions & workspaces
69
91
 
70
- - 每次 query 默认 `permissionMode` 由配置/agent 决定 + `canUseTool` 拦截：中继在线 → 推手机审批卡（允许/拒绝/总是允许→写入 session 级建议规则）；**中继断线 / 120s 超时 / 中止 → 一律自动拒绝（fail-closed）**，绝不自动放行；断线瞬间会即时清掉所有待审批，无需等满超时。
71
- - 与 CLI 交互提示一致：审批卡片展示 Claude 的原生提示（`title`/`description`）。
72
- - 手机在线时审批**优先于 PC**：适配器是 headless 独立进程，claude 子进程无本地 TUI，审批全部经 `canUseTool` 回包；离线时没有本地兜底（拒绝），与 opencode（TUI 兜底）/ dsh（dsh web 兜底）不同，详见 `docs/适配器接口规范.md` §3.3。
92
+ - **Session id = Claude session UUID.** New sessions are created by the adapter; sessions you opened in the terminal also appear in the list and can be resumed.
93
+ - Data is managed via the official `claude-agent-sdk` (`listSessions`/`getSessionMessages`/…), reusing `~/.claude` — no conflicts with your local Claude Code.
94
+ - **Resident long-lived sessions:** the first phone message spawns a claude subprocess that stays alive (official Streaming Input Mode); later messages continue in the same process — no per-message cold start. `session.abort` interrupts the current turn only.
95
+ - Workspace = the session's `cwd`; sessions run in parallel (one resident subprocess each); a running session can't receive another message.
73
96
 
74
- ## 对话框 / MCP elicitation（实验性）
97
+ ## Questions & dialogs (experimental)
75
98
 
76
- - `request_user_dialog`（Claude 的"选择/确认"阻塞对话框）：已实现 `onUserDialog` + `supportedDialogKinds`；kind 白名单走 `TUNNELBOX_CLAUDE_DIALOG_KINDS`（**默认空 → SDK 不发任何对话框**，fail-closed）。启用后按 `dialog.ts` 的启发式映射把 payload 转成手机 `choice/input` 卡，作答值回填 `UserDialogResult.completed`。
77
- - MCP elicitation：`mode=url` 弹手机审批卡（允许=accept）；`form` 及其余保持自动拒绝。
78
- - ⚠️ 对话框 payload/result 是 kind 相关结构、随 CLI 版本演进：以上映射为**实验性**，需装有 claude CLI 后按实际抓包校正 `dialog.ts` 与 `bridge.ts` 的 `onUserDialog`。
99
+ - Claude `AskUserQuestion` → a **structured question card** on the phone (multiple questions/choices/custom input).
100
+ - `request_user_dialog` is whitelist-gated by `TUNNELBOX_CLAUDE_DIALOG_KINDS` (empty by default → the SDK sends no dialogs, fail-closed).
79
101
 
80
- ## 官方插件（official-plugin）
102
+ > ⚠️ Dialog payloads are kind-specific and evolve with the CLI; these mappings are experimental.
81
103
 
82
- 本包同时包含一个**符合 Claude Code 官方插件规范**的插件（`official-plugin/`，随 npm 发布），
83
- 由 Agent SDK 在每个驱动会话里加载（`options.plugins`）——功能需求主通道仍是 SDK 桥（流式/会话/审批），插件提供会话内扩展：
104
+ ## Official plugin (bundled)
84
105
 
85
- - `/tunnelbox:pair`、`/tunnelbox:status`（commands + skill）：在 Claude 会话里直接取/查手机配对状态（`bin/tunnelbox.mjs`，自包含 Node，状态存 `CLAUDE_PLUGIN_DATA`）。
86
- - 审批**双通道规避**：SDK 桥会注入 `TUNNELBOX_SDK_SESSION=1`，插件 `PermissionRequest` hook 检测到后**不拦截**（交给 `canUseTool`），避免双弹；
87
- 仅当独立 `claude --plugin-dir ./official-plugin` 本地会话时，hook 才把当回合工具审批转发到手机（未绑定/中继不可达时不输出，交本地询问）。
106
+ This package ships a Claude Code plugin (`official-plugin/`) that the SDK loads into every driven session (`options.plugins`) — slash skills `/tunnelbox:pair` and `/tunnelbox:status` let you view/pair phone status inside a Claude session. The main remote feature set comes from the SDK bridge; the plugin is an in-session extension.
88
107
 
89
- 本地直接体验插件：`claude --plugin-dir ./plugin/claude-code/official-plugin`（校验：`claude plugin validate ./plugin/claude-code/official-plugin`）。
108
+ ## Multilingual
90
109
 
91
- > 决策：功能主体始终由 Agent SDK 桥承担（列表/流式/审批/中止）；official-plugin 只是**会话内扩展子集**（配对/状态/可选审批），不是实现远程功能所必需。
110
+ User-visible output supports 8 languages (`zh-CN` / `zh-TW` / `en-US` / `ja-JP` / `ko-KR` / `fr-FR` / `de-DE` / `es-ES`). Resolution order: `TUNNELBOX_LANG` > saved `remote-state.claude-code.json.lang` > system locale > `en-US`.
92
111
 
93
- ## 目录结构
112
+ ## Troubleshooting
94
113
 
114
+ | Problem | Fix |
115
+ |---|---|
116
+ | No QR / pairing code on screen | Run `tunnelbox-claude-code --pair` to print a fresh one |
117
+ | Need to pair a different phone | Unbind in the app settings, then run with `--pair` again |
118
+ | Already bound but phone doesn't connect | Confirm both use the same relay; check `~/.tunnelbox/tunnelbox.log` |
119
+ | Use your own relay | Start with `TUNNELBOX_RELAY_URL=wss://<your-relay>` |
120
+
121
+ ## State files
122
+
123
+ - `~/.tunnelbox/remote-state.claude-code.json` — agentID / relay / bound state / language
124
+ - `~/.tunnelbox/remote-pairing.claude-code.txt` + `remote-pairing.json` — latest pairing info
125
+ - `~/.tunnelbox/tunnelbox.log` — adapter log
126
+
127
+ ## Uninstall
128
+
129
+ ```bash
130
+ npm uninstall -g @tunnelbox/claude-code
95
131
  ```
96
- plugin/claude-code/
97
- ├── package.json
98
- ├── tsconfig.json
99
- ├── scripts/build.mjs # esbuild 单文件 dist/index.mjs（external @anthropic-ai/*、qrcode）
100
- ├── scripts/smoke.mjs # 冒烟：连本地中继验证配对流程（不驱动 claude）
101
- ├── official-plugin/ # ★ 官方 Claude Code 插件（随包发布，SDK options.plugins 加载）
102
- │ ├── .claude-plugin/plugin.json
103
- │ ├── commands/ # pair.md / status.md
104
- │ ├── skills/pair/SKILL.md
105
- │ ├── hooks/hooks.json # PermissionRequest → bin/tunnelbox.mjs ask（SDK 会话不拦截）
106
- │ └── bin/ # tunnelbox.mjs / tunnelbox(.cmd) PATH 壳
107
- └── src/
108
- ├── index.ts # 入口：env 解析（mode/model/thinking/dialogKinds/warm…）+ 连接中继
109
- ├── bridge.ts # relay 连接/配对/消息路由/query 回合/审批/对话框/elicitation
110
- ├── dialog.ts # request_user_dialog kind → 手机卡 启发式映射（实验性）
111
- ├── warm.ts # CLI 子进程预热池（alpha，TUNNELBOX_CLAUDE_WARM 开启）
112
- ├── map.ts # SDK 流事件/内容块 → 协议 Part/ChatMessage（tool_result→tool 卡）
113
- ├── sessions.ts # claude-agent-sdk 会话接口封装
114
- └── globals.d.ts # WebSocket 全局类型
115
- ```
116
132
 
117
- ## 备注
133
+ Remove `~/.tunnelbox` (all adapters' shared state) only if you no longer use any tunnelbox adapter.
134
+
135
+ ## Development
118
136
 
119
- - 本适配器状态文件独立：`~/.config/opencode/remote-state.claude-code.json`（与 opencode/dsh 并存不冲突）。
120
- - 尚未验证项：需本机装有 claude CLI 后实测（流式增量粒度、`Options.sessionId` 固定 UUID、`session.updated` 触发时机、approval 帧、`TUNNELBOX_CLAUDE_DIALOG_KINDS` 真实 kind、`TUNNELBOX_CLAUDE_WARM` 预热进程生命周期）——相关兜底/实验性代码均已就位。
137
+ Implementation details (protocol mapping, source layout, design decisions, untested items) are kept in the source repository as `DEV.md` next to this package, plus the protocol spec under the repo's `docs/`.
package/README.zh-CN.md ADDED
@@ -0,0 +1,137 @@
1
+ # @tunnelbox/claude-code
2
+
3
+ [English](README.md) · [简体中文](README.zh-CN.md)
4
+
5
+ **官网：** [www.tunnelbox.top](https://www.tunnelbox.top)
6
+
7
+ **tunnelbox Claude Code 适配器（独立进程）**：用手机远程驱动电脑上的 Claude Code——会话 / 流式 / 工具审批 / 中止 / 删除。它以常驻 Node 进程运行，只向中继发出站连接（无需公网 IP / 端口映射）。
8
+
9
+ ```
10
+ 手机 App ──WSS──► relay ──WSS──► tunnelbox-claude-code（本适配器）
11
+ └─ @anthropic-ai/claude-agent-sdk query()
12
+ └─ 拉起本机 claude CLI 子进程
13
+ ```
14
+
15
+ ## 快速上手（安装 → 运行 → 配对 → 使用）
16
+
17
+ 在装有 Claude Code 并已登录的电脑上，按以下步骤操作一次即可。
18
+
19
+ ### 第 0 步 — 准备手机
20
+
21
+ 在官网下载并安装 tunnelbox App（Android / iOS 均已上架）：**https://www.tunnelbox.top**
22
+
23
+ - 按提示登录/注册账号。
24
+
25
+ ### 第 1 步 — 电脑上安装适配器
26
+
27
+ 前置条件：Node.js ≥ 22，且本机已安装并登录 **Claude Code CLI**（`claude --version` 可用、`~/.claude/.credentials.json` 存在）。适配器驱动本机 `claude` 子进程——手机端无需安装 Claude。
28
+
29
+ ```bash
30
+ npm install -g @tunnelbox/claude-code
31
+ ```
32
+
33
+ ### 第 2 步 — 运行
34
+
35
+ ```bash
36
+ tunnelbox-claude-code
37
+ ```
38
+
39
+ 首次启动会连接中继，并在终端打印**配对二维码 + 配对码**。
40
+
41
+ ### 第 3 步 — 与手机配对
42
+
43
+ 在手机 App 点「扫一扫配对」，扫描终端二维码（或手动输入配对码）。配对码一次性有效，约 10 分钟。
44
+
45
+ - 绑定后再次启动会打印「已绑定账号，从手机「我的电脑」直接连接」，不再刷新码；
46
+ - 随时需要新码：运行 `tunnelbox-claude-code --pair`。
47
+
48
+ ### 第 4 步 — 在手机上使用
49
+
50
+ 在 App 里打开这台电脑，即可新建会话、发消息、看流式输出（文本 + 思考）、审批危险工具调用、回答 Claude 的结构化提问、中止运行中的会话。
51
+
52
+ ## 配置
53
+
54
+ | 环境变量 | 默认 | 说明 |
55
+ |---|---|---|
56
+ | `TUNNELBOX_RELAY_URL` | state 保存的地址 | 中继地址（如 `wss://chat.example.com`） |
57
+ | `TUNNELBOX_CWD` | `process.cwd()` | 默认工作区；手机上可按会话切换工作区 |
58
+ | `TUNNELBOX_CLAUDE_MODE` | `default` | 每回合 `permissionMode`：`default/plan/acceptEdits/bypassPermissions/dontAsk/auto`。`bypassPermissions` 全放行（危险），并上报 `permission=false` |
59
+ | `TUNNELBOX_CLAUDE_MODEL` | claude 默认 | 模型覆盖（`options.model`） |
60
+ | `TUNNELBOX_CLAUDE_THINKING` | claude 默认 | `off \| adaptive \| enabled[:budget]` |
61
+ | `TUNNELBOX_CLAUDE_MAX_THINKING_TOKENS` | - | 思考 token 上限 |
62
+ | `TUNNELBOX_CLAUDE_ENV_*` | - | 透传给 claude 子进程的环境变量（前缀去掉，如 `TUNNELBOX_CLAUDE_ENV_ANTHROPIC_BASE_URL=…`） |
63
+ | `TUNNELBOX_CLAUDE_DIALOG_KINDS` | 空 | `request_user_dialog` kind 白名单（实验性） |
64
+ | `TUNNELBOX_CLAUDE_ASK_USER_QUESTION` | 开 | Claude `AskUserQuestion` → 手机**结构化提问卡**；设 `0` 关闭（自动拒绝） |
65
+ | `TUNNELBOX_CLAUDE_PLUGIN_DIR` | 包内 `official-plugin/` | Claude Code 插件目录（`options.plugins` 加载） |
66
+
67
+ ```bash
68
+ TUNNELBOX_RELAY_URL=wss://chat.example.com TUNNELBOX_CWD=D:/workspace/project tunnelbox-claude-code
69
+ ```
70
+
71
+ > 模式为会话级：发 `plan` 把该会话切到 plan 模式，`build` 切回默认。
72
+
73
+ ## 能力位
74
+
75
+ | 能力 | 值 | 说明 |
76
+ |---|---|---|
77
+ | streaming | ✅ | `includePartialMessages` 流事件 → 实时增量 |
78
+ | thinking | ✅ | `thinking_delta` → thinking 部件 |
79
+ | permission | ✅ 默认 | `canUseTool` → 手机审批卡（fail-closed）；`mode=bypassPermissions` 时为 false |
80
+ | commands | ✅ | `/new`、`/help` |
81
+ | abort | ✅ | `session.abort` 打断当前回合（常驻进程保持存活） |
82
+ | workspaces | ✅ | 每会话一个 `cwd` |
83
+
84
+ ## 手机审批（安全）
85
+
86
+ - 审批经 `canUseTool`：中继在线 → 推审批卡（允许 / 拒绝 / 总是允许）；**中继断线 / 120s 超时 / 中止 → 一律自动拒绝（fail-closed）**，绝不自动放行；断线瞬间即清空待审批。
87
+ - 审批卡展示 Claude 的原生提示（`title`/`description`）。
88
+ - 手机在线时审批优先于 PC：适配器 headless，离线时无本地兜底（一律拒绝）。
89
+
90
+ ## 会话与工作区
91
+
92
+ - **会话 id = Claude 会话 UUID**。新会话由适配器创建；终端里开过的会话也会出现在列表并可 resume。
93
+ - 数据经官方 `claude-agent-sdk`（`listSessions`/`getSessionMessages`/…）读写，沿用 `~/.claude`，与本地 Claude Code 互不干扰。
94
+ - **常驻长活会话**：首次手机消息拉起一个 claude 子进程并**保持存活**（官方 Streaming Input Mode）；后续消息在**同一进程**续聊，无逐条冷启动。`session.abort` 只打断当前回合。
95
+ - 工作区 = 会话的 `cwd`；跨会话并行（每会话一个常驻子进程），运行中的会话不能再发消息。
96
+
97
+ ## 提问与对话框（实验性）
98
+
99
+ - Claude `AskUserQuestion` → 手机**结构化提问卡**（多题/多选/自定义输入）。
100
+ - `request_user_dialog` 由 `TUNNELBOX_CLAUDE_DIALOG_KINDS` 白名单门控（默认空 → SDK 不发对话框，fail-closed）。
101
+
102
+ > ⚠️ 对话框载荷是 kind 相关结构、随 CLI 演进；以上映射为实验性。
103
+
104
+ ## 官方插件（随包内置）
105
+
106
+ 本包同时包含一个符合 Claude Code 官方规范的插件（`official-plugin/`），由 Agent SDK 在每个驱动会话里加载（`options.plugins`）——斜杠技能 `/tunnelbox:pair`、`/tunnelbox:status` 可在 Claude 会话内取/查手机配对状态。远程功能主体由 SDK 桥承担，插件只是会话内扩展。
107
+
108
+ ## 多语言
109
+
110
+ 用户可见输出支持 8 种语言（`zh-CN` / `zh-TW` / `en-US` / `ja-JP` / `ko-KR` / `fr-FR` / `de-DE` / `es-ES`）。解析顺序：`TUNNELBOX_LANG` > `remote-state.claude-code.json` 的 `lang` > 系统 locale > 默认 `en-US`。
111
+
112
+ ## 故障排查
113
+
114
+ | 问题 | 解决 |
115
+ |---|---|
116
+ | 终端没有二维码/配对码 | 运行 `tunnelbox-claude-code --pair` 打印新码 |
117
+ | 需要换手机配对 | 在 App 设置里解绑，再带 `--pair` 运行 |
118
+ | 已绑定但手机连不上 | 确认两端同一中继；查看 `~/.tunnelbox/tunnelbox.log` |
119
+ | 使用自建中继 | 启动时带 `TUNNELBOX_RELAY_URL=wss://<你的中继>` |
120
+
121
+ ## 状态文件
122
+
123
+ - `~/.tunnelbox/remote-state.claude-code.json` — agentID / 中继地址 / 绑定状态 / 语言
124
+ - `~/.tunnelbox/remote-pairing.claude-code.txt` + `remote-pairing.json` — 最新配对信息
125
+ - `~/.tunnelbox/tunnelbox.log` — 适配器日志
126
+
127
+ ## 卸载
128
+
129
+ ```bash
130
+ npm uninstall -g @tunnelbox/claude-code
131
+ ```
132
+
133
+ 仅当不再使用任何 tunnelbox 适配器时，才删除 `~/.tunnelbox`（各适配器共享状态）。
134
+
135
+ ## 开发
136
+
137
+ 实现细节（协议映射、源码结构、决策记录、待实测项）保存在源码仓库中本包旁的 `DEV.md` 与仓库 `docs/` 下。