@tunnelbox/claude-code 0.1.3 → 0.1.5
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.
- package/README.md +137 -147
- package/README.zh-CN.md +137 -0
- package/dist/index.mjs +359 -118
- package/official-plugin/bin/tunnelbox.mjs +3 -10
- package/official-plugin/skills/pair/SKILL.md +2 -2
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,147 +1,137 @@
|
|
|
1
|
-
# @tunnelbox/claude-code
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
|
76
|
-
|
|
77
|
-
|
|
|
78
|
-
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
- `
|
|
87
|
-
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
-
|
|
93
|
-
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
- `
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
├── sessions.ts # claude-agent-sdk 会话接口封装
|
|
139
|
-
└── globals.d.ts # WebSocket 全局类型
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
## 备注
|
|
143
|
-
|
|
144
|
-
- 基准依赖：`@anthropic-ai/claude-agent-sdk`（当前 ^0.3.258，随包 Claude Code 2.1.x；SDK 版本与 Claude Code 版本同步对应）。
|
|
145
|
-
- 本适配器状态文件独立：`~/.tunnelbox/remote-state.claude-code.json`（tunnelbox 独立根目录，与各适配器并存不冲突）。
|
|
146
|
-
- 已按官方契约修正/明确的点：子进程 `env` 自动并入适配器 `process.env`（SDK `options.env` 为整体替换）；`bypassPermissions` 自动置 `allowDangerouslySkipPermissions`；**常驻长活会话**（streaming-input：每会话一个 `query({prompt:常开 AsyncIterable})`，`result` 为轮界、进程跨轮存活，`session.abort` 走 `query.interrupt()`）；`warm` 预热池已停用（常驻会话免冷启动）。
|
|
147
|
-
- 尚未验证项（需装有 claude CLI 并登录后可实跑验证）：流式增量粒度与 assistant 兜底去重（SDK 自述一次 turn 多个 assistant 消息共享 message.id、每条 content 只装一块）、`Options.sessionId` 固定 UUID 能否进 `listSessions`、`redacted_thinking`/`signature_delta` 展示、`TUNNELBOX_CLAUDE_DIALOG_KINDS` 真实 kind 载荷、approval 帧——相关兜底/实验性代码均已就位。
|
|
1
|
+
# @tunnelbox/claude-code
|
|
2
|
+
|
|
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).
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
Phone app ──WSS──► relay ──WSS──► tunnelbox-claude-code (this adapter)
|
|
11
|
+
└─ @anthropic-ai/claude-agent-sdk query()
|
|
12
|
+
└─ spawns your local claude CLI
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Quick start (install → run → pair → use)
|
|
16
|
+
|
|
17
|
+
Follow these steps once on a computer that has Claude Code installed and signed in.
|
|
18
|
+
|
|
19
|
+
### Step 0 — Prepare your phone
|
|
20
|
+
|
|
21
|
+
Install the tunnelbox App (Android & iOS) from the official website: **https://www.tunnelbox.top**
|
|
22
|
+
|
|
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.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npm install -g @tunnelbox/claude-code
|
|
31
|
+
```
|
|
32
|
+
|
|
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.
|
|
44
|
+
|
|
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`.
|
|
47
|
+
|
|
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 |
|
|
55
|
+
|---|---|---|
|
|
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` |
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
TUNNELBOX_RELAY_URL=wss://chat.example.com TUNNELBOX_CWD=D:/workspace/project tunnelbox-claude-code
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
> Sessions are per-agent: sending `plan` mode switches that session to plan mode; `build` switches back.
|
|
72
|
+
|
|
73
|
+
## Capabilities
|
|
74
|
+
|
|
75
|
+
| Capability | Value | Notes |
|
|
76
|
+
|---|---|---|
|
|
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` |
|
|
83
|
+
|
|
84
|
+
## Phone approval (security)
|
|
85
|
+
|
|
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).
|
|
89
|
+
|
|
90
|
+
## Sessions & workspaces
|
|
91
|
+
|
|
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.
|
|
96
|
+
|
|
97
|
+
## Questions & dialogs (experimental)
|
|
98
|
+
|
|
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).
|
|
101
|
+
|
|
102
|
+
> ⚠️ Dialog payloads are kind-specific and evolve with the CLI; these mappings are experimental.
|
|
103
|
+
|
|
104
|
+
## Official plugin (bundled)
|
|
105
|
+
|
|
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.
|
|
107
|
+
|
|
108
|
+
## Multilingual
|
|
109
|
+
|
|
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`.
|
|
111
|
+
|
|
112
|
+
## Troubleshooting
|
|
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
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Remove `~/.tunnelbox` (all adapters' shared state) only if you no longer use any tunnelbox adapter.
|
|
134
|
+
|
|
135
|
+
## Development
|
|
136
|
+
|
|
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/` 下。
|