@colinlu50/openclaw-lark-stream 260323.3.0 → 260327.1.0

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 (6) hide show
  1. package/README.en.md +86 -58
  2. package/README.md +86 -65
  3. package/bin/openclaw-lark.js +297 -259
  4. package/dist/index.js +2859 -2365
  5. package/dist/index.js.map +4 -4
  6. package/package.json +2 -2
package/README.en.md CHANGED
@@ -1,58 +1,86 @@
1
- English | [中文](./README.md)
2
-
3
- # OpenClaw Lark/Feishu Plugin — Stream Card Fork
4
-
5
- ![demo](./demo.gif)
6
-
7
- Fork of the official [openclaw-larksuite](https://github.com/larksuite/openclaw-larksuite) plugin with **streaming block output** and **tool call indicators**.
8
-
9
- ## What's Changed
10
-
11
- The official plugin delivers LLM block results all at once after completion. This fork enables:
12
-
13
- - **Real-time block streaming** — each block's content is progressively appended to the streaming card as it's generated
14
- - **Tool call indicators** — when the agent calls a tool, the card shows the current tool at the top in real-time, with a collapsible summary panel on completion
15
-
16
- ## Installation
17
-
18
- Requires [OpenClaw](https://openclaw.ai) (>= 2026.2.26) and Node.js (>= v22).
19
-
20
- ```bash
21
- openclaw plugins install @colinlu50/openclaw-lark-stream
22
- ```
23
-
24
- Then restart the gateway:
25
-
26
- ```bash
27
- openclaw gateway restart
28
- ```
29
-
30
- > If you had the official plugin installed, uninstall it first:
31
- > ```bash
32
- > openclaw plugins uninstall openclaw-lark --force
33
- > ```
34
-
35
- ### From source (for development)
36
-
37
- ```bash
38
- cd ~/.openclaw/extensions
39
- git clone git@github.com:ColinLu50/openclaw-lark-stream.git openclaw-lark-stream
40
- cd openclaw-lark-stream && npm install && npm run build
41
- openclaw gateway restart
42
- ```
43
-
44
- ## Configuration
45
-
46
- The card footer shows elapsed time and completion status by default. To disable:
47
-
48
- ```bash
49
- openclaw config set channels.feishu.footer.elapsed false # hide elapsed time
50
- openclaw config set channels.feishu.footer.status false # hide completion status
51
- ```
52
-
53
- - **elapsed** — displays total response time (e.g. `Elapsed 3.2s`) in the card footer
54
- - **status** — displays completion state (`Completed` / `Error` / `Stopped`) in the card footer
55
-
56
- ## License
57
-
58
- MIT — same as the upstream project.
1
+ English | [中文](./README.md)
2
+
3
+ # OpenClaw Lark/Feishu Plugin — Stream Card Edition
4
+
5
+ ![demo](./demo.gif)
6
+
7
+ Based on the official [openclaw-lark](https://github.com/larksuite/openclaw-lark) plugin, with **real-time streaming output**, **reasoning display**, and **tool call indicators**.
8
+
9
+ ## ✨ What's Changed
10
+
11
+ The official plugin delivers LLM block results all at once after completion. This version enables:
12
+
13
+ - **Real-time streaming output** — each block's content is progressively appended to the streaming card as it's generated
14
+ - **Group chat streaming** — streaming output works in group chats as well
15
+ - **Reasoning display** — think content from reasoning models (DeepSeek-R1, Claude 3.7, etc.) streams live, then collapses into an expandable panel
16
+ - **Tool call indicators** — when the agent calls a tool, the card shows the current tool at the top in real-time, collapsing into an expandable panel on completion
17
+ - **Ordered event panels** — the final card shows toggle panels in the order they occurred: think → tool → think → tool, preserving the full reasoning flow
18
+
19
+ ## 📢 News
20
+
21
+ - **2026.3.27** — Compatible with OpenClaw >= 2026.3.22; added AskUserQuestion interactive tool; reasoning and tool panels now appear in chronological order; fixed card table limit error 230099
22
+ - **2026.3.23** — First release with real-time streaming output and tool call indicators (for OpenClaw < 2026.3.22, use the `0322` branch)
23
+
24
+ ## 📦 Installation
25
+
26
+ Requires [OpenClaw](https://openclaw.ai) and Node.js (>= v22).
27
+
28
+ The install script automatically detects your OpenClaw version and installs the right plugin:
29
+ - OpenClaw **>= 2026.3.22** → installs the latest version (reasoning streaming, AskUserQuestion, etc.)
30
+ - OpenClaw **< 2026.3.22** → installs the legacy-compatible version
31
+
32
+ > [!NOTE]
33
+ > **Alibaba Cloud OpenClaw plans are not supported** (permission restrictions). Please use a self-hosted server.
34
+
35
+ ```bash
36
+ npx -y @colinlu50/openclaw-lark-stream install
37
+ ```
38
+
39
+ ### From source (for development)
40
+
41
+ ```bash
42
+ cd ~/.openclaw/extensions
43
+ git clone https://github.com/ColinLu50/openclaw-lark-stream.git openclaw-lark-stream
44
+ cd openclaw-lark-stream && npm install && npm run build
45
+ openclaw gateway restart
46
+ ```
47
+
48
+ ## ⚙️ Configuration
49
+
50
+ ### Streaming Output
51
+
52
+ Streaming is enabled by default after installation. To disable:
53
+
54
+ ```bash
55
+ openclaw config set channels.feishu.streaming false
56
+ openclaw config set channels.feishu.replyMode.direct card
57
+ openclaw config set channels.feishu.replyMode.group card
58
+ openclaw config set channels.feishu.replyMode.default card
59
+ openclaw gateway restart
60
+ ```
61
+
62
+ To re-enable:
63
+
64
+ ```bash
65
+ openclaw config set channels.feishu.streaming true
66
+ openclaw config set channels.feishu.replyMode.direct streaming
67
+ openclaw config set channels.feishu.replyMode.group streaming
68
+ openclaw config set channels.feishu.replyMode.default streaming
69
+ openclaw gateway restart
70
+ ```
71
+
72
+ ### Card Footer
73
+
74
+ Elapsed time and completion status are shown by default. To disable:
75
+
76
+ ```bash
77
+ openclaw config set channels.feishu.footer.elapsed false # hide elapsed time
78
+ openclaw config set channels.feishu.footer.status false # hide completion status
79
+ ```
80
+
81
+ - **elapsed** — displays total response time (e.g. `Elapsed 3.2s`) in the card footer
82
+ - **status** — displays completion state (`Completed` / `Error` / `Stopped`) in the card footer
83
+
84
+ ## 📄 License
85
+
86
+ MIT
package/README.md CHANGED
@@ -1,65 +1,86 @@
1
- [English](./README.en.md) | 中文
2
-
3
- # OpenClaw 飞书插件 — 流式卡片 Fork
4
-
5
- ![demo](./demo.gif)
6
-
7
- 基于官方 [openclaw-larksuite](https://github.com/larksuite/openclaw-larksuite) 插件的 Fork，支持**流式分块输出**和**工具调用状态展示**。
8
-
9
- ## ✨ 改动说明
10
-
11
- 官方插件在 LLM 生成完一个 block 后才一次性推送结果。本 Fork 实现了：
12
-
13
- - **实时流式输出** — 每个 block 的内容在生成过程中逐步追加到流式卡片
14
- - **群聊流式输出** — 群聊中也可使用流式输出
15
- - **工具调用状态** — agent 调用工具时，卡片顶部实时显示当前工具，完成后自动折叠为摘要面板
16
-
17
- ## 📢 News
18
-
19
- - **2026.3.23** — 发布第一版，支持实时流式输出和工具调用状态展示
20
-
21
- ## 📦 安装
22
-
23
- 需要 [OpenClaw](https://openclaw.ai) 和 Node.js（>= v22）。
24
-
25
- > [!WARNING]
26
- > OpenClaw 新发布的 **3.22** 版本存在不兼容变更，飞书插件运行会出现异常，正在兼容中。预计 **3.24 日**兼容完成。
27
- > 请暂时使用 3.13 版本：
28
- > ```bash
29
- > npm install -g openclaw@2026.3.13
30
- > ```
31
- > 查看当前版本：`openclaw -v`
32
-
33
- ```bash
34
- npx -y @colinlu50/openclaw-lark-stream install
35
- ```
36
-
37
- > 如果之前安装过官方插件，先卸载：
38
- > ```bash
39
- > openclaw plugins uninstall openclaw-lark --force
40
- > ```
41
-
42
- ### 从源码安装（开发用）
43
-
44
- ```bash
45
- cd ~/.openclaw/extensions
46
- git clone https://github.com/ColinLu50/openclaw-lark-stream.git openclaw-lark-stream
47
- cd openclaw-lark-stream && npm install && npm run build
48
- openclaw gateway restart
49
- ```
50
-
51
- ## ⚙️ 配置
52
-
53
- 卡片底栏默认显示耗时和完成状态，如需关闭：
54
-
55
- ```bash
56
- openclaw config set channels.feishu.footer.elapsed false # 隐藏耗时
57
- openclaw config set channels.feishu.footer.status false # 隐藏完成状态
58
- ```
59
-
60
- - **elapsed** — 卡片底栏显示总响应耗时（如 `耗时 3.2s`）
61
- - **status** — 卡片底栏显示完成状态（`已完成` / `出错` / `已停止`）
62
-
63
- ## 📄 许可证
64
-
65
- MIT
1
+ [English](./README.en.md) | 中文
2
+
3
+ # OpenClaw 飞书插件 — 流式卡片版
4
+
5
+ ![demo](./demo.gif)
6
+
7
+ 基于官方 [openclaw-lark](https://github.com/larksuite/openclaw-lark) 插件，支持**实时流式输出**、**推理过程展示**和**工具调用状态**。
8
+
9
+ ## ✨ 改动说明
10
+
11
+ 官方插件在 LLM 生成完一个 block 后才一次性推送结果。本版本实现了：
12
+
13
+ - **实时流式输出** — 每个 block 的内容在生成过程中逐步追加到流式卡片
14
+ - **群聊流式输出** — 群聊中也可使用流式输出
15
+ - **推理过程展示** — 推理模型（DeepSeek-R1、Claude 3.7 等）的 think 内容实时流出，完成后折叠为可展开面板
16
+ - **工具调用状态** — agent 调用工具时，卡片顶部实时显示当前工具，完成后折叠为可展开面板
17
+ - **有序事件面板** — 最终卡片按 think → tool → think → tool 的顺序展示折叠面板，完整还原推理过程
18
+
19
+ ## 📢 News
20
+
21
+ - **2026.3.27** — 适配 OpenClaw >= 2026.3.22；新增 AskUserQuestion 交互式提问工具；推理块与工具调用面板按发生顺序排列；修复卡片表格超限错误 230099
22
+ - **2026.3.23** — 发布第一版，支持实时流式输出和工具调用状态展示（适配 OpenClaw < 2026.3.22，请切换到 `0322` 分支）
23
+
24
+ ## 📦 安装
25
+
26
+ 需要 [OpenClaw](https://openclaw.ai) 和 Node.js（>= v22）。
27
+
28
+ 安装脚本会自动检测 OpenClaw 版本并安装对应的插件版本：
29
+ - OpenClaw **>= 2026.3.22** → 自动安装最新版（支持推理流式、AskUserQuestion 等）
30
+ - OpenClaw **< 2026.3.22** → 自动安装兼容旧版的插件
31
+
32
+ > [!NOTE]
33
+ > **不支持阿里云 OpenClaw 套餐**（权限限制），请使用自建服务器安装。
34
+
35
+ ```bash
36
+ npx -y @colinlu50/openclaw-lark-stream install
37
+ ```
38
+
39
+ ### 从源码安装（开发用）
40
+
41
+ ```bash
42
+ cd ~/.openclaw/extensions
43
+ git clone https://github.com/ColinLu50/openclaw-lark-stream.git openclaw-lark-stream
44
+ cd openclaw-lark-stream && npm install && npm run build
45
+ openclaw gateway restart
46
+ ```
47
+
48
+ ## ⚙️ 配置
49
+
50
+ ### 流式输出
51
+
52
+ 安装后默认开启流式输出。如需关闭：
53
+
54
+ ```bash
55
+ openclaw config set channels.feishu.streaming false
56
+ openclaw config set channels.feishu.replyMode.direct card
57
+ openclaw config set channels.feishu.replyMode.group card
58
+ openclaw config set channels.feishu.replyMode.default card
59
+ openclaw gateway restart
60
+ ```
61
+
62
+ 重新开启：
63
+
64
+ ```bash
65
+ openclaw config set channels.feishu.streaming true
66
+ openclaw config set channels.feishu.replyMode.direct streaming
67
+ openclaw config set channels.feishu.replyMode.group streaming
68
+ openclaw config set channels.feishu.replyMode.default streaming
69
+ openclaw gateway restart
70
+ ```
71
+
72
+ ### 卡片底栏
73
+
74
+ 默认显示耗时和完成状态，如需关闭：
75
+
76
+ ```bash
77
+ openclaw config set channels.feishu.footer.elapsed false # 隐藏耗时
78
+ openclaw config set channels.feishu.footer.status false # 隐藏完成状态
79
+ ```
80
+
81
+ - **elapsed** — 卡片底栏显示总响应耗时（如 `耗时 3.2s`）
82
+ - **status** — 卡片底栏显示完成状态（`已完成` / `出错` / `已停止`）
83
+
84
+ ## 📄 许可证
85
+
86
+ MIT