cli-wechat-bridge 1.0.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/LICENSE.txt +21 -0
- package/README.md +637 -0
- package/bin/_run-entry.mjs +35 -0
- package/bin/wechat-bridge-claude.mjs +5 -0
- package/bin/wechat-bridge-codex.mjs +5 -0
- package/bin/wechat-bridge-opencode.mjs +5 -0
- package/bin/wechat-bridge-shell.mjs +5 -0
- package/bin/wechat-bridge.mjs +5 -0
- package/bin/wechat-check-update.mjs +5 -0
- package/bin/wechat-claude-start.mjs +5 -0
- package/bin/wechat-claude.mjs +5 -0
- package/bin/wechat-codex-start.mjs +5 -0
- package/bin/wechat-codex.mjs +5 -0
- package/bin/wechat-daemon.mjs +5 -0
- package/bin/wechat-opencode-start.mjs +5 -0
- package/bin/wechat-opencode.mjs +5 -0
- package/bin/wechat-setup.mjs +5 -0
- package/dist/bridge/bridge-adapter-common.js +95 -0
- package/dist/bridge/bridge-adapters.claude.js +829 -0
- package/dist/bridge/bridge-adapters.codex.js +2228 -0
- package/dist/bridge/bridge-adapters.core.js +717 -0
- package/dist/bridge/bridge-adapters.js +26 -0
- package/dist/bridge/bridge-adapters.opencode.js +2129 -0
- package/dist/bridge/bridge-adapters.shared.js +1005 -0
- package/dist/bridge/bridge-adapters.shell.js +363 -0
- package/dist/bridge/bridge-controller.js +48 -0
- package/dist/bridge/bridge-final-reply.js +46 -0
- package/dist/bridge/bridge-process-reaper.js +348 -0
- package/dist/bridge/bridge-state.js +362 -0
- package/dist/bridge/bridge-types.js +1 -0
- package/dist/bridge/bridge-utils.js +1240 -0
- package/dist/bridge/claude-hook.js +82 -0
- package/dist/bridge/claude-hooks.js +267 -0
- package/dist/bridge/wechat-bridge.js +1026 -0
- package/dist/commands/check-update.js +30 -0
- package/dist/companion/codex-panel-link.js +72 -0
- package/dist/companion/codex-panel.js +179 -0
- package/dist/companion/codex-remote-client.js +124 -0
- package/dist/companion/local-companion-link.js +240 -0
- package/dist/companion/local-companion-start.js +420 -0
- package/dist/companion/local-companion.js +424 -0
- package/dist/daemon/daemon-link.js +175 -0
- package/dist/daemon/wechat-daemon.js +1202 -0
- package/dist/media/media-types.js +1 -0
- package/dist/runtime/create-runtime-host.js +12 -0
- package/dist/runtime/legacy-adapter-runtime.js +46 -0
- package/dist/runtime/runtime-types.js +5 -0
- package/dist/utils/version-checker.js +161 -0
- package/dist/wechat/channel-config.js +196 -0
- package/dist/wechat/setup.js +283 -0
- package/dist/wechat/standalone-bot.js +355 -0
- package/dist/wechat/wechat-channel.js +492 -0
- package/dist/wechat/wechat-transport.js +1213 -0
- package/package.json +101 -0
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 unlinearity
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,637 @@
|
|
|
1
|
+
# CLI WeChat Bridge
|
|
2
|
+
|
|
3
|
+
<p align='center'><img src='docs/images/logo.png' width=90%></p>
|
|
4
|
+
|
|
5
|
+
<p align="center"><img alt="Typing SVG" src="https://readme-typing-svg.herokuapp.com?font=JetBrains+Mono&weight=600&duration=4000&pause=500&color=06C763&center=true&vCenter=true&width=660&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
|
+
|
|
7
|
+
<p align="center">
|
|
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&style=for-the-badge&logo=github&color=0891b2&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&style=for-the-badge&logo=npm&color=cb3837&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&style=for-the-badge&logo=npm&color=16a34a&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&style=for-the-badge&color=7c3aed&labelColor=1c1917"></a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
**命令行工具的微信桥接**:本项目用于桥接微信消息与本地运行的 [`Codex`](https://github.com/openai/codex)、[`Claude Code`](https://code.claude.com/docs/en/overview)、`OpenCode` 或持久化 `powershell.exe` 会话,并将本地输出、审批请求与运行状态同步回微信。
|
|
15
|
+
|
|
16
|
+
当前实现以本地工作流为中心展开,重点是保留**本地原生终端体验**,支持原生使用以及高级参数注入,并在此基础上提供微信侧的远程输入、结果回流与状态同步能力。
|
|
17
|
+
|
|
18
|
+
<p align='center'><img src='docs/images/animation.webp' width=90%></p>
|
|
19
|
+
|
|
20
|
+
## 这个项目解决什么问题
|
|
21
|
+
|
|
22
|
+
本项目面向这样一类使用场景:
|
|
23
|
+
|
|
24
|
+
- 你的主工作流仍在本地终端中进行;
|
|
25
|
+
- 你希望继续使用原生 `codex` 或其他 CLI 工具,而不是迁移到网页或托管机器人;
|
|
26
|
+
- 你希望在离开电脑时,仍能通过微信向本地会话发送请求,并接收必要的输出、与状态同步。
|
|
27
|
+
|
|
28
|
+
当前项目并不试图把微信变成新的主工作界面。相反,它的定位是:
|
|
29
|
+
|
|
30
|
+
- 本地 CLI 仍然是主工作界面,并保持原生的使用逻辑;
|
|
31
|
+
- 微信是远程入口,允许远程接入;
|
|
32
|
+
- 会话一致性、线程状态和审批流仍以**本地会话为中心**。
|
|
33
|
+
|
|
34
|
+
## 快速开始
|
|
35
|
+
|
|
36
|
+
### 1. 环境要求
|
|
37
|
+
|
|
38
|
+
- [Node.js](https://nodejs.org/en/download) `>= 24.0.0`(建议直接安装官网 LTS 版本)
|
|
39
|
+
- [Bun](https://bun.sh/docs/installation) `>= 1.0.0` (开发者需要,普通用户无需安装)
|
|
40
|
+
- 已安装以下至少一种本地 CLI:(最好更新至最新版本)
|
|
41
|
+
- [Codex](https://github.com/openai/codex)
|
|
42
|
+
- [Claude Code](https://code.claude.com/docs/en/overview)
|
|
43
|
+
- OpenCode
|
|
44
|
+
- powershell.exe
|
|
45
|
+
|
|
46
|
+
### 2. 安装
|
|
47
|
+
|
|
48
|
+
正式版本可以直接从 npm 安装:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm install -g cli-wechat-bridge@latest
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
安装后可在任意项目目录中直接使用 `wechat-daemon`、`wechat-codex-start`、`wechat-claude-start`、`wechat-opencode-start` 等命令。
|
|
55
|
+
|
|
56
|
+
兼容说明:旧包名 `@unlinearity/cli-wechat-bridge` 会继续同步发布,已经安装旧包名的用户可以正常升级;新用户优先使用更短的 `cli-wechat-bridge`。
|
|
57
|
+
|
|
58
|
+
如果你希望从源码运行或参与开发,也可以克隆仓库并安装依赖:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
git clone https://github.com/UNLINEARITY/CLI-WeChat-Bridge
|
|
62
|
+
cd CLI-WeChat-Bridge
|
|
63
|
+
bun install
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
如果使用源码仓库,希望将当前工作区安装为全局命令:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npm install -g .
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
开发阶段也可以使用:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npm link
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
说明:
|
|
79
|
+
|
|
80
|
+
- `npm link` 会让全局命令直接指向当前仓库源码;
|
|
81
|
+
- `npm install -g .` 会安装一份当前仓库的复制版本;后续代码更新后需要重新执行一次。
|
|
82
|
+
|
|
83
|
+
如果你想把当前本地源码构建出的包安装到真实全局环境,并在任意目录人工验证,可以直接运行:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npm run smoke:global
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
这个脚本会先用当前源码打出真实 npm tarball,再执行 `npm install -g <tarball>` 安装到真实全局环境;脚本结束后,你可以离开仓库目录运行 `wechat-codex-start` 等命令。如果你想先清理缓存、卸载当前全局包,或者顺便跑完整质量门禁,可以加上这些参数:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
npm run smoke:global -- --purge-global --clean-cache --full
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
- `--clean-cache`:先执行 `npm cache clean --force`
|
|
96
|
+
- `--purge-global`:先卸载当前真实全局包
|
|
97
|
+
- `--full`:额外执行 `npm run quality`
|
|
98
|
+
- `--keep-tarball`:保留生成的 tarball,方便排查
|
|
99
|
+
|
|
100
|
+
### 3. 完成微信登录
|
|
101
|
+
|
|
102
|
+
npm 全局安装后可以直接运行:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
wechat-setup
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
如果是在 clone 的仓库目录下,也可以运行:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
bun run setup # 绑定微信 ClawBot
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
该流程会:
|
|
115
|
+
|
|
116
|
+
1. 获取微信登录二维码;
|
|
117
|
+
2. 在终端打印二维码;
|
|
118
|
+
3. 等待你在微信中扫码并确认;
|
|
119
|
+
4. 将 bot 凭据写入本地数据目录。
|
|
120
|
+
|
|
121
|
+

|
|
122
|
+
|
|
123
|
+
默认凭据文件路径:
|
|
124
|
+
|
|
125
|
+
```text
|
|
126
|
+
~/.cli-bridge/account.json
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
登录成功后会清理旧的 `sync_buf.txt` 和 `context_tokens.json`,避免旧会话状态污染新的登录状态。
|
|
130
|
+
|
|
131
|
+
从旧版本升级时,bridge 会自动从旧的 `~/.claude/channels/wechat` 迁移数据到 `~/.cli-bridge`,包括登录凭据、同步游标、上下文 token、工作区状态和已接收附件;已有的新目录文件不会被覆盖,旧目录也会原样保留。旧运行锁不会迁移,旧 `bridge.log` 会保存为 `legacy-bridge.log`,避免覆盖新的运行日志。
|
|
132
|
+
|
|
133
|
+
如果是首次安装或微信登录已过期,`wechat-codex-start`、`wechat-claude-start`、`wechat-opencode-start` 也会在前台提示扫码登录。
|
|
134
|
+
|
|
135
|
+
### 4. 先从微信发一条同步消息(重要)
|
|
136
|
+
|
|
137
|
+
启动 bridge 后,建议先在微信里向 Bot 发送一条消息,例如 `hello`、你要执行的任务或任意一句话。这样 bridge 能拿到最新的微信会话 `context_token`,之后本地终端里的输入、最终回复和审批提示才能稳定同步回微信。
|
|
138
|
+
|
|
139
|
+
如果冷启动或长时间闲置后直接从本地终端先发消息,bridge 通常仍会捕获这条本地输入并交给 Codex / Claude Code / OpenCode 处理,但微信侧出站发送可能因为旧的 `context_token` 失效而失败。表现就是:本地已经有回复,微信暂时收不到;等你先从微信发来一条消息后,后续双向同步就能恢复正常。
|
|
140
|
+
|
|
141
|
+
### 5. 常驻 daemon 模式(推荐用于多 CLI 切换)
|
|
142
|
+
|
|
143
|
+
如果你希望微信连接长期保持在线,并在 Codex / Claude Code / OpenCode 之间来回切换,推荐在项目目录启动一个统一 daemon:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
cd D:\work\your-project
|
|
147
|
+
wechat-daemon
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
启动后,在微信里发送以下指令即可选择当前活动终端:
|
|
151
|
+
|
|
152
|
+
| 指令 | 行为 |
|
|
153
|
+
| --- | --- |
|
|
154
|
+
| `/codex` | 切换到 Codex |
|
|
155
|
+
| `/claude` | 切换到 Claude Code |
|
|
156
|
+
| `/opencode` | 切换到 OpenCode |
|
|
157
|
+
|
|
158
|
+
daemon 启动后,后续切换都可以直接从微信发起;如果对应 CLI 还没有可见窗口,daemon 会自动打开或复用它,不需要再手动运行 `wechat-codex`、`wechat-claude` 或 `wechat-opencode`。
|
|
159
|
+
|
|
160
|
+
daemon 的 v1 行为是:
|
|
161
|
+
|
|
162
|
+
- daemon 绑定启动时的工作目录;暂不支持在微信里切换工作目录;
|
|
163
|
+
- 启动时会自动接管并清理旧的单 bridge 进程、失效 lock 和旧 endpoint;
|
|
164
|
+
- 切换适配器不会关闭之前的 CLI;
|
|
165
|
+
- 如果对应适配器已经有可见 CLI 在运行,则直接复用;
|
|
166
|
+
- 如果还没有对应 CLI,daemon 会自动打开一个新的可见终端;
|
|
167
|
+
- Codex / Claude / OpenCode 的重要输出都会带上 `[codex]`、`[claude]`、`[opencode]` 标签再发回微信;
|
|
168
|
+
- 可以在微信发送 `/daemon-stop` 停止 daemon。
|
|
169
|
+
|
|
170
|
+
也可以启动时直接打开某个初始 CLI:
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
wechat-daemon --adapter codex
|
|
174
|
+
wechat-daemon --adapter claude --profile work
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
当同一工作目录已有 `wechat-daemon` 在运行时,`wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 会自动委托给 daemon:请求 daemon 切到对应 CLI,并在需要时打开可见终端,而不是停止 daemon 或关闭其他 CLI。
|
|
178
|
+
|
|
179
|
+
### 6. 单命令启动桥接(兼容模式)
|
|
180
|
+
|
|
181
|
+
先进入你要操作的项目目录:
|
|
182
|
+
|
|
183
|
+
```bash
|
|
184
|
+
cd D:\work\your-project
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
推荐直接选择一个单命令入口:
|
|
188
|
+
|
|
189
|
+
| 使用的本地 CLI | 启动命令 |
|
|
190
|
+
| --- | --- |
|
|
191
|
+
| Codex | `wechat-codex-start` |
|
|
192
|
+
| Claude Code | `wechat-claude-start` |
|
|
193
|
+
| OpenCode | `wechat-opencode-start` |
|
|
194
|
+
|
|
195
|
+
三者会自动完成以下动作:
|
|
196
|
+
|
|
197
|
+
1. 校验或刷新微信登录凭据;
|
|
198
|
+
2. 如果当前目录已有 `wechat-daemon`,则委托 daemon 切换到对应 CLI;
|
|
199
|
+
3. 如果没有 daemon,则复用当前目录已运行的 bridge,或在当前目录启动新的 bridge;
|
|
200
|
+
4. 如果独立 bridge 正在服务其他目录,则停止旧 bridge 并切换到当前目录;
|
|
201
|
+
5. 等待当前目录对应的本地 companion endpoint 就绪;
|
|
202
|
+
6. 打开可见的本地 CLI 会话。
|
|
203
|
+
|
|
204
|
+
在没有 daemon 时,`wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 仍按**单活工作区切换器**工作:
|
|
205
|
+
|
|
206
|
+
- 同一时间只有一个项目与微信对话;
|
|
207
|
+
- 在当前目录重复执行是幂等的;
|
|
208
|
+
- 如果当前目录已经有可见 companion / panel 在运行,则不会重复打开第二个窗口;
|
|
209
|
+
- 如果检测到可见端仍在但 worker 状态异常(如 `stopped` / `error`),会自动重启 bridge 再重新打开可见端;
|
|
210
|
+
- 在其他目录执行会显式切换活动工作区。
|
|
211
|
+
|
|
212
|
+
### 7. 手动双终端模式(调试开发)
|
|
213
|
+
|
|
214
|
+
如果你希望明确观察 bridge 与本地 CLI companion,也可以分两个终端启动。
|
|
215
|
+
|
|
216
|
+
| 适配器 | 终端 A:bridge | 终端 B:本地 companion |
|
|
217
|
+
| --- | --- | --- |
|
|
218
|
+
| Codex | `wechat-bridge-codex` | `wechat-codex` |
|
|
219
|
+
| Claude Code | `wechat-bridge-claude` | `wechat-claude` |
|
|
220
|
+
| OpenCode | `wechat-bridge-opencode` | `wechat-opencode` |
|
|
221
|
+
|
|
222
|
+
## 适配器支持情况
|
|
223
|
+
|
|
224
|
+
> 目前支持将本地文件传输至微信
|
|
225
|
+
|
|
226
|
+

|
|
227
|
+
|
|
228
|
+
微信发来的图片和普通文件也会被接收并保存到本地数据目录:
|
|
229
|
+
|
|
230
|
+
- 保存位置:`~/.cli-bridge/inbound-attachments/<日期>/`
|
|
231
|
+
- bridge 会把本地路径追加到转发给 Codex / Claude Code / OpenCode 的 prompt 中,模型可按需读取或解析这些文件;
|
|
232
|
+
- 当前不会自动 OCR 图片,也不会自动抽取 PDF / DOCX 正文;解析动作由本地 CLI 根据路径完成。
|
|
233
|
+
|
|
234
|
+
| 适配器 | 当前状态 | 说明 |
|
|
235
|
+
| --- | --- | --- |
|
|
236
|
+
| `codex` | 已接入 | 双终端模式;本地 companion 为线程权威;微信跟随本地线程 |
|
|
237
|
+
| `claude` | 已接入 | `wechat-bridge-claude` + `wechat-claude` 的双终端 companion 模式;会话切换、最终回复与审批元数据已按 Claude session 语义同步 |
|
|
238
|
+
| `opencode` | 已接入 | `wechat-bridge-opencode` + `wechat-opencode` 的双终端 companion 模式;支持本地 session 切换跟随,微信侧支持 `/new` / `/new-session` |
|
|
239
|
+
| `shell` | 可用 | 持久 `powershell.exe` 会话;高风险命令支持审批 |
|
|
240
|
+
|
|
241
|
+
### Codex 示例
|
|
242
|
+
|
|
243
|
+
终端 A:
|
|
244
|
+
|
|
245
|
+
```bash
|
|
246
|
+
wechat-bridge-codex
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+

|
|
250
|
+
|
|
251
|
+
终端 B:
|
|
252
|
+
|
|
253
|
+
```bash
|
|
254
|
+
wechat-codex
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+

|
|
258
|
+
|
|
259
|
+
然后即可:
|
|
260
|
+
|
|
261
|
+
- 在微信中发送普通文本;
|
|
262
|
+
- 在本地 `wechat-codex` 中继续原生交互;
|
|
263
|
+
- 在本地执行 `/resume` 切线程;
|
|
264
|
+
- 让微信自动跟随当前本地线程。
|
|
265
|
+
|
|
266
|
+

|
|
267
|
+
|
|
268
|
+

|
|
269
|
+
|
|
270
|
+
### Claude Code 示例
|
|
271
|
+
|
|
272
|
+
Claude Code 支持通过微信完成远程审批确认。
|
|
273
|
+
|
|
274
|
+

|
|
275
|
+
|
|
276
|
+

|
|
277
|
+
|
|
278
|
+
### OpenCode 示例
|
|
279
|
+
|
|
280
|
+
OpenCode 模式下,微信侧支持 `/new` 或 `/new-session` 创建新 session;如果在本地 OpenCode CLI 中创建新 session,微信消息也会跟随新的 session。
|
|
281
|
+
|
|
282
|
+
## 命令说明
|
|
283
|
+
|
|
284
|
+
### 推荐全局命令
|
|
285
|
+
|
|
286
|
+
| 类型 | 命令 |
|
|
287
|
+
| --- | --- |
|
|
288
|
+
| 登录与更新 | `wechat-setup`、`wechat-check-update` |
|
|
289
|
+
| 常驻 daemon | `wechat-daemon` |
|
|
290
|
+
| Codex | `wechat-bridge-codex`、`wechat-codex`、`wechat-codex-start` |
|
|
291
|
+
| Claude Code | `wechat-bridge-claude`、`wechat-claude`、`wechat-claude-start` |
|
|
292
|
+
| OpenCode | `wechat-bridge-opencode`、`wechat-opencode`、`wechat-opencode-start` |
|
|
293
|
+
| Shell | `wechat-bridge-shell` |
|
|
294
|
+
|
|
295
|
+
### 仓库内开发入口
|
|
296
|
+
|
|
297
|
+
```bash
|
|
298
|
+
bun run setup
|
|
299
|
+
bun run daemon
|
|
300
|
+
bun run bridge:codex
|
|
301
|
+
bun run codex:panel
|
|
302
|
+
bun run codex:start
|
|
303
|
+
bun run bridge:claude
|
|
304
|
+
bun run claude:companion
|
|
305
|
+
bun run claude:start
|
|
306
|
+
bun run bridge:opencode
|
|
307
|
+
bun run opencode:panel
|
|
308
|
+
bun run opencode:start
|
|
309
|
+
bun run bridge:shell
|
|
310
|
+
bun run bridge:bun -- --adapter codex
|
|
311
|
+
bun run check
|
|
312
|
+
bun run test
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Daemon CLI 参数
|
|
316
|
+
|
|
317
|
+
适用于:
|
|
318
|
+
|
|
319
|
+
- `wechat-daemon`
|
|
320
|
+
|
|
321
|
+
示例:
|
|
322
|
+
|
|
323
|
+
```bash
|
|
324
|
+
wechat-daemon --cwd D:\work\my-project
|
|
325
|
+
wechat-daemon --adapter codex
|
|
326
|
+
wechat-daemon --adapter claude --profile work
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
支持参数:
|
|
330
|
+
|
|
331
|
+
- `--cwd <path>`:指定 daemon 绑定的工作目录;
|
|
332
|
+
- `--adapter <codex|claude|opencode>`:启动 daemon 后立即切换到指定 CLI;
|
|
333
|
+
- `--profile <name-or-path>`:传给 daemon 创建的适配器;
|
|
334
|
+
- `--no-open`:只创建 bridge slot,不自动打开可见 CLI。
|
|
335
|
+
|
|
336
|
+
### Bridge CLI 参数
|
|
337
|
+
|
|
338
|
+
适用于:
|
|
339
|
+
|
|
340
|
+
- `wechat-bridge`
|
|
341
|
+
- `wechat-bridge-codex`
|
|
342
|
+
- `wechat-bridge-claude`
|
|
343
|
+
- `wechat-bridge-opencode`
|
|
344
|
+
- `wechat-bridge-shell`
|
|
345
|
+
|
|
346
|
+
示例:
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
wechat-bridge --adapter codex --cwd D:\work\my-project
|
|
350
|
+
wechat-bridge-codex --cwd D:\work\my-project
|
|
351
|
+
wechat-bridge-claude --profile work
|
|
352
|
+
wechat-bridge-opencode --cwd D:\work\my-project
|
|
353
|
+
wechat-bridge-shell --cmd pwsh.exe
|
|
354
|
+
wechat-bridge-codex --lifecycle companion_bound
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
支持参数:
|
|
358
|
+
|
|
359
|
+
- `--adapter <codex|claude|opencode|shell>`:通用入口 `wechat-bridge` 需要显式指定适配器;
|
|
360
|
+
- `--cwd <path>`:指定工作目录;
|
|
361
|
+
- `--cmd <executable>`:覆盖默认命令;
|
|
362
|
+
- `--profile <name-or-path>`:向适配器传入 profile;
|
|
363
|
+
- `--lifecycle <persistent|companion_bound>`:指定 bridge 生命周期;`wechat-*-start` 会使用 `companion_bound`。
|
|
364
|
+
|
|
365
|
+
### `wechat-*-start` 参数
|
|
366
|
+
|
|
367
|
+
示例:
|
|
368
|
+
|
|
369
|
+
```bash
|
|
370
|
+
wechat-codex-start --cwd D:\work\my-project
|
|
371
|
+
wechat-claude-start --profile work
|
|
372
|
+
wechat-opencode-start --cwd D:\work\my-project
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
支持参数:
|
|
376
|
+
|
|
377
|
+
- `--cwd <path>`:显式指定 bridge / companion 对应的工作目录;
|
|
378
|
+
- `--profile <name-or-path>`:转发给后台启动的 `wechat-bridge-codex` / `wechat-bridge-claude` / `wechat-bridge-opencode`;
|
|
379
|
+
- `--timeout-ms <ms>`:等待当前目录 endpoint 的最长时间,默认 `15000`。
|
|
380
|
+
|
|
381
|
+
高级用法:除上述启动器参数外,未知参数会继续透传给可见的底层 CLI。这样可以在保留微信登录、工作区切换与 bridge 生命周期管理的同时,启用 Codex / Claude Code 自己的高级启动模式。
|
|
382
|
+
|
|
383
|
+
```bash
|
|
384
|
+
wechat-codex-start --yolo
|
|
385
|
+
wechat-codex-start --model gpt-5.2 --yolo
|
|
386
|
+
wechat-claude-start --dangerously-skip-permissions
|
|
387
|
+
wechat-claude-start --model sonnet --dangerously-skip-permissions
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
其中 `--yolo` 会传给 Codex;`--dangerously-skip-permissions` 会传给 Claude Code。它们只影响本地可见 CLI,不会覆盖 bridge 托管的 Codex remote 连接参数、Claude settings、微信登录状态或当前工作区锁。由于这两类参数会降低审批保护,建议只在可信工作区中使用。
|
|
391
|
+
|
|
392
|
+
## 微信侧支持的指令
|
|
393
|
+
|
|
394
|
+
| 指令 | 说明 |
|
|
395
|
+
| --- | --- |
|
|
396
|
+
| 普通文本 | 发送给当前活动会话 |
|
|
397
|
+
| `/codex` / `/claude` / `/opencode` | daemon 模式下切换活动 CLI;已有 CLI 会复用,没有则自动打开 |
|
|
398
|
+
| `/status` | 查看 bridge 当前状态 |
|
|
399
|
+
| `/stop` | 中断当前任务 |
|
|
400
|
+
| `/reset` | 重建当前本地会话 |
|
|
401
|
+
| `/new` 或 `/new-session` | OpenCode 模式下新建 session |
|
|
402
|
+
| `/confirm` / `/deny` | 处理 Claude Code 权限请求;shell 等需要一次性 code 的请求会在消息中提示具体确认格式 |
|
|
403
|
+
| `/daemon-stop` | daemon 模式下停止常驻进程 |
|
|
404
|
+
|
|
405
|
+
说明:微信侧 `/resume` 目前仍保持禁用;需要切换 Codex / Claude / OpenCode 会话时,优先在本地 companion 中使用原生 `/resume`、`/new` 或对应 CLI 命令,微信会跟随本地活动会话。
|
|
406
|
+
|
|
407
|
+
## 工作区模型
|
|
408
|
+
|
|
409
|
+
本项目采用“当前目录即当前工作区”的模型:
|
|
410
|
+
|
|
411
|
+
- 从哪个目录启动 `wechat-bridge-codex` / `wechat-bridge-claude` / `wechat-bridge-opencode`,哪个目录就是当前工作区;
|
|
412
|
+
- 对应的本地 companion 必须连接同一工作区;
|
|
413
|
+
- 不同工作区的状态文件相互隔离。
|
|
414
|
+
|
|
415
|
+
当前支持两种运行模型:
|
|
416
|
+
|
|
417
|
+
- 独立 bridge:单 owner、单 bridge、单活动工作区;
|
|
418
|
+
- `wechat-daemon`:单 owner、单 daemon、绑定一个启动工作区,但可在这个工作区内同时保留 Codex / Claude Code / OpenCode 三个 CLI slot。
|
|
419
|
+
|
|
420
|
+
对 `wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 来说,这意味着:
|
|
421
|
+
|
|
422
|
+
- 如果同一工作区已有 daemon,它们会委托 daemon 切换 CLI;
|
|
423
|
+
- 如果没有 daemon,它们是**单活工作区切换器**;
|
|
424
|
+
- 当前目录重复执行是幂等的;
|
|
425
|
+
- 其他目录重复执行会触发工作区切换,而不是并行多开。
|
|
426
|
+
|
|
427
|
+
## 数据目录与状态文件
|
|
428
|
+
|
|
429
|
+
默认数据目录:
|
|
430
|
+
|
|
431
|
+
```text
|
|
432
|
+
~/.cli-bridge
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
主要文件如下:
|
|
436
|
+
|
|
437
|
+
| 路径 | 作用 |
|
|
438
|
+
| --- | --- |
|
|
439
|
+
| `account.json` | 微信凭据 |
|
|
440
|
+
| `sync_buf.txt` | iLink 增量同步游标 |
|
|
441
|
+
| `context_tokens.json` | 微信上下文 token 缓存 |
|
|
442
|
+
| `bridge.log` | bridge 运行日志 |
|
|
443
|
+
| `bridge.lock.json` | bridge 运行锁 |
|
|
444
|
+
| `daemon-endpoint.json` | `wechat-daemon` 本地 IPC endpoint |
|
|
445
|
+
| `inbound-attachments/` | 微信入站图片和普通文件的本地保存目录 |
|
|
446
|
+
| `workspaces/<workspace-key>/bridge-state.json` | 当前工作区状态 |
|
|
447
|
+
| `workspaces/<workspace-key>/codex-panel-endpoint.json` | 当前工作区 companion endpoint;文件名保留历史兼容 |
|
|
448
|
+
| `workspaces/<workspace-key>/<adapter>-companion-endpoint.json` | daemon / 多适配器模式下的适配器独立 companion endpoint |
|
|
449
|
+
|
|
450
|
+
### 环境变量
|
|
451
|
+
|
|
452
|
+
| 变量名 | 说明 |
|
|
453
|
+
| --- | --- |
|
|
454
|
+
| `WECHAT_ILINK_BASE_URL` | 覆盖默认 iLink API 地址 |
|
|
455
|
+
| `CLI_BRIDGE_DATA_DIR` | 覆盖默认数据目录 |
|
|
456
|
+
| `WECHAT_MAX_IMAGE_MB` | 覆盖图片上传大小限制,默认 20 MB |
|
|
457
|
+
| `WECHAT_MAX_FILE_MB` | 覆盖普通文件上传大小限制,默认 50 MB |
|
|
458
|
+
| `WECHAT_MAX_VOICE_MB` | 覆盖语音上传大小限制,默认 20 MB |
|
|
459
|
+
| `WECHAT_MAX_VIDEO_MB` | 覆盖视频上传大小限制,默认 100 MB |
|
|
460
|
+
| `WECHAT_MAX_INBOUND_IMAGE_MB` | 覆盖微信入站图片下载大小限制,默认 20 MB |
|
|
461
|
+
| `WECHAT_MAX_INBOUND_FILE_MB` | 覆盖微信入站普通文件下载大小限制,默认 50 MB |
|
|
462
|
+
| `WECHAT_OPENCODE_DEBUG` | 开启 OpenCode 适配器调试输出 |
|
|
463
|
+
|
|
464
|
+
旧版 `CLAUDE_WECHAT_CHANNEL_DATA_DIR` 不再作为活动数据目录配置项;如旧环境中设置过该变量,它只会被视为一次性旧数据迁移来源。新的自定义目录请使用 `CLI_BRIDGE_DATA_DIR`。
|
|
465
|
+
|
|
466
|
+
## 版本更新
|
|
467
|
+
|
|
468
|
+
### 检查更新
|
|
469
|
+
|
|
470
|
+
运行以下命令检查是否有新版本:
|
|
471
|
+
|
|
472
|
+
```bash
|
|
473
|
+
wechat-check-update
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
该命令会显示:
|
|
477
|
+
|
|
478
|
+
- 当前安装的版本;
|
|
479
|
+
- 远程仓库的最新版本;
|
|
480
|
+
- 如果有更新,会提供详细的更新指引。
|
|
481
|
+
|
|
482
|
+
当启动 `wechat-bridge` 相关命令时(如 `wechat-bridge-codex`、`wechat-bridge-claude`),程序也会自动检查更新(每 24 小时一次)。自动检查在后台异步执行,不影响启动速度。
|
|
483
|
+
|
|
484
|
+
### 获取最新版本
|
|
485
|
+
|
|
486
|
+
如果你使用 npm 全局安装,当前推荐直接执行:
|
|
487
|
+
|
|
488
|
+
```bash
|
|
489
|
+
npm install -g cli-wechat-bridge@latest
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
升级后请重启正在运行的 bridge 和 companion 终端,确保它们加载同一版本。
|
|
493
|
+
|
|
494
|
+
如果你使用源码仓库,可以使用以下命令更新:
|
|
495
|
+
|
|
496
|
+
```bash
|
|
497
|
+
cd CLI-WeChat-Bridge
|
|
498
|
+
git pull
|
|
499
|
+
bun install
|
|
500
|
+
npm install -g .
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
## 常见问题
|
|
504
|
+
|
|
505
|
+
### 1. `wechat-codex` / `wechat-claude` / `wechat-opencode` 提示找不到 bridge
|
|
506
|
+
|
|
507
|
+
通常原因如下:
|
|
508
|
+
|
|
509
|
+
- 还没有先启动对应的 `wechat-bridge-*`;
|
|
510
|
+
- bridge 与 companion 不在同一个目录;
|
|
511
|
+
- 当前工作区 endpoint 文件不存在或来自旧进程。
|
|
512
|
+
|
|
513
|
+
建议先确认两个终端在同一目录;如果不想手动分两个终端,可以改用对应的 `wechat-codex-start`、`wechat-claude-start` 或 `wechat-opencode-start`。
|
|
514
|
+
|
|
515
|
+
### 2. 全局命令不存在
|
|
516
|
+
|
|
517
|
+
请确认已经执行以下之一:
|
|
518
|
+
|
|
519
|
+
```bash
|
|
520
|
+
npm install -g cli-wechat-bridge@latest
|
|
521
|
+
npm install -g .
|
|
522
|
+
npm link
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
如果命令仍不存在,请检查 npm 全局 bin 目录是否已加入 `PATH`。
|
|
526
|
+
|
|
527
|
+
### 3. Windows 下出现 `codex.ps1` 或 PowerShell profile 警告
|
|
528
|
+
|
|
529
|
+
项目已经尽量规避 `codex.ps1`:
|
|
530
|
+
|
|
531
|
+
- 优先查找 vendor `codex.exe`;
|
|
532
|
+
- 必要时通过 `cmd.exe` 包装 `codex.cmd`。
|
|
533
|
+
|
|
534
|
+
如果本机 PowerShell profile 本身受执行策略限制,终端仍可能打印相关警告。这通常不是 bridge 本身故障。
|
|
535
|
+
|
|
536
|
+
### 4. 微信上提示没有 context token
|
|
537
|
+
|
|
538
|
+
通常表示当前联系人还没有建立可用的 iLink 上下文。一般先由 owner 账号发送一条普通消息即可建立上下文。
|
|
539
|
+
|
|
540
|
+
### 5. `codex is still working...`
|
|
541
|
+
|
|
542
|
+
该提示只应在当前确实存在活动任务时出现。
|
|
543
|
+
|
|
544
|
+
如果偶发出现:
|
|
545
|
+
|
|
546
|
+
1. 先确认本地 `wechat-codex` 是否真的仍在执行任务;
|
|
547
|
+
2. 必要时使用 `/stop`;
|
|
548
|
+
3. 检查:
|
|
549
|
+
|
|
550
|
+
```text
|
|
551
|
+
~/.cli-bridge/bridge.log
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
### 6. 本地 `/resume` 后微信不同步
|
|
555
|
+
|
|
556
|
+
请优先确认:`wechat-bridge-codex` 与 `wechat-codex` 是否都已重启到同一版本。
|
|
557
|
+
|
|
558
|
+
部分设备可能存在第一次本地输入不同步到微信的情况,可以先微信发送指令来建立连接。
|
|
559
|
+
|
|
560
|
+
### 7. `wechat_send_failed` 或 `UND_ERR_CONNECT_TIMEOUT`
|
|
561
|
+
|
|
562
|
+
如果 `bridge-state.json` 看起来正常,但微信仍然没有收到回复,优先检查:
|
|
563
|
+
|
|
564
|
+
```text
|
|
565
|
+
~/.cli-bridge/bridge.log
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
如果日志中出现 `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`。
|
|
569
|
+
|
|
570
|
+
## 已知限制
|
|
571
|
+
|
|
572
|
+
- 微信 `/resume` 暂时被禁用(可能导致对话双向不稳定)
|
|
573
|
+
- Codex 不支持底层任务的远程审批!建议给好权限,正常使用,几乎不会主动请求较为低级的远程审批;Claude Code 支持远程审批,但是测试的不够,如有问题可以提 issue。
|
|
574
|
+
- `wechat-daemon` v1 绑定启动工作区;暂不支持从微信切换到另一个本地目录。
|
|
575
|
+
|
|
576
|
+
## 开发说明
|
|
577
|
+
|
|
578
|
+
### 主要入口
|
|
579
|
+
|
|
580
|
+
| 文件 | 作用 |
|
|
581
|
+
| --- | --- |
|
|
582
|
+
| `src/bridge/wechat-bridge.ts` | bridge 主事件循环 |
|
|
583
|
+
| `src/daemon/wechat-daemon.ts` | 常驻 WeChat daemon 与多 CLI slot 管理 |
|
|
584
|
+
| `src/daemon/daemon-link.ts` | daemon 本地 IPC endpoint 与请求协议 |
|
|
585
|
+
| `src/bridge/bridge-adapters.ts` | `codex` / `claude` / `opencode` / `shell` 适配器入口 |
|
|
586
|
+
| `src/bridge/bridge-adapters.opencode.ts` | OpenCode 适配器实现 |
|
|
587
|
+
| `src/companion/local-companion.ts` | `wechat-claude` / `wechat-opencode` 本地 companion 入口 |
|
|
588
|
+
| `src/companion/codex-remote-client.ts` | `wechat-codex` 本地客户端入口 |
|
|
589
|
+
| `src/companion/local-companion-start.ts` | `wechat-codex-start` / `wechat-claude-start` / `wechat-opencode-start` 单命令启动入口 |
|
|
590
|
+
| `src/wechat/wechat-transport.ts` | iLink 消息收发 |
|
|
591
|
+
| `src/bridge/bridge-state.ts` | bridge 状态、锁与日志 |
|
|
592
|
+
| `src/wechat/setup.ts` | 登录与凭据初始化 |
|
|
593
|
+
|
|
594
|
+
### 测试
|
|
595
|
+
|
|
596
|
+
```bash
|
|
597
|
+
bun test
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
也可以按目录运行:
|
|
601
|
+
|
|
602
|
+
```bash
|
|
603
|
+
bun run test:bridge
|
|
604
|
+
bun run test:companion
|
|
605
|
+
bun run test:wechat
|
|
606
|
+
```
|
|
607
|
+
|
|
608
|
+
当前测试主要覆盖:
|
|
609
|
+
|
|
610
|
+
- Windows 启动解析
|
|
611
|
+
- Codex 线程跟随
|
|
612
|
+
- session log fallback
|
|
613
|
+
- panel / busy / completion recovery
|
|
614
|
+
- 工作区路径与状态隔离
|
|
615
|
+
|
|
616
|
+
## 致谢
|
|
617
|
+
|
|
618
|
+
### 相关链接
|
|
619
|
+
|
|
620
|
+
- [Linux DO](https://linux.do/):学AI,上L站!
|
|
621
|
+
- [openclaw-weixin](https://github.com/hao-ji-xing/openclaw-weixin):支持Claude Code Channel,感谢如此迅速的开源。
|
|
622
|
+
- [@modelcontextprotocol/sdk](https://github.com/modelcontextprotocol/typescript-sdk):TypeScript 版 MCP SDK
|
|
623
|
+
- [node-pty](https://github.com/microsoft/node-pty):本地 PTY / ConPTY 进程桥接
|
|
624
|
+
- [@anthropic-ai/sdk](https://github.com/anthropics/anthropic-sdk-typescript):Anthropic TypeScript SDK
|
|
625
|
+
- [qrcode-terminal](https://github.com/gtanner/qrcode-terminal):终端二维码输出
|
|
626
|
+
|
|
627
|
+
### 感谢支持
|
|
628
|
+
|
|
629
|
+
> 感谢 issue 反馈者 和 pr 贡献者。
|
|
630
|
+
|
|
631
|
+
创作不易,如感觉对您有帮助、觉得有意思,可以请喝杯奶茶。❤️
|
|
632
|
+
|
|
633
|
+
<p align='center'><img src='docs\images\wechat-tip.png' width=60%></p>
|
|
634
|
+
|
|
635
|
+
## License
|
|
636
|
+
|
|
637
|
+
[MIT](LICENSE.txt)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import { spawn } from "node:child_process";
|
|
4
|
+
import path from "node:path";
|
|
5
|
+
import { fileURLToPath } from "node:url";
|
|
6
|
+
|
|
7
|
+
const BIN_DIR = path.dirname(fileURLToPath(import.meta.url));
|
|
8
|
+
const PROJECT_DIR = path.resolve(BIN_DIR, "..");
|
|
9
|
+
|
|
10
|
+
export function runJsEntry(relativeEntryPath, extraArgs = []) {
|
|
11
|
+
const entryPath = path.join(PROJECT_DIR, relativeEntryPath);
|
|
12
|
+
const child = spawn(
|
|
13
|
+
process.execPath,
|
|
14
|
+
[entryPath, ...extraArgs, ...process.argv.slice(2)],
|
|
15
|
+
{
|
|
16
|
+
stdio: "inherit",
|
|
17
|
+
cwd: process.cwd(),
|
|
18
|
+
env: process.env,
|
|
19
|
+
},
|
|
20
|
+
);
|
|
21
|
+
|
|
22
|
+
child.once("error", (error) => {
|
|
23
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
24
|
+
process.stderr.write(`${message}\n`);
|
|
25
|
+
process.exit(1);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
child.once("exit", (code, signal) => {
|
|
29
|
+
if (signal) {
|
|
30
|
+
process.kill(process.pid, signal);
|
|
31
|
+
return;
|
|
32
|
+
}
|
|
33
|
+
process.exit(code ?? 0);
|
|
34
|
+
});
|
|
35
|
+
}
|