@unlinearity/cli-wechat-bridge 1.0.5 → 1.0.7

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 CHANGED
@@ -1,34 +1,44 @@
1
1
  # CLI WeChat Bridge
2
2
 
3
- <p align='center'><img src='docs/images/logo.png' width=90%></p>
3
+ <p align='center'><img src='docs/images/logo.png' width=90%></p>
4
4
 
5
5
  <p align="center"><img alt="Typing SVG" src="https://readme-typing-svg.herokuapp.com?font=JetBrains+Mono&amp;weight=600&amp;duration=4000&amp;pause=500&amp;color=06C763&amp;center=true&amp;vCenter=true&amp;width=660&amp;lines=CLI+WeChat+Bridge+%E5%BE%AE%E4%BF%A1%E6%A1%A5%E6%8E%A5;%E7%9C%9F%E6%AD%A3%E7%9A%84%E2%80%9C%E7%BB%88%E7%AB%AF-%E5%BE%AE%E4%BF%A1%E2%80%9D%E5%8E%9F%E7%94%9F%E5%8F%8C%E5%90%91%E4%BA%A4%E4%BA%92"></p>
6
6
 
7
7
  <p align="center">
8
8
  <a href="https://github.com/UNLINEARITY/CLI-WeChat-Bridge"><img alt="GitHub stars" src="https://img.shields.io/github/stars/UNLINEARITY/CLI-WeChat-Bridge?label=Stars&amp;style=for-the-badge&amp;logo=github&amp;color=0891b2&amp;labelColor=1c1917"></a>
9
- <a href="https://www.npmjs.com/package/@unlinearity/cli-wechat-bridge"><img alt="npm version" src="https://img.shields.io/npm/v/@unlinearity/cli-wechat-bridge?label=npm&amp;style=for-the-badge&amp;logo=npm&amp;color=cb3837&amp;labelColor=1c1917"></a>
10
- <a href="https://www.npmjs.com/package/@unlinearity/cli-wechat-bridge"><img alt="npm downloads" src="https://img.shields.io/npm/dm/@unlinearity/cli-wechat-bridge?label=Downloads&amp;style=for-the-badge&amp;logo=npm&amp;color=16a34a&amp;labelColor=1c1917"></a>
11
- <a href="https://github.com/UNLINEARITY/CLI-WeChat-Bridge/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/UNLINEARITY/CLI-WeChat-Bridge?label=License&amp;style=for-the-badge&amp;color=7c3aed&amp;labelColor=1c1917"></a>
9
+ <a href="https://www.npmjs.com/package/cli-wechat-bridge"><img alt="npm version" src="https://img.shields.io/npm/v/cli-wechat-bridge?label=npm&amp;style=for-the-badge&amp;logo=npm&amp;color=cb3837&amp;labelColor=1c1917"></a>
10
+ <a href="https://www.npmjs.com/package/cli-wechat-bridge"><img alt="npm downloads" src="https://img.shields.io/npm/dm/cli-wechat-bridge?label=Downloads&amp;style=for-the-badge&amp;logo=npm&amp;color=16a34a&amp;labelColor=1c1917"></a>
11
+ <a href="https://www.npmjs.com/package/@unlinearity/cli-wechat-bridge"><img alt="scoped npm downloads" src="https://img.shields.io/npm/dm/@unlinearity/cli-wechat-bridge?label=Scoped%20downloads&amp;style=for-the-badge&amp;logo=npm&amp;color=15803d&amp;labelColor=1c1917"></a>
12
+ <a href="https://www.npmjs.com/package/cli-wechat-bridge">
13
+ <img alt="License" src="https://img.shields.io/npm/l/cli-wechat-bridge?label=License&style=for-the-badge&color=7c3aed&labelColor=1c1917">
14
+ </a>
12
15
  </p>
13
16
 
