botmux 2.12.2 → 2.13.0

package/README.en.md

@@ -424,6 +424,7 @@ botmux setup
 | `botmux autostart enable` | Register boot-time autostart (macOS launchd / Linux user systemd, no sudo) |
 | `botmux autostart disable` | Unregister boot-time autostart |
 | `botmux autostart status` | Show autostart status |
+| `botmux dashboard` | Print a fresh Web Dashboard URL (rotates the token; previous URL becomes invalid) |
 
 ### Boot-time Autostart
 
@@ -453,6 +454,34 @@ These require the `~/.botmux/bin/botmux` wrapper, which the daemon writes at sta
 
 ---
 
+## Web Dashboard
+
+botmux ships a LAN-accessible Web Dashboard for managing all sessions and scheduled tasks across every configured bot.
+
+```bash
+botmux dashboard
+# prints: http://<lan-ip>:7891/?t=<token>
+```
+
+Each invocation rotates the token — previous URLs are invalidated immediately. This is by design, so a leaked link stops working as soon as you fetch a new one.
+
+v1 features:
+- **Sessions board** — every active and closed session across every bot, filterable by CLI / status / adopt / free-text. The detail drawer exposes a "📍 定位到飞书话题" button that posts a marker into the original thread (workaround for Feishu having no public topic deep-link), then opens AppLink to the chat. Also: copy IDs, close session, open xterm.
+- **Schedules board** — every scheduled task across every bot, with Run-now / Pause / Resume actions.
+
+Environment variables (set in `~/.botmux/.env`):
+
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `BOTMUX_DASHBOARD_HOST` | `0.0.0.0` | Dashboard HTTP bind address |
+| `BOTMUX_DASHBOARD_PORT` | `7891` | Dashboard HTTP port |
+| `BOTMUX_DASHBOARD_EXTERNAL_HOST` | `WEB_EXTERNAL_HOST` or LAN-IP autodetect | Host used in the printed URL |
+| `BOTMUX_DAEMON_IPC_BASE_PORT` | `7892` | Per-daemon IPC port = base + botIndex |
+
+The dashboard runs as its own pm2 process (`botmux-dashboard`) — `pnpm daemon:restart` brings it up alongside every bot daemon. Each daemon exposes a localhost-only IPC at `127.0.0.1:7892+botIndex`; the dashboard process is a thin reverse proxy + token gate. The HMAC secret at `~/.botmux/.dashboard-secret` (mode `0600`) is generated on first start and is used only to sign `botmux dashboard` rotation requests — it never reaches the browser.
+
+---
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).

package/README.md

@@ -357,6 +357,7 @@ botmux autostart enable
 | `botmux autostart enable` | 注册开机自启（macOS launchd / Linux user systemd，无需 sudo） |
 | `botmux autostart disable` | 注销开机自启 |
 | `botmux autostart status` | 查看自启状态 |
+| `botmux dashboard` | 输出一次 Web Dashboard URL（每次刷 token，旧链接立即失效） |
 
 ### 开机自启
 
@@ -386,6 +387,34 @@ botmux autostart enable
 
 ---
 
+## Web Dashboard
+
+botmux 启动后会自带一个 Web Dashboard 用来管理所有会话和定时任务。
+
+```bash
+botmux dashboard
+# 输出: http://<lan-ip>:7891/?t=<token>
+```
+
+每次跑 `botmux dashboard` 都会换一个 token，老 URL 立即失效——这是有意为之，符合一次一密的取链方式。
+
+页面功能（v1）：
+- **Sessions**：跨所有 bot 列出活跃和已关闭会话，支持按 CLI / 状态 / adopt / 文本搜索过滤。点进 detail drawer 后可以「定位到飞书话题」（机器人在原话题发一条 📍 标记 + 浏览器自动开 chat AppLink，规避飞书没有公开 topic deep-link 的限制）、复制各种 ID、关闭会话。
+- **Schedules**：列出所有定时任务，可以 Run now / Pause / Resume。
+
+环境变量（写在 `~/.botmux/.env`）：
+
+| 变量 | 默认 | 说明 |
+|------|------|------|
+| `BOTMUX_DASHBOARD_HOST` | `0.0.0.0` | dashboard HTTP 绑定地址 |
+| `BOTMUX_DASHBOARD_PORT` | `7891` | dashboard HTTP 端口 |
+| `BOTMUX_DASHBOARD_EXTERNAL_HOST` | `WEB_EXTERNAL_HOST` 或 LAN IP 自动探测 | CLI 输出 URL 用的 host |
+| `BOTMUX_DAEMON_IPC_BASE_PORT` | `7892` | 每个 daemon 的 IPC 端口 = base + botIndex |
+
+dashboard 走单独 pm2 进程 `botmux-dashboard`，跟着 `pnpm daemon:restart` 一起起停。每个 daemon 在 127.0.0.1 暴露内部 IPC（仅本机），dashboard 进程做反向代理 + 鉴权。`.dashboard-secret` 在首次启动时生成（`~/.botmux/.dashboard-secret`，mode 0600），仅用于 `botmux dashboard` 命令的 HMAC 鉴权，不下发给浏览器。
+
+---
+
 ## 配置
 
 通过 `~/.botmux/bots.json` 配置机器人。运行 `botmux setup` 交互式创建，或手动编辑。

