@colinlu50/openclaw-lark-stream 2026.3.29 → 2026.3.31

package/README.en.md

@@ -2,6 +2,8 @@ English | [中文](./README.md)
 
 # OpenClaw Lark/Feishu Plugin — Stream Card Fork
 
+![demo](./demo.gif)
+
 Fork of the official [openclaw-larksuite](https://github.com/larksuite/openclaw-larksuite) plugin with **streaming block output** and **tool call indicators**.
 
 ## What's Changed

package/README.md

@@ -2,27 +2,32 @@
 
 # OpenClaw 飞书插件 — 流式卡片 Fork
 
+![demo](./demo.gif)
+
 基于官方 [openclaw-larksuite](https://github.com/larksuite/openclaw-larksuite) 插件的 Fork，支持**流式分块输出**和**工具调用状态展示**。
 
-## 改动说明
+## ✨ 改动说明
 
 官方插件在 LLM 生成完一个 block 后才一次性推送结果。本 Fork 实现了：
 
-- **实时流式追加** — 每个 block 的内容在生成过程中逐步追加到流式卡片
+- **实时流式输出** — 每个 block 的内容在生成过程中逐步追加到流式卡片
 - **工具调用状态** — agent 调用工具时，卡片顶部实时显示当前工具，完成后自动折叠为摘要面板
 
-## 安装
+## 📢 News
 
-需要 [OpenClaw](https://openclaw.ai)（>= 2026.2.26）和 Node.js（>= v22）。
+- **2026.3.23** — 发布第一版，支持实时流式输出和工具调用状态展示
 
-```bash
-openclaw plugins install @colinlu50/openclaw-lark-stream
-```
+## 📦 安装
 
-安装完成后重启网关：
+需要 [OpenClaw](https://openclaw.ai)（>= 2026.2.26）和 Node.js（>= v22）。
+
+> 查看 OpenClaw 版本：`openclaw -v`，如版本过低请先升级：
+> ```bash
+> npm install -g openclaw
+> ```
 
 ```bash
-openclaw gateway restart
+npx -y @colinlu50/openclaw-lark-stream install
 ```
 
 > 如果之前安装过官方插件，先卸载：
@@ -39,7 +44,7 @@ cd openclaw-lark-stream && npm install && npm run build
 openclaw gateway restart
 ```
 
-## 配置
+## ⚙️ 配置
 
 卡片底栏默认显示耗时和完成状态，如需关闭：
 
@@ -51,6 +56,6 @@ openclaw config set channels.feishu.footer.status false   # 隐藏完成状态
 - **elapsed** — 卡片底栏显示总响应耗时（如 `耗时 3.2s`）
 - **status** — 卡片底栏显示完成状态（`已完成` / `出错` / `已停止`）
 
-## 许可证
+## 📄 许可证
 
 MIT — 与上游项目相同。

package/bin/openclaw-lark.js

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
 
-import { execFileSync, execSync } from "node:child_process";
-import { existsSync, readFileSync, rmSync, writeFileSync } from "node:fs";
-import { dirname, join } from "node:path";
+import { execSync } from "node:child_process";
+import { createInterface } from "node:readline";
+import { existsSync, readdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
 
 const SELF_PACKAGE = "@colinlu50/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");
 
@@ -16,58 +16,177 @@ const args = process.argv.slice(2);
 const subcommand = args[0];
 
 // ── install / update ──
-// 1) Let @larksuite/openclaw-lark-tools run the full interactive setup
-//    (version check, bot config, gateway restart, etc.)
-// 2) Then swap the installed official code with our fork
 if (subcommand === "install" || subcommand === "update") {
-  // Step 1: Run tools for interactive setup (installs official + configures bot)
-  // Don't exit on error — config is already saved, we still need to swap the code.
-  const toolsArgs = args.slice();
-  try {
-    runTools(toolsArgs);
-  } catch {
-    // Tools may fail on gateway restart etc. — that's OK, config is preserved.
-  }
+  await runInstall();
+  process.exit(0);
+}
+
+// ── All other commands: show help ──
+console.log(`Usage: npx ${SELF_PACKAGE} install`);
+console.log(`       npx ${SELF_PACKAGE} update`);
+process.exit(0);
+
+// ---------------------------------------------------------------------------
+// Install flow
+// ---------------------------------------------------------------------------
+
+async function runInstall() {
+  // 1. Version check
+  checkOpenClawVersion();
 
-  // Step 2: Clean up old plugin dirs + config references, then install ours
+  // 2. Clean stale state
+  cleanPluginState();
+
+  // 3. Install our plugin
+  console.log(`\nInstalling ${SELF_PACKAGE}...`);
   try {
-    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}...`);
-    // Use execSync with shell so that .cmd shims are resolved on Windows
-    execSync(`openclaw plugins install ${SELF_PACKAGE}`, {
-      stdio: "inherit",
-    });
-    console.log(`\n✅ ${SELF_PACKAGE} installed successfully.`);
-    console.log("Run: openclaw gateway restart");
+    execSync(`openclaw plugins install ${SELF_PACKAGE}`, { stdio: "inherit" });
   } catch (error) {
     console.error(`\n❌ Failed to install ${SELF_PACKAGE}.`);
     console.error(error.message || error);
-    console.error("You can retry with: openclaw plugins install " + SELF_PACKAGE);
+    console.error(`\nYou can retry with: openclaw plugins install ${SELF_PACKAGE}`);
     process.exit(error.status ?? 1);
   }
-  process.exit(0);
+  console.log(`\n✅ Plugin installed successfully.`);
+
+  // 4. Bot configuration (interactive)
+  await configureBotIfNeeded();
+
+  // 5. Restart gateway
+  console.log("\nRestarting gateway...");
+  try {
+    execSync("openclaw gateway restart", { stdio: "inherit" });
+  } catch {
+    console.log("Gateway restart failed. You can manually run: openclaw gateway restart");
+  }
+
+  console.log("\n🎉 All done!");
 }
 
-// ── All other commands: delegate to @larksuite/openclaw-lark-tools ──
-try {
-  runTools(args);
-} catch (error) {
-  process.exit(error.status ?? 1);
+// ---------------------------------------------------------------------------
+// Version check
+// ---------------------------------------------------------------------------
+
+function checkOpenClawVersion() {
+  try {
+    const ver = execSync("openclaw -v", { encoding: "utf8" }).trim();
+    console.log(`OpenClaw version: ${ver}`);
+  } catch {
+    console.error("❌ OpenClaw not found. Install it first: npm install -g openclaw");
+    process.exit(1);
+  }
+}
+
+// ---------------------------------------------------------------------------
+// Bot configuration
+// ---------------------------------------------------------------------------
+
+async function configureBotIfNeeded() {
+  const cfg = readConfig();
+  const existing = cfg.channels?.feishu;
+
+  if (existing?.appId) {
+    console.log(`\nFound existing bot config (App ID: ${existing.appId}).`);
+    const reuse = await ask("Use existing bot config? (Y/n): ");
+    if (reuse.toLowerCase() !== "n") {
+      console.log("Keeping existing config.");
+      return;
+    }
+  }
+
+  console.log("\n── Feishu Bot Setup ──");
+  console.log("You need a Feishu bot app. Create one at: https://open.feishu.cn/app\n");
+
+  const appId = await ask("App ID: ");
+  const appSecret = await ask("App Secret: ");
+
+  if (!appId || !appSecret) {
+    console.log("Skipped. You can configure manually in ~/.openclaw/openclaw.json");
+    return;
+  }
+
+  // Ask for domain
+  const domainChoice = await ask("Domain - feishu or lark? (feishu): ");
+  const domain = domainChoice === "lark" ? "lark" : "feishu";
+
+  // Write config
+  if (!cfg.channels) cfg.channels = {};
+  cfg.channels.feishu = {
+    ...(cfg.channels.feishu || {}),
+    enabled: true,
+    appId,
+    appSecret,
+    connectionMode: "websocket",
+    domain,
+    streaming: true,
+    defaultAccount: "main",
+    replyMode: {
+      direct: "streaming",
+      group: "streaming",
+      default: "streaming",
+    },
+    accounts: {
+      ...(cfg.channels?.feishu?.accounts || {}),
+      main: { appId, appSecret },
+    },
+    dmPolicy: cfg.channels?.feishu?.dmPolicy || "pairing",
+    groupPolicy: cfg.channels?.feishu?.groupPolicy || "open",
+  };
+
+  writeFileSync(CONFIG_FILE, JSON.stringify(cfg, null, 2) + "\n", "utf8");
+  console.log(`\n✅ Bot configured (App ID: ${appId}).`);
+}
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+function ask(prompt) {
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  return new Promise((resolve) => {
+    rl.question(prompt, (answer) => {
+      rl.close();
+      resolve(answer.trim());
+    });
+  });
+}
+
+function readConfig() {
+  if (!existsSync(CONFIG_FILE)) return {};
+  try {
+    return JSON.parse(readFileSync(CONFIG_FILE, "utf8"));
+  } catch {
+    return {};
+  }
 }
 
 /**
- * Remove stale plugin references from openclaw.json so that
- * `openclaw plugins install` doesn't fail config validation.
+ * Remove all plugin directories, staging leftovers, and stale config
+ * references so that openclaw has a clean state for the next install.
  */
+function cleanPluginState() {
+  for (const dir of [OFFICIAL_DIR, SELF_DIR]) {
+    if (existsSync(dir)) {
+      console.log(`Removing ${dir}...`);
+      rmSync(dir, { recursive: true, force: true });
+    }
+  }
+  // Remove leftover staging directories (.openclaw-install-stage-*)
+  if (existsSync(EXTENSIONS_DIR)) {
+    try {
+      for (const entry of readdirSync(EXTENSIONS_DIR)) {
+        if (entry.startsWith(".openclaw-install-stage-")) {
+          const p = join(EXTENSIONS_DIR, entry);
+          console.log(`Removing staging dir ${p}...`);
+          rmSync(p, { recursive: true, force: true });
+        }
+      }
+    } catch { /* ignore */ }
+  }
+  cleanConfigReferences("openclaw-lark");
+  cleanConfigReferences("openclaw-lark-stream");
+}
+
 function cleanConfigReferences(pluginId) {
   if (!existsSync(CONFIG_FILE)) return;
   try {
@@ -90,44 +209,7 @@ function cleanConfigReferences(pluginId) {
     }
     if (changed) {
       writeFileSync(CONFIG_FILE, JSON.stringify(cfg, null, 2) + "\n", "utf8");
-      console.log(`Cleaned "${pluginId}" references from ${CONFIG_FILE}`);
+      console.log(`Cleaned "${pluginId}" references from config.`);
     }
-  } catch {
-    // Config parse failure — let openclaw handle it
-  }
-}
-
-function runTools(fwdArgs) {
-  let version = "latest";
-  const vIdx = fwdArgs.indexOf("--tools-version");
-  if (vIdx !== -1) {
-    version = fwdArgs[vIdx + 1];
-    fwdArgs.splice(vIdx, 2);
-  }
-
-  const allArgs = ["--yes", `@larksuite/openclaw-lark-tools@${version}`, ...fwdArgs];
-
-  if (process.platform === "win32") {
-    const npxCli = join(
-      dirname(process.execPath),
-      "node_modules",
-      "npm",
-      "bin",
-      "npx-cli.js",
-    );
-    execFileSync(process.execPath, [npxCli, ...allArgs], {
-      stdio: "inherit",
-      env: {
-        ...process.env,
-        NODE_OPTIONS: [
-          process.env.NODE_OPTIONS,
-          "--disable-warning=DEP0190",
-        ]
-          .filter(Boolean)
-          .join(" "),
-      },
-    });
-  } else {
-    execFileSync("npx", allArgs, { stdio: "inherit" });
-  }
+  } catch { /* ignore */ }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colinlu50/openclaw-lark-stream",
-  "version": "2026.3.29",
+  "version": "2026.3.31",
   "description": "OpenClaw Lark/Feishu channel plugin",
   "main": "./dist/index.js",
   "type": "module",