14
- **命令行工具的微信桥接**:本项目用于桥接微信消息与本地运行的 [`Codex`](https://github.com/openai/codex)、[`Claude Code`](https://code.claude.com/docs/en/overview)、`OpenCode` 或持久化 `powershell.exe` 会话,并将本地输出、审批请求与运行状态同步回微信。
17
+ **命令行工具的微信桥接**:本项目将微信消息桥接到本地运行的 [`Codex`](https://github.com/openai/codex)、[`Claude Code`](https://code.claude.com/docs/en/overview) 和 [`OpenCode`](https://github.com/anomalyco/opencode),同时把本地输出、审批请求与运行状态同步回微信。
15
18
 
16
- 当前实现以本地工作流为中心展开,重点是保留**本地原生终端体验**,支持原生使用以及高级参数注入,并在此基础上提供微信侧的远程输入、结果回流与状态同步能力。
19
+ 项目围绕本地工作流设计,重点是保留**本地原生终端体验**:你仍然在本地使用原生 CLI 和高级启动参数,微信负责远程输入、结果回流与状态同步。
17
20
 
18
- <p align='center'><img src='docs/images/animation.webp' width=90%></p>
21
+ <p align='center'><img src='docs/images/animation.webp' width=90%></p>
19
22
 
20
- ## 这个项目解决什么问题
23
+ ## 文档导航
21
24
 
22
- 本项目面向这样一类使用场景:
25
+ - [问题排查](docs/troubleshooting.md):上下文 token、网络代理、本地 endpoint、已知限制等常见问题。
26
+ - [运行配置](docs/configuration.md):数据目录、上传大小限制、调试开关等环境变量。
27
+ - [开发说明](docs/development.md):源码运行、测试、构建、打包和全局 smoke 验证。
28
+ - [发布说明](docs/releases/README.md):各版本变更与升级说明。
29
+
30
+ ## 这个项目解决什么问题?
31
+
32
+ 本项目适合这样的使用场景:
23
33
 
24
34
  - 你的主工作流仍在本地终端中进行;
25
- - 你希望继续使用原生 `codex` 或其他 CLI 工具,而不是迁移到网页或托管机器人;
26
- - 你希望在离开电脑时,仍能通过微信向本地会话发送请求,并接收必要的输出、与状态同步。
35
+ - 你希望继续使用 Codex、Claude Code、OpenCode 等原生 CLI,而不是迁移到网页或托管机器人;
36
+ - 你希望离开电脑后,仍能通过微信向本地会话发送请求,并接收必要输出和状态更新。
27
37
 
28
- 当前项目并不试图把微信变成新的主工作界面。相反,它的定位是:
38
+ 本项目不试图把微信变成新的主工作界面。它的定位是:
29
39
 
30
40
  - 本地 CLI 仍然是主工作界面,并保持原生的使用逻辑;
31
- - 微信是远程入口,允许远程接入;
41
+ - 微信是远程入口,用来接入本地会话;
32
42
  - 会话一致性、线程状态和审批流仍以**本地会话为中心**。
33
43
 
34
44
  ## 快速开始
@@ -36,109 +46,86 @@
36
46
  ### 1. 环境要求
37
47
 
38
48
  - [Node.js](https://nodejs.org/en/download) `>= 24.0.0`(建议直接安装官网 LTS 版本)
39
- - [Bun](https://bun.sh/docs/installation) `>= 1.0.0` (开发者需要,普通用户无需安装)
40
- - 已安装以下至少一种本地 CLI:(最好更新至最新版本)
49
+ - 已安装以下任意一种本地 CLI,并尽量保持最新版本:
41
50
  - [Codex](https://github.com/openai/codex)
42
51
  - [Claude Code](https://code.claude.com/docs/en/overview)
43
- - OpenCode
44
- - powershell.exe
52
+ - [OpenCode](https://github.com/anomalyco/opencode)
45
53
 
46
54
  ### 2. 安装
47
55
 
48
- 正式版本可以直接从 npm 安装:
56
+ 发布版本可以直接从 npm 安装:
49
57
 
50
58
  ```bash
51
- npm install -g @unlinearity/cli-wechat-bridge@latest
59
+ npm install -g cli-wechat-bridge@latest
52
60
  ```
53
61
 
54
- 安装后可在任意项目目录中直接使用 `wechat-daemon`、`wechat-codex-start`、`wechat-claude-start`、`wechat-opencode-start` 等命令。
62
+ 安装后,可以在任意项目目录中使用 `wechat-daemon`、`wechat-codex-start`、`wechat-claude-start`、`wechat-opencode-start` 等命令。
55
63
 
56
- 如果你希望从源码运行或参与开发,也可以克隆仓库并安装依赖:
64
+ 兼容性说明:旧包名 `@unlinearity/cli-wechat-bridge` 会继续同步发布,已经安装旧包名的用户可以正常升级;新用户优先使用更短的 `cli-wechat-bridge`。
57
65
 
58
- ```bash
59
- git clone https://github.com/UNLINEARITY/CLI-WeChat-Bridge
60
- cd CLI-WeChat-Bridge
61
- bun install
62
- ```
66
+ ### 3. 完成微信登录
63
67
 
64
- 如果使用源码仓库,希望将当前工作区安装为全局命令:
68
+ 全局安装后运行:
65
69
 
66
70
  ```bash
67
- npm install -g .
71
+ wechat-setup
68
72
  ```
69
73
 
70
- 开发阶段也可以使用:
74
+ 登录流程会:
71
75
 
72
- ```bash
73
- npm link
74
- ```
75
-
76
- 说明:
76
+ 1. 获取微信登录二维码;
77
+ 2. 在终端打印二维码;
78
+ 3. 等待你在微信中扫码并确认;
79
+ 4. 保存本地登录凭据。
77
80
 
78
- - `npm link` 会让全局命令直接指向当前仓库源码;
79
- - `npm install -g .` 会安装一份当前仓库的复制版本;后续代码更新后需要重新执行一次。
81
+ ![微信登录二维码](docs/images/image-0.png)
80
82
 
81
- 如果你想把当前本地源码构建出的包安装到真实全局环境,并在任意目录人工验证,可以直接运行:
83
+ 登录成功后,程序会清理旧的同步游标和上下文 token,避免旧会话状态污染新的登录状态。数据目录、状态文件和旧版本迁移说明见 [问题排查](docs/troubleshooting.md#数据目录与状态文件)。
82
84
 
83
- ```bash
84
- npm run smoke:global
85
- ```
85
+ 首次安装或微信登录过期时,`wechat-codex-start`、`wechat-claude-start`、`wechat-opencode-start` 也会在前台提示扫码登录。
86
86
 
87
- 这个脚本会先用当前源码打出真实 npm tarball,再执行 `npm install -g <tarball>` 安装到真实全局环境;脚本结束后,你可以离开仓库目录运行 `wechat-codex-start` 等命令。如果你想先清理缓存、卸载当前全局包,或者顺便跑完整质量门禁,可以加上这些参数:
87
+ ### 4. 先从微信发一条同步消息(重要)
88
88
 
89
- ```bash
90
- npm run smoke:global -- --purge-global --clean-cache --full
91
- ```
89
+ 启动 bridge 后,建议先在微信里向 Bot 发送一条消息,例如 `hello`、你要执行的任务,或任意一句话。这样 bridge 能拿到最新的微信会话 `context_token`,之后本地终端中的输入、最终回复和审批提示才能稳定同步回微信。
92
90
 
93
- - `--clean-cache`:先执行 `npm cache clean --force`
94
- - `--purge-global`:先卸载当前真实全局包
95
- - `--full`:额外执行 `npm run quality`
96
- - `--keep-tarball`:保留生成的 tarball,方便排查
91
+ 如果冷启动或长时间闲置后直接从本地终端先发消息,bridge 通常仍会捕获这条本地输入并交给 Codex / Claude Code / OpenCode 处理,但回发到微信时可能因为旧的 `context_token` 失效而失败。表现是:本地已经有回复,微信暂时收不到;等你先从微信发来一条消息后,后续双向同步就能恢复正常。
97
92
 
98
- ### 3. 完成微信登录
93
+ ### 5. 单命令启动桥接(兼容模式)
99
94
 
100
- npm 全局安装后可以直接运行:
95
+ 先进入需要操作的项目目录:
101
96
 
102
97
  ```bash
103
- wechat-setup
104
- ```
105
-
106
- 如果是在 clone 的仓库目录下,也可以运行:
107
-
108
- ```bash
109
- bun run setup # 绑定微信 ClawBot
110
- ```
111
-
112
- 该流程会:
113
-
114
- 1. 获取微信登录二维码;
115
- 2. 在终端打印二维码;
116
- 3. 等待你在微信中扫码并确认;
117
- 4. 将 bot 凭据写入本地数据目录。
118
-
119
- ![alt text](docs/images/image-0.png)
120
-
121
- 默认凭据文件路径:
122
-
123
- ```text
124
- ~/.cli-bridge/account.json
98
+ cd D:\work\your-project
125
99
  ```
126
100
 
127
- 登录成功后会清理旧的 `sync_buf.txt` 和 `context_tokens.json`,避免旧会话状态污染新的登录状态。
101
+ 然后选择一个单命令入口:
128
102
 
129
- 从旧版本升级时,bridge 会自动从旧的 `~/.claude/channels/wechat` 迁移数据到 `~/.cli-bridge`,包括登录凭据、同步游标、上下文 token、工作区状态和已接收附件;已有的新目录文件不会被覆盖,旧目录也会原样保留。旧运行锁不会迁移,旧 `bridge.log` 会保存为 `legacy-bridge.log`,避免覆盖新的运行日志。
103
+ | 使用的本地 CLI | 启动命令 |
104
+ | --- | --- |
105
+ | Codex | `wechat-codex-start` |
106
+ | Claude Code | `wechat-claude-start` |
107
+ | OpenCode | `wechat-opencode-start` |
130
108
 
131
- 如果是首次安装或微信登录已过期,`wechat-codex-start`、`wechat-claude-start`、`wechat-opencode-start` 也会在前台提示扫码登录。
109
+ 这些启动器会自动完成以下动作:
132
110
 
133
- ### 4. 先从微信发一条同步消息(重要)
111
+ 1. 校验或刷新微信登录凭据;
112
+ 2. 如果当前目录已有 `wechat-daemon`,则委托 daemon 切换到对应 CLI;
113
+ 3. 如果没有 daemon,则复用当前目录中已运行的 bridge,或在当前目录启动新的 bridge;
114
+ 4. 如果已有独立 bridge 正在服务其他目录,则停止旧 bridge 并切换到当前目录;
115
+ 5. 等待当前目录对应的本地 companion endpoint 就绪;
116
+ 6. 打开可见的本地 CLI 会话。
134
117
 
135
- 启动 bridge 后,建议先在微信里向 Bot 发送一条消息,例如 `hello`、你要执行的任务或任意一句话。这样 bridge 能拿到最新的微信会话 `context_token`,之后本地终端里的输入、最终回复和审批提示才能稳定同步回微信。
118
+ 没有 daemon 时,`wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 仍按**单活工作区切换器**工作:
136
119
 
137
- 如果冷启动或长时间闲置后直接从本地终端先发消息,bridge 通常仍会捕获这条本地输入并交给 Codex / Claude Code / OpenCode 处理,但微信侧出站发送可能因为旧的 `context_token` 失效而失败。表现就是:本地已经有回复,微信暂时收不到;等你先从微信发来一条消息后,后续双向同步就能恢复正常。
120
+ - 同一时间只有一个项目与微信对话;
121
+ - 在当前目录重复执行是幂等的;
122
+ - 如果当前目录已经有可见 companion / panel 在运行,则不会重复打开第二个窗口;
123
+ - 如果检测到可见端仍在运行但 worker 状态异常(如 `stopped` / `error`),会自动重启 bridge 再重新打开可见端;
124
+ - 在其他目录执行会显式切换活动工作区。
138
125
 
139
- ### 5. 常驻 daemon 模式(推荐用于多 CLI 切换)
126
+ ### 6. 常驻 daemon 模式(支持多 CLI 切换)
140
127
 
141
- 如果你希望微信连接长期保持在线,并在 Codex / Claude Code / OpenCode 之间来回切换,推荐在项目目录启动一个统一 daemon:
128
+ 如果你希望微信连接长期保持在线,并在 Codex / Claude Code / OpenCode 之间来回切换,可以在项目目录启动统一 daemon:
142
129
 
143
130
  ```bash
144
131
  cd D:\work\your-project
@@ -150,12 +137,14 @@ wechat-daemon
150
137
  | 指令 | 行为 |
151
138
  | --- | --- |
152
139
  | `/codex` | 切换到 Codex |
153
- | `/claude` | 切换到 Claude Code |
154
- | `/opencode` | 切换到 OpenCode |
155
-
156
- daemon 启动后,后续切换都可以直接从微信发起;如果对应 CLI 还没有可见窗口,daemon 会自动打开或复用它,不需要再手动运行 `wechat-codex`、`wechat-claude` 或 `wechat-opencode`。
157
-
158
- daemon 的 v1 行为是:
140
+ | `/claude` | 切换到 Claude Code |
141
+ | `/opencode` | 切换到 OpenCode |
142
+
143
+ daemon 启动后,后续切换都可以直接从微信发起;如果对应 CLI 还没有可见窗口,daemon 会自动打开或复用它,不需要再手动运行 `wechat-codex`、`wechat-claude` 或 `wechat-opencode`。
144
+
145
+ ![多CLI 示例](docs/images/image-9.png)
146
+
147
+ 当前 daemon 行为如下:
159
148
 
160
149
  - daemon 绑定启动时的工作目录;暂不支持在微信里切换工作目录;
161
150
  - 启动时会自动接管并清理旧的单 bridge 进程、失效 lock 和旧 endpoint;
@@ -163,53 +152,20 @@ daemon 的 v1 行为是:
163
152
  - 如果对应适配器已经有可见 CLI 在运行,则直接复用;
164
153
  - 如果还没有对应 CLI,daemon 会自动打开一个新的可见终端;
165
154
  - Codex / Claude / OpenCode 的重要输出都会带上 `[codex]`、`[claude]`、`[opencode]` 标签再发回微信;
166
- - 可以在微信发送 `/daemon-stop` 停止 daemon。
155
+ - 可以在微信里发送 `/daemon-stop` 停止 daemon。
167
156
 
168
- 也可以启动时直接打开某个初始 CLI:
157
+ 也可以在启动时指定初始 CLI:
169
158
 
170
159
  ```bash
171
160
  wechat-daemon --adapter codex
172
161
  wechat-daemon --adapter claude --profile work
173
162
  ```
174
163
 
175
- 当同一工作目录已有 `wechat-daemon` 在运行时,`wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 会自动委托给 daemon:请求 daemon 切到对应 CLI,并在需要时打开可见终端,而不是停止 daemon 或关闭其他 CLI。
176
-
177
- ### 6. 单命令启动桥接(兼容模式)
178
-
179
- 先进入你要操作的项目目录:
180
-
181
- ```bash
182
- cd D:\work\your-project
183
- ```
184
-
185
- 推荐直接选择一个单命令入口:
186
-
187
- | 使用的本地 CLI | 启动命令 |
188
- | --- | --- |
189
- | Codex | `wechat-codex-start` |
190
- | Claude Code | `wechat-claude-start` |
191
- | OpenCode | `wechat-opencode-start` |
164
+ 当同一工作目录已有 `wechat-daemon` 在运行时,`wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 会自动委托给 daemon:请求 daemon 切到对应 CLI,并在需要时打开可见终端,不会停止 daemon 或关闭其他 CLI。
192
165
 
193
- 三者会自动完成以下动作:
194
-
195
- 1. 校验或刷新微信登录凭据;
196
- 2. 如果当前目录已有 `wechat-daemon`,则委托 daemon 切换到对应 CLI;
197
- 3. 如果没有 daemon,则复用当前目录已运行的 bridge,或在当前目录启动新的 bridge;
198
- 4. 如果独立 bridge 正在服务其他目录,则停止旧 bridge 并切换到当前目录;
199
- 5. 等待当前目录对应的本地 companion endpoint 就绪;
200
- 6. 打开可见的本地 CLI 会话。
166
+ ### 7. 手动双终端模式(高级调试)
201
167
 
202
- 在没有 daemon 时,`wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 仍按**单活工作区切换器**工作:
203
-
204
- - 同一时间只有一个项目与微信对话;
205
- - 在当前目录重复执行是幂等的;
206
- - 如果当前目录已经有可见 companion / panel 在运行,则不会重复打开第二个窗口;
207
- - 如果检测到可见端仍在但 worker 状态异常(如 `stopped` / `error`),会自动重启 bridge 再重新打开可见端;
208
- - 在其他目录执行会显式切换活动工作区。
209
-
210
- ### 7. 手动双终端模式(调试开发)
211
-
212
- 如果你希望明确观察 bridge 与本地 CLI companion,也可以分两个终端启动。
168
+ 如果你希望明确观察 bridge 与本地 CLI companion,也可以用两个终端分别启动。
213
169
 
214
170
  | 适配器 | 终端 A:bridge | 终端 B:本地 companion |
215
171
  | --- | --- | --- |
@@ -219,56 +175,30 @@ cd D:\work\your-project
219
175
 
220
176
  ## 适配器支持情况
221
177
 
222
- > 目前支持将本地文件传输至微信
178
+ > 目前支持将本地文件发送到微信,微信也允许发送文件给本地 cli 解析 (注意模型本身要具备处理对应文件的能力!)
223
179
 
224
180
  ![文件传输](docs/images/image-8.png)
225
181
 
226
- 微信发来的图片和普通文件也会被接收并保存到本地数据目录:
182
+ 微信发来的图片和普通文件也会被接收并保存到本地:
227
183
 
228
- - 保存位置:`~/.cli-bridge/inbound-attachments/<日期>/`
229
- - bridge 会把本地路径追加到转发给 Codex / Claude Code / OpenCode 的 prompt 中,模型可按需读取或解析这些文件;
230
- - 当前不会自动 OCR 图片,也不会自动抽取 PDF / DOCX 正文;解析动作由本地 CLI 根据路径完成。
184
+ - bridge 会将本地路径追加到转发给 Codex / Claude Code / OpenCode 的 prompt 中,模型可按需读取或解析这些文件;
185
+ - 当前不会自动 OCR 图片,也不会自动抽取 PDF / DOCX 正文;如需解析,由本地 CLI 根据路径完成。
186
+ - 具体保存位置见 [问题排查](docs/troubleshooting.md#数据目录与状态文件)。
231
187
 
232
188
  | 适配器 | 当前状态 | 说明 |
233
189
  | --- | --- | --- |
234
- | `codex` | 已接入 | 双终端模式;本地 companion 为线程权威;微信跟随本地线程 |
235
- | `claude` | 已接入 | `wechat-bridge-claude` + `wechat-claude` 的双终端 companion 模式;会话切换、最终回复与审批元数据已按 Claude session 语义同步 |
236
- | `opencode` | 已接入 | `wechat-bridge-opencode` + `wechat-opencode` 的双终端 companion 模式;支持本地 session 切换跟随,微信侧支持 `/new` / `/new-session` |
237
- | `shell` | 可用 | 持久 `powershell.exe` 会话;高风险命令支持审批 |
190
+ | `codex` | 已接入 | 双终端模式;本地 companion 作为线程权威;微信跟随本地线程 |
191
+ | `claude` | 已接入 | `wechat-bridge-claude` + `wechat-claude` 的双终端 companion 模式;会话切换、最终回复与审批元数据按 Claude session 语义同步 |
192
+ | `opencode` | 已接入 | [`OpenCode`](https://github.com/anomalyco/opencode) 适配器;`wechat-bridge-opencode` + `wechat-opencode` 的双终端 companion 模式;支持本地 session 切换跟随,微信侧支持 `/new` / `/new-session` |
238
193
 
239
194
  ### Codex 示例
240
195
 
241
- 终端 A:
242
-
243
- ```bash
244
- wechat-bridge-codex
245
- ```
246
-
247
- ![alt text](docs/images/image-1.png)
248
-
249
- 终端 B:
250
-
251
- ```bash
252
- wechat-codex
253
- ```
254
-
255
- ![alt text](docs/images/image-2.png)
256
-
257
- 然后即可:
258
-
259
- - 在微信中发送普通文本;
260
- - 在本地 `wechat-codex` 中继续原生交互;
261
- - 在本地执行 `/resume` 切线程;
262
- - 让微信自动跟随当前本地线程。
263
-
264
196
  ![Codex windows](docs/images/image-3.png)
265
197
 
266
198
  ![Codex Linux](docs/images/image-4.png)
267
199
 
268
200
  ### Claude Code 示例
269
201
 
270
- Claude Code 支持通过微信完成远程审批确认。
271
-
272
202
  ![Claude Windows](docs/images/image-6.png)
273
203
 
274
204
  ![Claude Linux](docs/images/image-7.png)
@@ -279,7 +209,7 @@ OpenCode 模式下,微信侧支持 `/new` 或 `/new-session` 创建新 session
279
209
 
280
210
  ## 命令说明
281
211
 
282
- ### 推荐全局命令
212
+ ### 常用全局命令
283
213
 
284
214
  | 类型 | 命令 |
285
215
  | --- | --- |
@@ -288,27 +218,6 @@ OpenCode 模式下,微信侧支持 `/new` 或 `/new-session` 创建新 session
288
218
  | Codex | `wechat-bridge-codex`、`wechat-codex`、`wechat-codex-start` |
289
219
  | Claude Code | `wechat-bridge-claude`、`wechat-claude`、`wechat-claude-start` |
290
220
  | OpenCode | `wechat-bridge-opencode`、`wechat-opencode`、`wechat-opencode-start` |
291
- | Shell | `wechat-bridge-shell` |
292
-
293
- ### 仓库内开发入口
294
-
295
- ```bash
296
- bun run setup
297
- bun run daemon
298
- bun run bridge:codex
299
- bun run codex:panel
300
- bun run codex:start
301
- bun run bridge:claude
302
- bun run claude:companion
303
- bun run claude:start
304
- bun run bridge:opencode
305
- bun run opencode:panel
306
- bun run opencode:start
307
- bun run bridge:shell
308
- bun run bridge:bun -- --adapter codex
309
- bun run check
310
- bun run test
311
- ```
312
221
 
313
222
  ### Daemon CLI 参数
314
223
 
@@ -328,7 +237,7 @@ wechat-daemon --adapter claude --profile work
328
237
 
329
238
  - `--cwd <path>`:指定 daemon 绑定的工作目录;
330
239
  - `--adapter <codex|claude|opencode>`:启动 daemon 后立即切换到指定 CLI;
331
- - `--profile <name-or-path>`:传给 daemon 创建的适配器;
240
+ - `--profile <name-or-path>`:传给 daemon 创建的对应适配器;
332
241
  - `--no-open`:只创建 bridge slot,不自动打开可见 CLI。
333
242
 
334
243
  ### Bridge CLI 参数
@@ -339,7 +248,6 @@ wechat-daemon --adapter claude --profile work
339
248
  - `wechat-bridge-codex`
340
249
  - `wechat-bridge-claude`
341
250
  - `wechat-bridge-opencode`
342
- - `wechat-bridge-shell`
343
251
 
344
252
  示例:
345
253
 
@@ -348,15 +256,13 @@ wechat-bridge --adapter codex --cwd D:\work\my-project
348
256
  wechat-bridge-codex --cwd D:\work\my-project
349
257
  wechat-bridge-claude --profile work
350
258
  wechat-bridge-opencode --cwd D:\work\my-project
351
- wechat-bridge-shell --cmd pwsh.exe
352
259
  wechat-bridge-codex --lifecycle companion_bound
353
260
  ```
354
261
 
355
262
  支持参数:
356
263
 
357
- - `--adapter <codex|claude|opencode|shell>`:通用入口 `wechat-bridge` 需要显式指定适配器;
264
+ - `--adapter <codex|claude|opencode>`:通用入口 `wechat-bridge` 需要显式指定适配器;
358
265
  - `--cwd <path>`:指定工作目录;
359
- - `--cmd <executable>`:覆盖默认命令;
360
266
  - `--profile <name-or-path>`:向适配器传入 profile;
361
267
  - `--lifecycle <persistent|companion_bound>`:指定 bridge 生命周期;`wechat-*-start` 会使用 `companion_bound`。
362
268
 
@@ -376,7 +282,7 @@ wechat-opencode-start --cwd D:\work\my-project
376
282
  - `--profile <name-or-path>`:转发给后台启动的 `wechat-bridge-codex` / `wechat-bridge-claude` / `wechat-bridge-opencode`;
377
283
  - `--timeout-ms <ms>`:等待当前目录 endpoint 的最长时间,默认 `15000`。
378
284
 
379
- 高级用法:除上述启动器参数外,未知参数会继续透传给可见的底层 CLI。这样可以在保留微信登录、工作区切换与 bridge 生命周期管理的同时,启用 Codex / Claude Code 自己的高级启动模式。
285
+ 高级用法:除上述启动器参数外,未知参数会继续透传给可见的底层 CLI。这样既能保留微信登录、工作区切换与 bridge 生命周期管理,也能启用 Codex / Claude Code 自己的高级启动模式。
380
286
 
381
287
  ```bash
382
288
  wechat-codex-start --yolo
@@ -385,22 +291,22 @@ wechat-claude-start --dangerously-skip-permissions
385
291
  wechat-claude-start --model sonnet --dangerously-skip-permissions
386
292
  ```
387
293
 
388
- 其中 `--yolo` 会传给 Codex;`--dangerously-skip-permissions` 会传给 Claude Code。它们只影响本地可见 CLI,不会覆盖 bridge 托管的 Codex remote 连接参数、Claude settings、微信登录状态或当前工作区锁。由于这两类参数会降低审批保护,建议只在可信工作区中使用。
294
+ 其中,`--yolo` 会传给 Codex;`--dangerously-skip-permissions` 会传给 Claude Code。它们只影响本地可见 CLI,不会覆盖 bridge 托管的 Codex remote 连接参数、Claude settings、微信登录状态或当前工作区锁。由于这两类参数会降低审批保护,建议只在可信工作区中使用。
389
295
 
390
296
  ## 微信侧支持的指令
391
297
 
392
298
  | 指令 | 说明 |
393
299
  | --- | --- |
394
- | 普通文本 | 发送给当前活动会话 |
300
+ | 普通文本 | 发送到当前活动会话 |
395
301
  | `/codex` / `/claude` / `/opencode` | daemon 模式下切换活动 CLI;已有 CLI 会复用,没有则自动打开 |
396
302
  | `/status` | 查看 bridge 当前状态 |
397
303
  | `/stop` | 中断当前任务 |
398
304
  | `/reset` | 重建当前本地会话 |
399
305
  | `/new` 或 `/new-session` | OpenCode 模式下新建 session |
400
- | `/confirm` / `/deny` | 处理 Claude Code 权限请求;shell 等需要一次性 code 的请求会在消息中提示具体确认格式 |
306
+ | `/confirm` / `/deny` | 处理 CLI 权限请求;需要一次性 code 的请求会在消息中提示具体确认格式 |
401
307
  | `/daemon-stop` | daemon 模式下停止常驻进程 |
402
308
 
403
- 说明:微信侧 `/resume` 目前仍保持禁用;需要切换 Codex / Claude / OpenCode 会话时,优先在本地 companion 中使用原生 `/resume`、`/new` 或对应 CLI 命令,微信会跟随本地活动会话。
309
+ 说明:微信侧 `/resume` 目前暂时保持禁用;需要切换 Codex / Claude / OpenCode 会话时,优先在本地 companion 中使用原生 `/resume`、`/new` 或对应 CLI 命令,微信会跟随本地活动会话。
404
310
 
405
311
  ## 工作区模型
406
312
 
@@ -408,9 +314,9 @@ wechat-claude-start --model sonnet --dangerously-skip-permissions
408
314
 
409
315
  - 从哪个目录启动 `wechat-bridge-codex` / `wechat-bridge-claude` / `wechat-bridge-opencode`,哪个目录就是当前工作区;
410
316
  - 对应的本地 companion 必须连接同一工作区;
411
- - 不同工作区的状态文件相互隔离。
317
+ - 不同工作区的运行状态相互隔离。
412
318
 
413
- 当前支持两种运行模型:
319
+ 目前支持两种运行模型:
414
320
 
415
321
  - 独立 bridge:单 owner、单 bridge、单活动工作区;
416
322
  - `wechat-daemon`:单 owner、单 daemon、绑定一个启动工作区,但可在这个工作区内同时保留 Codex / Claude Code / OpenCode 三个 CLI slot。
@@ -418,48 +324,9 @@ wechat-claude-start --model sonnet --dangerously-skip-permissions
418
324
  对 `wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 来说,这意味着:
419
325
 
420
326
  - 如果同一工作区已有 daemon,它们会委托 daemon 切换 CLI;
421
- - 如果没有 daemon,它们是**单活工作区切换器**;
327
+ - 如果没有 daemon,它们会作为**单活工作区切换器**工作;
422
328
  - 当前目录重复执行是幂等的;
423
- - 其他目录重复执行会触发工作区切换,而不是并行多开。
424
-
425
- ## 数据目录与状态文件
426
-
427
- 默认数据目录:
428
-
429
- ```text
430
- ~/.cli-bridge
431
- ```
432
-
433
- 主要文件如下:
434
-
435
- | 路径 | 作用 |
436
- | --- | --- |
437
- | `account.json` | 微信凭据 |
438
- | `sync_buf.txt` | iLink 增量同步游标 |
439
- | `context_tokens.json` | 微信上下文 token 缓存 |
440
- | `bridge.log` | bridge 运行日志 |
441
- | `bridge.lock.json` | bridge 运行锁 |
442
- | `daemon-endpoint.json` | `wechat-daemon` 本地 IPC endpoint |
443
- | `inbound-attachments/` | 微信入站图片和普通文件的本地保存目录 |
444
- | `workspaces/<workspace-key>/bridge-state.json` | 当前工作区状态 |
445
- | `workspaces/<workspace-key>/codex-panel-endpoint.json` | 当前工作区 companion endpoint;文件名保留历史兼容 |
446
- | `workspaces/<workspace-key>/<adapter>-companion-endpoint.json` | daemon / 多适配器模式下的适配器独立 companion endpoint |
447
-
448
- ### 环境变量
449
-
450
- | 变量名 | 说明 |
451
- | --- | --- |
452
- | `WECHAT_ILINK_BASE_URL` | 覆盖默认 iLink API 地址 |
453
- | `CLI_BRIDGE_DATA_DIR` | 覆盖默认数据目录 |
454
- | `WECHAT_MAX_IMAGE_MB` | 覆盖图片上传大小限制,默认 20 MB |
455
- | `WECHAT_MAX_FILE_MB` | 覆盖普通文件上传大小限制,默认 50 MB |
456
- | `WECHAT_MAX_VOICE_MB` | 覆盖语音上传大小限制,默认 20 MB |
457
- | `WECHAT_MAX_VIDEO_MB` | 覆盖视频上传大小限制,默认 100 MB |
458
- | `WECHAT_MAX_INBOUND_IMAGE_MB` | 覆盖微信入站图片下载大小限制,默认 20 MB |
459
- | `WECHAT_MAX_INBOUND_FILE_MB` | 覆盖微信入站普通文件下载大小限制,默认 50 MB |
460
- | `WECHAT_OPENCODE_DEBUG` | 开启 OpenCode 适配器调试输出 |
461
-
462
- 旧版 `CLAUDE_WECHAT_CHANNEL_DATA_DIR` 不再作为活动数据目录配置项;如旧环境中设置过该变量,它只会被视为一次性旧数据迁移来源。新的自定义目录请使用 `CLI_BRIDGE_DATA_DIR`。
329
+ - 在其他目录执行会触发工作区切换,而不是并行多开。
463
330
 
464
331
  ## 版本更新
465
332
 
@@ -481,155 +348,50 @@ wechat-check-update
481
348
 
482
349
  ### 获取最新版本
483
350
 
484
- 如果你使用 npm 全局安装,当前推荐直接执行:
351
+ 如果你使用 npm 全局安装,建议直接执行:
485
352
 
486
353
  ```bash
487
- npm install -g @unlinearity/cli-wechat-bridge@latest
354
+ npm install -g cli-wechat-bridge@latest
488
355
  ```
489
356
 
490
357
  升级后请重启正在运行的 bridge 和 companion 终端,确保它们加载同一版本。
491
358
 
492
- 如果你使用源码仓库,可以使用以下命令更新:
493
-
494
- ```bash
495
- cd CLI-WeChat-Bridge
496
- git pull
497
- bun install
498
- npm install -g .
499
- ```
500
-
501
- ## 常见问题
502
-
503
- ### 1. `wechat-codex` / `wechat-claude` / `wechat-opencode` 提示找不到 bridge
504
-
505
- 通常原因如下:
506
-
507
- - 还没有先启动对应的 `wechat-bridge-*`;
508
- - bridge 与 companion 不在同一个目录;
509
- - 当前工作区 endpoint 文件不存在或来自旧进程。
510
-
511
- 建议先确认两个终端在同一目录;如果不想手动分两个终端,可以改用对应的 `wechat-codex-start`、`wechat-claude-start` 或 `wechat-opencode-start`。
512
-
513
- ### 2. 全局命令不存在
514
-
515
- 请确认已经执行以下之一:
516
-
517
- ```bash
518
- npm install -g @unlinearity/cli-wechat-bridge@latest
519
- npm install -g .
520
- npm link
521
- ```
522
-
523
- 如果命令仍不存在,请检查 npm 全局 bin 目录是否已加入 `PATH`。
524
-
525
- ### 3. Windows 下出现 `codex.ps1` 或 PowerShell profile 警告
526
-
527
- 项目已经尽量规避 `codex.ps1`:
528
-
529
- - 优先查找 vendor `codex.exe`;
530
- - 必要时通过 `cmd.exe` 包装 `codex.cmd`。
531
-
532
- 如果本机 PowerShell profile 本身受执行策略限制,终端仍可能打印相关警告。这通常不是 bridge 本身故障。
533
-
534
- ### 4. 微信上提示没有 context token
535
-
536
- 通常表示当前联系人还没有建立可用的 iLink 上下文。一般先由 owner 账号发送一条普通消息即可建立上下文。
537
-
538
- ### 5. `codex is still working...`
539
-
540
- 该提示只应在当前确实存在活动任务时出现。
541
-
542
- 如果偶发出现:
543
-
544
- 1. 先确认本地 `wechat-codex` 是否真的仍在执行任务;
545
- 2. 必要时使用 `/stop`;
546
- 3. 检查:
547
-
548
- ```text
549
- ~/.cli-bridge/bridge.log
550
- ```
551
-
552
- ### 6. 本地 `/resume` 后微信不同步
553
-
554
- 请优先确认:`wechat-bridge-codex` 与 `wechat-codex` 是否都已重启到同一版本。
555
-
556
- 部分设备可能存在第一次本地输入不同步到微信的情况,可以先微信发送指令来建立连接。
557
-
558
- ### 7. `wechat_send_failed` 或 `UND_ERR_CONNECT_TIMEOUT`
559
-
560
- 如果 `bridge-state.json` 看起来正常,但微信仍然没有收到回复,优先检查:
561
-
562
- ```text
563
- ~/.cli-bridge/bridge.log
564
- ```
565
-
566
- 如果日志中出现 `wechat_send_failed`、`UND_ERR_CONNECT_TIMEOUT` 或 `ilinkai.weixin.qq.com:443`,通常是 bridge 到 iLink 的出站网络或代理问题,而不是本地 CLI 没有完成任务。请确认当前终端是否继承 `HTTP_PROXY`、`HTTPS_PROXY`、`ALL_PROXY`,以及 Node 是否需要 `NODE_OPTIONS=--use-env-proxy`。
567
-
568
- ## 已知限制
569
-
570
- - 微信 `/resume` 暂时被禁用(可能导致对话双向不稳定)
571
- - Codex 不支持底层任务的远程审批!建议给好权限,正常使用,几乎不会主动请求较为低级的远程审批;Claude Code 支持远程审批,但是测试的不够,如有问题可以提 issue。
572
- - `wechat-daemon` v1 绑定启动工作区;暂不支持从微信切换到另一个本地目录。
573
-
574
- ## 开发说明
575
-
576
- ### 主要入口
577
-
578
- | 文件 | 作用 |
579
- | --- | --- |
580
- | `src/bridge/wechat-bridge.ts` | bridge 主事件循环 |
581
- | `src/daemon/wechat-daemon.ts` | 常驻 WeChat daemon 与多 CLI slot 管理 |
582
- | `src/daemon/daemon-link.ts` | daemon 本地 IPC endpoint 与请求协议 |
583
- | `src/bridge/bridge-adapters.ts` | `codex` / `claude` / `opencode` / `shell` 适配器入口 |
584
- | `src/bridge/bridge-adapters.opencode.ts` | OpenCode 适配器实现 |
585
- | `src/companion/local-companion.ts` | `wechat-claude` / `wechat-opencode` 本地 companion 入口 |
586
- | `src/companion/codex-remote-client.ts` | `wechat-codex` 本地客户端入口 |
587
- | `src/companion/local-companion-start.ts` | `wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 单命令启动入口 |
588
- | `src/wechat/wechat-transport.ts` | iLink 消息收发 |
589
- | `src/bridge/bridge-state.ts` | bridge 状态、锁与日志 |
590
- | `src/wechat/setup.ts` | 登录与凭据初始化 |
591
-
592
- ### 测试
593
-
594
- ```bash
595
- bun test
596
- ```
597
-
598
- 也可以按目录运行:
359
+ ## 致谢
599
360
 
600
- ```bash
601
- bun run test:bridge
602
- bun run test:companion
603
- bun run test:wechat
604
- ```
361
+ ### 感谢支持
605
362
 
606
- 当前测试主要覆盖:
363
+ > 感谢 issue 反馈者和 PR 贡献者。
607
364
 
608
- - Windows 启动解析
609
- - Codex 线程跟随
610
- - session log fallback
611
- - panel / busy / completion recovery
612
- - 工作区路径与状态隔离
365
+ 创作不易,如果觉得它有帮助或有意思,可以请喝杯奶茶。❤️
613
366
 
614
- ## 致谢
367
+ <p align='center'><img src='docs/images/wechat-tip.png' width=60%></p>
615
368
 
616
369
  ### 相关链接
617
370
 
618
- - [Linux DO](https://linux.do/):学AI,上L站!
619
- - [openclaw-weixin](https://github.com/hao-ji-xing/openclaw-weixin):支持Claude Code Channel,感谢如此迅速的开源。
620
- - [@modelcontextprotocol/sdk](https://github.com/modelcontextprotocol/typescript-sdk):TypeScript 版 MCP SDK
371
+ 主要依赖:
372
+
373
+ - [@opencode-ai/sdk](https://www.npmjs.com/package/@opencode-ai/sdk):OpenCode session 和事件流客户端
374
+ - [@modelcontextprotocol/sdk](https://github.com/modelcontextprotocol/typescript-sdk):MCP server 入口使用的 TypeScript SDK
621
375
  - [node-pty](https://github.com/microsoft/node-pty):本地 PTY / ConPTY 进程桥接
622
- - [@anthropic-ai/sdk](https://github.com/anthropics/anthropic-sdk-typescript):Anthropic TypeScript SDK
623
376
  - [qrcode-terminal](https://github.com/gtanner/qrcode-terminal):终端二维码输出
624
377
 
625
- ### 感谢支持
378
+ 运行与开发基础:
626
379
 
627
- > 感谢 issue 反馈者 和 pr 贡献者。
380
+ - [Node.js](https://nodejs.org/):运行发布包和 CLI 入口
381
+ - [TypeScript](https://www.typescriptlang.org/):源码语言和构建工具链
382
+ - [Bun](https://bun.sh/):源码模式运行与测试工具
383
+ - [ESLint](https://eslint.org/):代码检查
628
384
 
629
- 创作不易,如感觉对您有帮助、觉得有意思,可以请喝杯奶茶。❤️
385
+ 社区与参考:
630
386
 
631
- <p align='center'><img src='docs\images\wechat-tip.png' width=60%></p>
387
+ - [Linux DO](https://linux.do/):学 AI,上 L 站!
388
+ - [@tencent-weixin/openclaw-weixin](https://www.npmjs.com/package/@tencent-weixin/openclaw-weixin):腾讯微信团队发布的 OpenClaw Weixin channel npm 包
389
+ - [openclaw-weixin](https://github.com/hao-ji-xing/openclaw-weixin):早期 WeChat / Claude Code Channel 参考项目。
632
390
 
633
391
  ## License
634
392
 
635
393
  [MIT](LICENSE.txt)
394
+
395
+ <p align="center">
396
+ <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=UNLINEARITY/CLI-WeChat-Bridge&type=timeline&legend=top-left">
397
+ </p>