package/dist/cli.js

@@ -17,12 +17,13 @@
  *   botmux autostart enable|disable|status — manage boot-time autostart (launchd / user systemd)
  */
 import { execSync, spawnSync, spawn } from 'node:child_process';
-import { existsSync, mkdirSync, readFileSync, writeFileSync, renameSync, readdirSync, readlinkSync, appendFileSync } from 'node:fs';
+import { existsSync, mkdirSync, readFileSync, writeFileSync, renameSync, readdirSync, readlinkSync, appendFileSync, statSync, unlinkSync } from 'node:fs';
 import { join, dirname } from 'node:path';
 import { homedir } from 'node:os';
 import { fileURLToPath } from 'node:url';
 import { createInterface } from 'node:readline';
 import { createRequire } from 'node:module';
+import { createHmac, randomBytes } from 'node:crypto';
 import { enableAutostart, disableAutostart, autostartStatus, refreshAutostart } from './autostart.js';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -108,6 +109,21 @@ function ecosystemConfig() {
         out_file: join(LOG_DIR, `daemon-${i}-out.log`),
         env: { SESSION_DATA_DIR: DATA_DIR, BOTMUX_BOT_INDEX: String(i) },
     }));
+    apps.push({
+        name: 'botmux-dashboard',
+        script: join(PKG_ROOT, 'dist', 'dashboard.js'),
+        cwd: PKG_ROOT,
+        autorestart: true,
+        max_restarts: 10,
+        restart_delay: 3000,
+        error_file: join(LOG_DIR, 'dashboard-error.log'),
+        out_file: join(LOG_DIR, 'dashboard-out.log'),
+        merge_logs: true,
+        env: {
+            BOTMUX_DASHBOARD_HOST: process.env.BOTMUX_DASHBOARD_HOST ?? '0.0.0.0',
+            BOTMUX_DASHBOARD_PORT: process.env.BOTMUX_DASHBOARD_PORT ?? '7891',
+        },
+    });
     const cfg = { apps };
     const tmpFile = join(CONFIG_DIR, 'ecosystem.config.json');
     writeFileSync(tmpFile, JSON.stringify(cfg, null, 2));
@@ -368,6 +384,28 @@ function cmdStart() {
         console.log(`   autostart unit 已同步到当前 Node/cli.js 路径`);
     }
 }
+/**
+ * Wipe stale dashboard-daemon descriptors (mtime older than 5 minutes).
+ * Live daemons refresh their descriptor every 30s via heartbeat; anything
+ * older is from a daemon that exited without cleaning up. Called as part of
+ * the pm2 zombie-cleanup flow so the dashboard registry stays consistent.
+ */
+function cleanupStaleDaemonDescriptors() {
+    const regDir = join(DATA_DIR, 'dashboard-daemons');
+    if (!existsSync(regDir))
+        return;
+    for (const f of readdirSync(regDir)) {
+        if (!f.endsWith('.json'))
+            continue;
+        const fp = join(regDir, f);
+        try {
+            const stat = statSync(fp);
+            if (Date.now() - stat.mtimeMs > 5 * 60_000)
+                unlinkSync(fp);
+        }
+        catch { /* ignore */ }
+    }
+}
 /** Delete all pm2 processes matching botmux / botmux-* under the given PM2_HOME. */
 function deleteAllBotmuxProcesses(home = PM2_HOME) {
     try {
@@ -448,6 +486,8 @@ function cmdStop() {
         }
     }
     catch { /* */ }
+    // Wipe abandoned dashboard-daemon descriptors left behind by stopped daemons.
+    cleanupStaleDaemonDescriptors();
     if (!stopped)
         console.log('daemon 未在运行。');
 }
