@colinlu50/openclaw-lark-stream 2026.3.25 → 2026.3.27

package/README.en.md

@@ -0,0 +1,56 @@
+English | [中文](./README.md)
+
+# OpenClaw Lark/Feishu Plugin — Stream Card Fork
+
+Fork of the official [openclaw-larksuite](https://github.com/larksuite/openclaw-larksuite) plugin with **streaming block output** and **tool call indicators**.
+
+## What's Changed
+
+The official plugin delivers LLM block results all at once after completion. This fork enables:
+
+- **Real-time block streaming** — each block's content is progressively appended to the streaming card as it's generated
+- **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
+
+## Installation
+
+Requires [OpenClaw](https://openclaw.ai) (>= 2026.2.26) and Node.js (>= v22).
+
+```bash
+openclaw plugins install @colinlu50/openclaw-lark-stream
+```
+
+Then restart the gateway:
+
+```bash
+openclaw gateway restart
+```
+
+> If you had the official plugin installed, uninstall it first:
+> ```bash
+> openclaw plugins uninstall openclaw-lark --force
+> ```
+
+### From source (for development)
+
+```bash
+cd ~/.openclaw/extensions
+git clone git@github.com:ColinLu50/openclaw-lark-stream.git openclaw-lark-stream
+cd openclaw-lark-stream && npm install && npm run build
+openclaw gateway restart
+```
+
+## Configuration
+
+The card footer shows elapsed time and completion status by default. To disable:
+
+```bash
+openclaw config set channels.feishu.footer.elapsed false  # hide elapsed time
+openclaw config set channels.feishu.footer.status false   # hide completion status
+```
+
+- **elapsed** — displays total response time (e.g. `Elapsed 3.2s`) in the card footer
+- **status** — displays completion state (`Completed` / `Error` / `Stopped`) in the card footer
+
+## License
+
+MIT — same as the upstream project.

package/README.md

@@ -1,76 +1,4 @@
-[English](#english) | [中文](#中文)
-
----
-
-<a id="english"></a>
-
-# OpenClaw Lark/Feishu Plugin — Stream Card Fork
-
-Fork of the official [openclaw-larksuite](https://github.com/larksuite/openclaw-larksuite) plugin with **streaming block output** and **tool call indicators**.
-
-## What's Changed
-
-The official plugin delivers LLM block results all at once after completion. This fork enables:
-
-- **Real-time block streaming** — each block's content is progressively appended to the streaming card as it's generated
-- **Tool call indicators** — when the agent calls a tool, the card shows tool call status in real-time
-
-### Modified Files
-
-- `src/card/reply-dispatcher.ts` — enable block streaming in streaming card mode; wire `onToolStart` callback
-- `src/card/streaming-card-controller.ts` — append each delivered block to the card in real-time; add `onToolStart()` to display tool call status
-- `src/card/builder.ts` — collapsible panel for tool call summary in completed cards
-
-## Installation
-
-Requires [OpenClaw](https://openclaw.ai) (>= 2026.2.26) and Node.js (>= v22).
-
-### Option A: npm install (recommended)
-
-1. Install the official plugin first to complete the guided setup (App ID, secret, OAuth, etc.):
-   ```bash
-   npx -y @larksuite/openclaw-lark install
-   ```
-
-2. Replace with the stream fork:
-   ```bash
-   openclaw plugins install @colinlu50/openclaw-lark-stream
-   ```
-
-If you already have the official plugin installed, skip step 1.
-
-### Option B: From source (for development)
-
-```bash
-cd ~/.openclaw/extensions
-rm -rf openclaw-lark
-git clone git@github.com:ColinLu50/openclaw-lark-stream.git openclaw-lark
-cd openclaw-lark && npm install
-```
-
-Restart OpenClaw.
-
-## Configuration
-
-Enable optional card footer metadata:
-
-```bash
-openclaw config set channels.feishu.footer.elapsed true  # show elapsed time
-openclaw config set channels.feishu.footer.status true   # show completion status
-```
-
-- **elapsed** — displays total response time (e.g. `Elapsed 3.2s`) in the card footer
-- **status** — displays completion state (`Completed` / `Error` / `Stopped`) in the card footer
-
-Both default to `false` (hidden).
-
-## License
-
-MIT — same as the upstream project.
-
----
-
-<a id="中文"></a>
+[English](./README.en.md) | 中文
 
 # OpenClaw 飞书插件 — 流式卡片 Fork
 
@@ -80,57 +8,48 @@ MIT — same as the upstream project.
 
 官方插件在 LLM 生成完一个 block 后才一次性推送结果。本 Fork 实现了：
 
-- **实时流式追加** — 每个 block 的内容在生成过程中逐步追加到流式卡片，让用户获得即时的视觉反馈
-- **工具调用状态** — 当 agent 调用工具时，卡片实时显示工具调用状态
-
-### 改动文件
-
-- `src/card/reply-dispatcher.ts` — 在流式卡片模式下启用 block 流式输出；接入 `onToolStart` 回调
-- `src/card/streaming-card-controller.ts` — 将每个已交付的 block 实时追加到卡片；添加 `onToolStart()` 显示工具调用状态
-- `src/card/builder.ts` — 完成卡片中工具调用摘要的折叠面板
+- **实时流式追加** — 每个 block 的内容在生成过程中逐步追加到流式卡片
+- **工具调用状态** — agent 调用工具时，卡片顶部实时显示当前工具，完成后自动折叠为摘要面板
 
 ## 安装
 
 需要 [OpenClaw](https://openclaw.ai)（>= 2026.2.26）和 Node.js（>= v22）。
 
-### 方式 A：npm 安装（推荐）
+```bash
+openclaw plugins install @colinlu50/openclaw-lark-stream
+```
 
-1. 先安装官方插件完成引导配置（App ID、密钥、OAuth 等）：
-   ```bash
-   npx -y @larksuite/openclaw-lark install
-   ```
+安装完成后重启网关：
 
-2. 用流式 Fork 替换：
-   ```bash
-   openclaw plugins install @colinlu50/openclaw-lark-stream
-   ```
+```bash
+openclaw gateway restart
+```
 
-如果已安装过官方插件，跳过第 1 步。
+> 如果之前安装过官方插件，先卸载：
+> ```bash
+> openclaw plugins uninstall openclaw-lark --force
+> ```
 
-### 方式 B：从源码安装（用于开发）
+### 从源码安装（开发用）
 
 ```bash
 cd ~/.openclaw/extensions
-rm -rf openclaw-lark
-git clone git@github.com:ColinLu50/openclaw-lark-stream.git openclaw-lark
-cd openclaw-lark && npm install
+git clone git@github.com:ColinLu50/openclaw-lark-stream.git openclaw-lark-stream
+cd openclaw-lark-stream && npm install && npm run build
+openclaw gateway restart
 ```
 
-重启 OpenClaw。
-
 ## 配置
 
-开启可选的卡片底栏元信息：
+卡片底栏默认显示耗时和完成状态，如需关闭：
 
 ```bash
-openclaw config set channels.feishu.footer.elapsed true  # 开启耗时
-openclaw config set channels.feishu.footer.status true   # 开启状态展示
+openclaw config set channels.feishu.footer.elapsed false  # 隐藏耗时
+openclaw config set channels.feishu.footer.status false   # 隐藏完成状态
 ```
 
-- **elapsed** — 在卡片底栏显示总响应耗时（如 `耗时 3.2s`）
-- **status** — 在卡片底栏显示完成状态（`已完成` / `出错` / `已停止`）
-
-两者默认为 `false`（不显示）。
+- **elapsed** — 卡片底栏显示总响应耗时（如 `耗时 3.2s`）
+- **status** — 卡片底栏显示完成状态（`已完成` / `出错` / `已停止`）
 
 ## 许可证
 

package/bin/openclaw-lark.js

@@ -1,15 +1,16 @@
 #!/usr/bin/env node
 
 import { execFileSync } from "node:child_process";
-import { existsSync, rmSync } from "node:fs";
+import { existsSync, readFileSync, rmSync, writeFileSync } from "node:fs";
 import { dirname, join } from "node:path";
 
 const SELF_PACKAGE = "@colinlu50/openclaw-lark-stream";
-const PLUGIN_DIR = join(
-  process.env.OPENCLAW_STATE_DIR || join(process.env.HOME || process.env.USERPROFILE || "", ".openclaw"),
-  "extensions",
-  "openclaw-lark-stream",
-);
+const STATE_DIR = process.env.OPENCLAW_STATE_DIR || join(process.env.HOME || process.env.USERPROFILE || "", ".openclaw");
+const EXTENSIONS_DIR = join(STATE_DIR, "extensions");
+const CONFIG_FILE = join(STATE_DIR, "openclaw.json");
+// Tools installs official plugin as "openclaw-lark"; our manifest uses "openclaw-lark-stream"
+const OFFICIAL_DIR = join(EXTENSIONS_DIR, "openclaw-lark");
+const SELF_DIR = join(EXTENSIONS_DIR, "openclaw-lark-stream");
 
 const args = process.argv.slice(2);
 const subcommand = args[0];
@@ -28,12 +29,19 @@ if (subcommand === "install" || subcommand === "update") {
     // Tools may fail on gateway restart etc. — that's OK, config is preserved.
   }
 
-  // Step 2: Replace official plugin code with ours
+  // Step 2: Clean up old plugin dirs + config references, then install ours
   try {
-    if (existsSync(PLUGIN_DIR)) {
-      console.log(`\nSwapping official plugin with ${SELF_PACKAGE}...`);
-      rmSync(PLUGIN_DIR, { recursive: true, force: true });
+    for (const dir of [OFFICIAL_DIR, SELF_DIR]) {
+      if (existsSync(dir)) {
+        console.log(`\nRemoving ${dir}...`);
+        rmSync(dir, { recursive: true, force: true });
+      }
     }
+    // Remove stale "openclaw-lark" references from config so openclaw doesn't
+    // fail validation when the directory is gone.
+    cleanConfigReferences("openclaw-lark");
+
+    console.log(`\nInstalling ${SELF_PACKAGE}...`);
     execFileSync("openclaw", ["plugins", "install", SELF_PACKAGE], {
       stdio: "inherit",
     });
@@ -54,6 +62,39 @@ try {
   process.exit(error.status ?? 1);
 }
 
+/**
+ * Remove stale plugin references from openclaw.json so that
+ * `openclaw plugins install` doesn't fail config validation.
+ */
+function cleanConfigReferences(pluginId) {
+  if (!existsSync(CONFIG_FILE)) return;
+  try {
+    const cfg = JSON.parse(readFileSync(CONFIG_FILE, "utf8"));
+    let changed = false;
+    if (cfg.plugins?.entries?.[pluginId]) {
+      delete cfg.plugins.entries[pluginId];
+      changed = true;
+    }
+    if (cfg.plugins?.installs?.[pluginId]) {
+      delete cfg.plugins.installs[pluginId];
+      changed = true;
+    }
+    if (Array.isArray(cfg.plugins?.allow)) {
+      const idx = cfg.plugins.allow.indexOf(pluginId);
+      if (idx !== -1) {
+        cfg.plugins.allow.splice(idx, 1);
+        changed = true;
+      }
+    }
+    if (changed) {
+      writeFileSync(CONFIG_FILE, JSON.stringify(cfg, null, 2) + "\n", "utf8");
+      console.log(`Cleaned "${pluginId}" references from ${CONFIG_FILE}`);
+    }
+  } catch {
+    // Config parse failure — let openclaw handle it
+  }
+}
+
 function runTools(fwdArgs) {
   let version = "latest";
   const vIdx = fwdArgs.indexOf("--tools-version");

package/dist/index.js

@@ -114064,8 +114064,8 @@ var init_footer_config = __esm({
   "src/core/footer-config.ts"() {
     "use strict";
     DEFAULT_FOOTER_CONFIG = {
-      status: false,
-      elapsed: false
+      status: true,
+      elapsed: true
     };
     __name(resolveFooterConfig, "resolveFooterConfig");
   }
@@ -147775,7 +147775,7 @@ init_gate();
 init_dedup();
 var log29 = larkLogger("plugin");
 var plugin = {
-  id: "openclaw-lark",
+  id: "openclaw-lark-stream",
   name: "Feishu",
   description: "Lark/Feishu channel plugin with im/doc/wiki/drive/task/calendar tools",
   configSchema: emptyPluginConfigSchema(),