@wu529778790/open-im 1.11.2-beta.19 → 1.11.2-beta.20

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 (2) hide show
  1. package/README.md +99 -91
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,104 +1,123 @@
1
1
  # open-im
2
2
 
3
- [English](./README.md) · **中文**
4
-
5
3
  > 你的 AI 编程助手，在每个聊天 App 里。
6
4
 
7
- open-im 把 Claude Code、Codex、CodeBuddy 接入 Telegram、飞书、企业微信、钉钉、QQ、微信（WorkBuddy）、微信（ClawBot）。手机发条消息，电脑上就写好代码。
5
+ open-im 把 Claude Code、Codex、CodeBuddy 接入 Telegram、飞书、企业微信、钉钉、QQ 机器人、微信助理、微信客服号。手机发条消息，电脑上就写好代码。
8
6
 
9
- ## 架构
7
+ ## 为什么用 open-im
10
8
 
11
- ![Open-IM 架构图](./diagram/architecture/open-im-architecture.svg)
9
+ - **随时随地** — 通勤、排队、躺沙发上，手机发消息就能让 AI 干活
10
+ - **无缝接力** — 和 Claude Code CLI 共享 session，手机聊一半，电脑接着来
11
+ - **完整能力** — 流式输出、会话管理、模型切换，全靠聊天命令
12
+ - **一个桥接，多个平台** — 同一个 bot 支持 7 个 IM 平台
12
13
 
13
- ## 为什么用 open-im
14
+ ## 快速开始
14
15
 
15
- - **随时随地** — 通勤、排队、躺沙发上，手机发消息就能让 Claude Code 干活
16
- - **无缝接力** — open-im 和 Claude Code CLI 共享 session，在手机上聊到一半，电脑上接着来
17
- - **完整能力，简单界面** — 流式输出、会话管理、模型切换，全靠聊天命令搞定
18
- - **一个桥接，多个平台** — 同一个 bot 支持 Telegram、飞书、钉钉、微信等
16
+ ```bash
17
+ # 安装
18
+ npm install -g @wu529778790/open-im
19
19
 
20
- ## 功能
20
+ # 配置（交互式向导）
21
+ open-im init
21
22
 
22
- ### 聊天命令
23
+ # 启动
24
+ open-im start
25
+ ```
23
26
 
24
- | 命令 | 说明 |
25
- | --- | --- |
26
- | `/help` | 显示所有命令 |
27
- | `/new` | 开启新 AI 会话 |
28
- | `/sessions` | 浏览历史会话（含摘要预览） |
29
- | `/resume [序号]` | 恢复会话（无参数恢复最近一条） |
30
- | `/history [序号]` | 查看会话对话记录 |
31
- | `/delete <序号>` | 删除历史会话 |
32
- | `/rename <标题>` | 重命名当前会话 |
33
- | `/fork [序号]` | 分支会话（创建副本） |
34
- | `/models` | 查看可用 AI 模型 |
35
- | `/context` | 查看上下文窗口占用 |
36
- | `/status` | 显示 AI 工具、账号、会话信息 |
37
- | `/cd <路径>` / `/pwd` | 切换工作目录（自动恢复该目录的历史会话） |
38
- | `/allow` / `/y`、`/deny` / `/n` | 权限确认 |
39
-
40
- ### 会话接力
41
-
42
- open-im 和 Claude Code CLI 共享同一份 session 存储。同一个目录下，手机和电脑可以无缝切换。
27
+ 或直接用 npx：
43
28
 
44
29
  ```bash
45
- # 电脑端
46
- cd /my-project && claude # 正常工作，退出时 Ctrl+C
30
+ npx @wu529778790/open-im init
31
+ npx @wu529778790/open-im start
32
+ ```
47
33
 
48
- # 手机端（IM 消息）
49
- "帮我修复登录 bug" # open-im 自动接续同一个 session
34
+ ### 最小配置
50
35
 
51
- # 回到电脑端
52
- claude -c # 接上手机端的对话
36
+ ```json
37
+ {
38
+ "tools": {
39
+ "claude": { "workDir": "/path/to/project" }
40
+ },
41
+ "platforms": {
42
+ "telegram": { "enabled": true, "botToken": "YOUR_TOKEN" }
43
+ }
44
+ }
53
45
  ```
54
46
 