@@ -462,6 +502,8 @@ function cmdRestart() {
     cleanupLegacyPm2();
     // Delete all botmux processes (handles both old single-process and new multi-process)
     deleteAllBotmuxProcesses();
+    // Wipe abandoned dashboard-daemon descriptors left behind by killed daemons.
+    cleanupStaleDaemonDescriptors();
     const cfg = ecosystemConfig();
     runPm2(['start', cfg]);
     if (refreshAutostart({ pkgRoot: PKG_ROOT, configDir: CONFIG_DIR, logDir: LOG_DIR })) {
@@ -550,6 +592,44 @@ function cmdUpgrade() {
         process.exit(1);
     }
 }
+/**
+ * Print a fresh dashboard URL by HMAC-authing to the dashboard process's
+ * loopback rotation endpoint. Each call invalidates the previously-issued
+ * token, so sharing a URL is the same as sharing a one-shot session.
+ */
+async function cmdDashboard() {
+    const SECRET_PATH = join(CONFIG_DIR, '.dashboard-secret');
+    if (!existsSync(SECRET_PATH)) {
+        console.error('Dashboard not initialised. Run `pnpm daemon:restart` first.');
+        process.exit(1);
+    }
+    const secret = readFileSync(SECRET_PATH, 'utf8').trim();
+    const ts = Math.floor(Date.now() / 1000).toString();
+    const nonce = randomBytes(8).toString('hex');
+    const sig = createHmac('sha256', secret).update(`${ts}:${nonce}`).digest('base64url');
+    const port = process.env.BOTMUX_DASHBOARD_PORT ?? '7891';
+    let res;
+    try {
+        res = await fetch(`http://127.0.0.1:${port}/__cli/rotate`, {
+            method: 'POST',
+            headers: {
+                'X-Botmux-Cli-Ts': ts,
+                'X-Botmux-Cli-Nonce': nonce,
+                'X-Botmux-Cli-Auth': sig,
+            },
+        });
+    }
+    catch {
+        console.error(`dashboard process not reachable on 127.0.0.1:${port} — \`pnpm daemon:restart\` will start it`);
+        process.exit(1);
+    }
+    if (!res.ok) {
+        console.error('Rotation failed:', res.status, await res.text());
+        process.exit(1);
+    }
+    const body = await res.json();
+    console.log(body.url);
+}
 /**
  * Resolve the session data directory.
  * Priority: SESSION_DATA_DIR env > daemon breadcrumb (~/.botmux/.data-dir) > default (~/.botmux/data)
@@ -1160,6 +1240,7 @@ botmux v${getVersion()} — IM ↔ AI 编程 CLI 桥接
   logs        查看 daemon 日志（--lines N, --bot <index>）
   status      查看 daemon 状态
   upgrade     升级到最新版本
+  dashboard   打印新的 Web Dashboard 一次性登录 URL（旧 token 同时失效）
   list        列出活跃会话（交互式选择并连接 tmux）
               --plain  纯文本表格输出（管道/脚本场景）
   delete <id>      关闭指定会话（支持 ID 前缀匹配）
@@ -1263,13 +1344,18 @@ function argFlag(args, flag) {
     return args.includes(flag);
 }
 /** Extract positional args, skipping --flag and the value that follows it
- *  (for --flag <value> style).  --flag=value style is self-contained. */
-function positionals(args) {
+ *  (for --flag <value> style).  --flag=value style is self-contained.
+ *  `booleanFlags` lists flags that take no value — without this hint the
+ *  parser swallows the *next* arg as the flag's value, which silently eats
+ *  positional content (or, worse, a following --flag's value). */
+function positionals(args, booleanFlags = []) {
     const out = [];
     for (let i = 0; i < args.length; i++) {
         const a = args[i];
         if (a.startsWith('--')) {
-            if (!a.includes('=') && i + 1 < args.length)
+            const flagName = a.includes('=') ? a.slice(0, a.indexOf('=')) : a;
+            const isBoolean = booleanFlags.includes(flagName);
+            if (!a.includes('=') && !isBoolean && i + 1 < args.length)
                 i++; // skip value
             continue;
         }
@@ -1669,7 +1755,7 @@ async function cmdSend(rest) {
         content = readFileSync(contentFile, 'utf-8');
     }
     else {
-        const pos = positionals(rest);
+        const pos = positionals(rest, ['--card', '--text', '--top-level']);
         if (pos.length > 0) {
             content = pos.join(' ');
         }
@@ -1844,7 +1930,11 @@ async function cmdSend(rest) {
             // be the session owner), plus a `cc` line listing oncall owners so they
             // stay informed. Non-oncall: keep owner-only behaviour.
             const footerParts = ['[botmux](https://github.com/deepcoldy/botmux)'];
-            const addressing = buildFooterAddressing(s, oncallEntry);
+            // Top-level publish has no specific recipient — drop "发送给/cc" addressing
+            // so the message doesn't @ the session owner who isn't even in the target chat.
+            const addressing = sendTopLevel
+                ? { sendTo: undefined, cc: [] }
+                : buildFooterAddressing(s, oncallEntry);
             if (addressing.sendTo)
                 footerParts.push(`发送给：<at id=${addressing.sendTo}></at>`);
             if (addressing.cc.length > 0) {
@@ -1901,8 +1991,11 @@ async function cmdSend(rest) {
             }
             // Footer: mirror the card layout — a blank paragraph separates the body
             // from the addressing line(s). `发送给: @<caller>` always; oncall groups
-            // additionally get `cc: @<owners>` on the next line.
-            const addressing = buildFooterAddressing(s, oncallEntry);
+            // additionally get `cc: @<owners>` on the next line. Top-level publish
+            // has no specific recipient — skip addressing entirely.
+            const addressing = sendTopLevel
+                ? { sendTo: undefined, cc: [] }
+                : buildFooterAddressing(s, oncallEntry);
             if (addressing.sendTo || addressing.cc.length > 0) {
                 if (postContent.length > 0)
                     postContent.push([{ tag: 'text', text: '' }]);
@@ -2106,6 +2199,9 @@ switch (command) {
     case 'upgrade':
         cmdUpgrade();
         break;
+    case 'dashboard':
+        await cmdDashboard();
+        break;
     case 'list':
     case 'ls':
         await cmdList();