herdrchat 1.3.1 → 1.3.3

package/README.md

@@ -2,7 +2,7 @@
 
 # herdrchat
 
-Every terminal hc runs, in the chat app you already use: Feishu or Telegram.
+A chat front-end for [herdr](https://herdr.dev): every terminal it runs, in Feishu or Telegram.
 
 [English](README.md) · [简体中文](README.zh.md)
 
@@ -31,7 +31,9 @@ until herdrchat learns to read their conversations too.
 
 ## You need
 
-- **hc** running on this machine, with at least one session ([herdr.dev](https://herdr.dev)).
+- **herdr**: herdrchat is built on it and does nothing without it. Install it from
+  [herdr.dev](https://herdr.dev) first; its **hc** must run on this machine, with at least
+  one session.
 - **Node.js 20** or newer, on **macOS or Linux**.
 - **Feishu**: a Feishu team (not Lark) where you may create a custom app and publish it.
   **Telegram**: a Telegram account. Use one app, or both at once.

package/README.zh.md

@@ -2,7 +2,7 @@
 
 # herdrchat
 
-hc 跑的每个终端，都能在你常用的聊天软件里看到和回复：飞书或 Telegram。
+[herdr](https://herdr.dev) 的聊天前端：它跑的每个终端，都能在飞书或 Telegram 里看到和回复。
 
 [English](README.md) · [简体中文](README.zh.md)
 
@@ -27,7 +27,8 @@ agent 干活时说的话实时可见，它问你的问题点按钮就能回答
 
 ## 需要什么
 
-- 这台机器上在跑 **hc**，至少有一个 session（[herdr.dev](https://herdr.dev)）。
+- **herdr**：herdrchat 是基于它做的，没有它什么都做不了。请先从 [herdr.dev](https://herdr.dev) 安装；
+  它的 **hc** 要在这台机器上跑着，至少有一个 session。
 - **Node.js 20** 或更新版本，系统是 **macOS 或 Linux**。
 - **飞书**：一个能创建并发布企业自建应用的飞书团队（暂不支持 Lark 国际版）。
   **Telegram**：一个 Telegram 账号。可以只用一个，也可以两个同时用。

package/bin/cli.mjs

@@ -21,7 +21,10 @@ import { fileURLToPath } from 'node:url';
 
 const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
 const GUIDE = 'https://github.com/zhangxiangliang/herdrchat/blob/main/docs/guide.md';
-const USAGE = `herdrchat <command> [--profile <name>]
+const HERDR = 'herdrchat is built on herdr: it mirrors the terminals that hc (herdr-core) runs.\nIt needs hc on this machine: install herdr first, from https://herdr.dev';
+const USAGE = `herdrchat: herdr's terminals in Feishu or Telegram. Needs herdr (https://herdr.dev).
+
+herdrchat <command> [--profile <name>]
 
   init       make the profile's config.env (--chat feishu|telegram picks the app)
   start      start (or restart) it: the service, or else its own hc terminal
@@ -155,7 +158,7 @@ async function waitConnected(since) {
 // Nothing else, so no agent's variables come along.
 function botEnv() {
   const hcPath = findHc();
-  if (!hcPath) throw new Error('hc is not on PATH: install herdr-core first (https://herdr.dev)');
+  if (!hcPath) throw new Error(`hc is not on PATH. ${HERDR}`);
   const env = { HERDRCHAT_HC: hcPath, HERDRCHAT_PROFILE: places.profile };
   for (const k of ['PATH', 'HERDRCHAT_HOME', 'XDG_CONFIG_HOME', 'XDG_STATE_HOME']) if (process.env[k]) env[k] = process.env[k];
   return env;
@@ -182,6 +185,8 @@ const commands = {
   init() {
     const chatName = chatFlag || 'feishu';
     if (!chatNames().includes(chatName)) fail(`--chat ${chatName}: the chat apps are ${chatNames().join(', ')}`);
+    // the settings can be made first, but nothing works without herdr: said before anything
+    if (!findHc()) console.log(`⚠️  hc is not on PATH. ${HERDR}\n`);
     makeDirs();
     if (fs.existsSync(CONFIG_FILE)) {
       console.log(`${CONFIG_FILE} is there already; open it and edit it, then run \`herdrchat start${again}\`.`);
@@ -269,7 +274,7 @@ const commands = {
     // how it runs: the service, an hc terminal, or not at all
     const svc = hcThere ? service() : null;
     if (!hcThere) {
-      console.log('running   unknown: hc is not on PATH (install herdr-core: https://herdr.dev)');
+      console.log('running   unknown: hc is not on PATH; herdrchat is built on herdr: install it from https://herdr.dev');
     } else {
       const inTerminal = cfg.sessions.length ? (await terminalState(cfg.sessions[0])) === 'live' : false;
       if (svc?.installed()) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "herdrchat",
-  "version": "1.3.1",
-  "description": "Chat front-ends for hc: every terminal hc runs, in the chat app you use",
+  "version": "1.3.3",
+  "description": "A chat front-end for herdr: every terminal hc runs, in Feishu or Telegram",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zhangxiangliang/herdrchat.git"
@@ -37,6 +37,19 @@
   "devDependencies": {
     "@semantic-release/changelog": "^7.0.0",
     "@semantic-release/git": "^11.0.1",
-    "semantic-release": "^25.0.9"
-  }
+    "semantic-release": "^25.0.9",
+    "yaml": "^2.9.1"
+  },
+  "keywords": [
+    "herdr",
+    "hc",
+    "herdr-core",
+    "feishu",
+    "lark",
+    "telegram",
+    "chatops",
+    "claude-code",
+    "agents",
+    "terminal"
+  ]
 }

package/skills/herdrchat/SKILL.md

@@ -1,6 +1,13 @@
 ---
 name: herdrchat
-description: Set up, run and look after herdrchat, which mirrors every herdr-app (hc) tab into Feishu (a group per tab) or Telegram (a topic per tab): first setup of either app, start, stop, status, logs, running it as a service, settings, fixing problems, the Feishu developer console and @BotFather. Use for anything about herdrchat or its Feishu or Telegram bot, even "set up the Telegram bot", "is it running", "it does not post" or "mute the workers". Trigger with "/herdrchat", "/herdrchat setup", "/herdrchat status", "/herdrchat fix".
+description: >-
+  Set up, run and look after herdrchat, which mirrors every herdr-app (hc) tab into
+  Feishu (a group per tab) or Telegram (a topic per tab): first setup of either app,
+  start, stop, status, logs, running it as a service, settings, fixing problems, the
+  Feishu developer console and @BotFather. Use for anything about herdrchat or its
+  Feishu or Telegram bot, even "set up the Telegram bot", "is it running", "it does not
+  post" or "mute the workers". Trigger with "/herdrchat", "/herdrchat setup",
+  "/herdrchat status", "/herdrchat fix".
 ---
 
 # herdrchat
@@ -22,7 +29,7 @@ from the package (`config.env.example`, `docs/guide.md`) are in the installed pa
 
 | Command | Do |
 |---|---|
-| `/herdrchat setup` | First ask which chat app (Feishu, Telegram, or both: the second one on its own profile). Telegram: `/herdrchat telegram setup`. Feishu, in this order: create the app, the bot ability and the scopes (`references/feishu.md`); `herdrchat init` and fill `config.env` with the user (App ID, App Secret, `HERDR_SESSIONS`: `ls ~/.local/state/herdr-core` lists the sessions); `herdrchat start` (the console's long-connection check needs it running); events and callbacks; publish a version; the user messages the bot and adds the `FEISHU_OWNER_OPEN_ID` line it answers with; `herdrchat start` again; offer `/herdrchat auth` and `herdrchat install`. |
+| `/herdrchat setup` | First check herdr is there (`command -v hc`): herdrchat is built on herdr and does nothing without it; when it is missing, say so, point to https://herdr.dev, and stop until it is installed. Then ask which chat app (Feishu, Telegram, or both: the second one on its own profile). Telegram: `/herdrchat telegram setup`. Feishu, in this order: create the app, the bot ability and the scopes (`references/feishu.md`); `herdrchat init` and fill `config.env` with the user (App ID, App Secret, `HERDR_SESSIONS`: `ls ~/.local/state/herdr-core` lists the sessions); `herdrchat start` (the console's long-connection check needs it running); events and callbacks; publish a version; the user messages the bot and adds the `FEISHU_OWNER_OPEN_ID` line it answers with; `herdrchat start` again; offer `/herdrchat auth` and `herdrchat install`. |
 | `/herdrchat status` | `herdrchat status`; explain each line; on errors, `/herdrchat fix`. |
 | `/herdrchat start`, `/herdrchat stop` | Read `config.env` (its `HERDR_SESSIONS`) in one step, then `herdrchat start` / `stop` in the next; never both at once. With a service installed they go through it. |
 | `/herdrchat install`, `/herdrchat uninstall` | Run it as a service of the system (launchd on macOS, systemd on Linux): it starts at login and comes back after a crash, whatever happens to the hc cores. Recommended once it works. Read the config first; after a node upgrade, install again (`herdrchat status` says so). |