55
- > 同一时刻只能有一端活跃。从手机发消息前先退出 CLI，反之亦然。
56
-
57
- ### 平台支持
47
+ ## 平台支持
58
48
 
59
- 七个 IM 平台，三种 AI 后端，可按平台覆盖：
49
+ | 平台 | 流式输出 | 接入指南 |
50
+ |------|---------|---------|
51
+ | Telegram | ✅ | [Bot 文档](https://core.telegram.org/bots#creating-a-new-bot) |
52
+ | 飞书 | ✅ | [开放平台](https://open.feishu.cn/) |
53
+ | QQ 机器人 | ✅ | [开放平台](https://bot.q.qq.com/) |
54
+ | 企业微信 | ✅ | [管理后台](https://work.weixin.qq.com/) |
55
+ | 钉钉机器人 | ⚠️ 部分 | [开放平台](https://open-dev.dingtalk.com/) |
56
+ | 微信助理（WorkBuddy） | ✅ | [接入指南](https://www.codebuddy.cn/docs/workbuddy/Claw) |
57
+ | 微信客服号（ClawBot） | ✅ | [接入指南](https://www.codebuddy.cn/docs/workbuddy/Claw) |
60
58
 
61
- | 平台 | 流式输出 | 备注 |
62
- | --- | --- | --- |
63
- | Telegram | 支持 | 完整 bot 支持 |
64
- | 飞书 | 支持 | 流式卡片 |
65
- | 企业微信 | 支持 | 流式卡片 |
66
- | 钉钉 | 部分 | 回退到纯文本 |
67
- | QQ | 支持 | |
68
- | WorkBuddy | 支持 | 微信生态 |
69
- | ClawBot | 支持 | 微信生态 |
59
+ 每个平台可单独配置 AI 后端（`claude` / `codex` / `codebuddy`），默认 `claude`。
70
60
 
71
- 在每个平台上设置 `platforms.<name>.aiCommand`（`claude` / `codex` / `codebuddy`），默认 `claude`。
61
+ ## 聊天命令
72
62
 
73
- ### Web 控制台
63
+ | 命令 | 说明 |
64
+ |------|------|
65
+ | `/help` | 显示所有命令 |
66
+ | `/new` | 开启新 AI 会话 |
67
+ | `/sessions` | 浏览历史会话 |
68
+ | `/resume [序号]` | 恢复会话 |
69
+ | `/history [序号]` | 查看对话记录 |
70
+ | `/delete <序号>` | 删除会话 |
71
+ | `/rename <标题>` | 重命名会话 |
72
+ | `/fork [序号]` | 分支会话 |
73
+ | `/models` | 查看可用模型 |
74
+ | `/context` | 查看上下文用量 |
75
+ | `/status` | 显示状态信息 |
76
+ | `/cd <路径>` / `/pwd` | 切换/查看工作目录 |
77
+ | `/plugins` | 查看已安装插件 |
78
+ | `/allow` `/y` / `/deny` `/n` | 权限确认 |
79
+
80
+ ## 会话接力
81
+
82
+ open-im 和 Claude Code CLI 共享 session 存储。同一目录下，手机和电脑无缝切换：
74
83
 
75
- `open-im start` 在 **`http://127.0.0.1:39282`** 提供内置页面与 API（通过 `OPEN_IM_WEB_PORT` 配置端口）。局域网访问：`export OPEN_IM_WEB_HOST=0.0.0.0`。
84
+ ```bash
85
+ # 电脑端
86
+ cd /my-project && claude
76
87
 
77
- ## 快速开始
88
+ # 手机端
89
+ "帮我修复登录 bug" # 自动接续同一个 session
78
90
 
79
- ```bash
80
- npx @wu529778790/open-im init # 交互式配置
81
- npx @wu529778790/open-im start # 启动桥接
91
+ # 回到电脑端
92
+ claude -c # 接上手机端的对话
82
93
  ```
83
94
 
84
- 或全局安装：`npm install -g @wu529778790/open-im` 后执行 `open-im start`。
95
+ > 同一时刻只能有一端活跃。发消息前先退出 CLI，反之亦然。
85
96
 
86
- 配置文件：**`~/.open-im/config.json`**
97
+ ## Web 控制台
87
98
 
88
- ### 最小配置
99
+ `open-im start` 在 `http://127.0.0.1:39282` 提供管理界面：
89
100
 
90
- ```json
91
- {
92
- "tools": {
93
- "claude": { "workDir": "/path/to/project", "skipPermissions": true }
94
- },
95
- "platforms": {
96
- "telegram": { "enabled": true, "botToken": "YOUR_TELEGRAM_BOT_TOKEN" }
97
- }
98
- }
99
- ```
101
+ - 配置所有平台凭证
102
+ - 启动/停止桥接服务
103
+ - 编辑配置文件
104
+ - 首次运行自动弹出设置向导
100
105
 
101
- 完整模板请用 `open-im init`。
106
+ 局域网访问：`export OPEN_IM_WEB_HOST=0.0.0.0`
107
+
108
+ ## CLI 命令
109
+
110
+ | 命令 | 说明 |
111
+ |------|------|
112
+ | `open-im init` | 交互式配置 |
113
+ | `open-im start` | 后台运行 |
114
+ | `open-im stop` | 停止服务 |
115
+ | `open-im restart` | 重启 |
116
+ | `open-im dashboard` | 仅启动 Web 配置服务 |
117
+
118
+ ## 配置
119
+
120
+ 配置文件：`~/.open-im/config.json`
102
121
 
103
122
  ### Claude（Agent SDK）
104
123
 
@@ -111,43 +130,32 @@ npx @wu529778790/open-im start # 启动桥接
111
130
  "env": {
112
131
  "ANTHROPIC_AUTH_TOKEN": "your-token",
113
132
  "ANTHROPIC_BASE_URL": "https://your-api-endpoint",
114
- "ANTHROPIC_MODEL": "glm-4.7"
133
+ "ANTHROPIC_MODEL": "model-name"
115
134
  }
116
135
  }
117
136
  }
118
137
  }
119
138
  ```
120
139
 
121
- ### CLI 命令
122
-
123
- | 命令 | 说明 |
124
- | --- | --- |
125
- | `open-im init` | 交互配置（不启动桥接） |
126
- | `open-im start` | 后台运行桥接 |
127
- | `open-im stop` | 停止后台服务 |
128
- | `open-im restart` | 重启 |
129
- | `open-im dashboard` | 仅 Web 配置服务（不启动桥接） |
130
-
131
140
  ### 环境变量
132
141
 
133
- **`ANTHROPIC_*`**（shell 或 `tools.claude.env`）、**`TELEGRAM_BOT_TOKEN`**、**`OPEN_IM_WEB_PORT`**、**`OPEN_IM_WEB_HOST`**，以及各平台的 `*_APP_ID`、`*_SECRET`、`WORKBUDDY_*` 等。
134
-
135
- ### Git 共同作者
136
-
137
- 默认在 AI 发起的提交里追加 `Co-authored-by`。关闭：设置环境变量 **`OPEN_IM_GIT_COAUTHOR=0`** 并重启桥接。
142
+ - **`ANTHROPIC_*`** — Claude API 配置
143
+ - **`TELEGRAM_BOT_TOKEN`** — Telegram Bot Token
144
+ - **`OPEN_IM_WEB_PORT`** — Web 控制台端口（默认 39282）
145
+ - **`OPEN_IM_WEB_HOST`** — Web 控制台监听地址
138
146
 
139
147
  ### 隐私
140
148
 
141
- 为改进稳定性，可能记录**匿名**运行信息（不含聊天或 prompt 内容）。若需关闭：环境变量 **`OPEN_IM_TELEMETRY=false`**，或 `config.json` 中 `"telemetry": { "enabled": false }`。
149
+ 匿名运行信息用于改进稳定性（不含聊天内容）。关闭：`OPEN_IM_TELEMETRY=false`
142
150
 
143
- ## 平台配置与故障排除
151
+ ## 平台配置详情
144
152
 
145
- 详见 **[docs/platforms.zh-CN.md](./docs/platforms.zh-CN.md)**。
153
+ 详见 [docs/platforms.md](./docs/platforms.md)
146
154
 
147
155
  ## 环境要求
148
156
 
149
157
  - Node.js >= 20
150
- - 至少配置一个 IM 平台 + 所选 AI 的凭证
158
+ - 至少配置一个 IM 平台 + AI 凭证
151
159
 
152
160
  ## License
153
161
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wu529778790/open-im",
3
- "version": "1.11.2-beta.19",
3
+ "version": "1.11.2-beta.20",
4
4
  "description": "Your AI coding assistant, in every chat app. Multi-platform IM bridge for Claude Code, Codex, and CodeBuddy.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",