askhuman 0.4.2 → 0.5.0

package/README.md

@@ -1,17 +1,25 @@
 # askhuman
 
-跨平台「Human-in-the-loop」交互工具。命令行 `AskHuman` 在 AI 助手需要确认/补充时弹出窗口（或经 Telegram / 钉钉 / 飞书）收集人类回应，并把结果按固定区块写到 stdout。
+English | [简体中文](https://github.com/Naituw/AskHuman/blob/main/README.md)
 
-底层为单一可执行文件（Tauri 2 / Rust）。本 npm 包通过「平台子包」分发：安装时只会拉取与当前平台匹配的一个二进制。
+Cross-platform "human-in-the-loop" interaction tool. When an AI assistant is about to end a conversation or needs confirmation, the `AskHuman` CLI pops up a window (or uses Telegram / Slack / DingTalk / Feishu) so you can ask follow-ups, pick options, add text, or attach images — and the result is returned to the AI.
 
-## 单独使用
+跨平台「Human-in-the-loop」交互工具。当 AI 助手准备结束对话或需要确认时，命令行 `AskHuman` 弹出窗口（或经 Telegram / Slack / 钉钉 / 飞书），让你继续提问、勾选选项、补充文字或附带图片，并把结果回传给 AI。
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Naituw/AskHuman/main/assets/channels.webp" alt="Reply to your agent from the local popup, Telegram, Slack, DingTalk, or Feishu" width="900">
+</p>
+
+Under the hood it's a single executable (Tauri 2 / Rust). This npm package distributes it via per-platform subpackages: installing fetches only the one binary matching your current platform.
+
+## Standalone use
 
 ```bash
 npm i -g askhuman
-AskHuman "要不要继续？" -o "继续" -o "停止"
+AskHuman "Continue?" -o "Continue" -o "Stop"
 ```
 
-## 作为依赖（程序集成）
+## As a dependency (programmatic use)
 
 ```bash
 npm i askhuman
@@ -22,36 +30,36 @@ import { getBinaryPath, isAvailable } from "askhuman";
 import { spawnSync } from "node:child_process";
 
 if (!isAvailable()) {
-  // 二进制未就位：跳过人工确认环节，避免阻塞流程
+  // Binary not in place: skip the human-confirmation step to avoid blocking the flow
 } else {
-  const r = spawnSync(getBinaryPath(), ["要继续吗？", "-o", "继续", "-o", "停止"], {
+  const r = spawnSync(getBinaryPath(), ["Continue?", "-o", "Continue", "-o", "Stop"], {
     encoding: "utf8",
   });
   if (r.status === 3) {
-    // 当前环境无任何可用 channel（GUI 打不开且未配置会话型渠道）：降级处理
+    // No usable channel in this environment (GUI can't open and no session channel configured): degrade gracefully
   } else if (r.status === 0) {
-    // 成功：解析 r.stdout 的结果区块
+    // Success: parse the result blocks from r.stdout
     console.log(r.stdout);
   }
 }
 ```
 
-`getBinaryPath()` 解析顺序：环境变量 `ASKHUMAN_BINARY`（兼容旧 `HUMANINLOOP_BINARY`）→ 平台子包 → 系统 `PATH`。
+`getBinaryPath()` resolution order: env var `ASKHUMAN_BINARY` (legacy `HUMANINLOOP_BINARY` still works) → platform subpackage → system `PATH`.
 
-## 退出码契约
+## Exit code contract
 
-| 退出码 | 含义 |
+| Exit code | Meaning |
 |---|---|
-| `0` | 成功拿到结果，或用户取消（输出 `[状态]`） |
-| `3` | 无任何可用 channel（本地弹窗打不开且未配置会话型渠道）——下游应降级 |
-| `1` | 其他异常 |
+| `0` | Got a result, or the user cancelled (emits `[Status]`) |
+| `3` | No usable channel (local popup can't open and no session channel configured) — downstream should degrade |
+| `1` | Other error |
 
-stdout 只含结果区块（`[选择的选项]`/`[用户输入]`/`[图片]`/`[文件]`/`[状态]`），所有日志与报错走 stderr。
+stdout contains only the result blocks (`[Selected options]` / `[User input]` / `[Images]` / `[Files]` / `[Status]`); all logs and errors go to stderr.
 
-## 平台与系统依赖
+## Platforms and system dependencies
 
-支持 macOS（arm64/x64）、Windows（x64）、Linux（x64）。
+Supports macOS (arm64/x64), Windows (x64), and Linux (x64).
 
-> Linux 运行 GUI 弹窗需系统具备 WebKitGTK（如 `libwebkit2gtk-4.1`）。若缺失且配置了会话型渠道（Telegram / 钉钉 / 飞书），会自动改走该渠道；若皆不可用，则以退出码 `3` 提示降级。
+> Running the GUI popup on Linux needs system WebKitGTK (e.g. `libwebkit2gtk-4.1`). If it's missing and a session-based channel is configured (Telegram / Slack / DingTalk / Feishu), AskHuman uses that channel automatically; if none is available, it signals degradation with exit code `3`.
 
-更多信息见项目仓库：<https://github.com/Naituw/AskHuman>
+More info in the project repo: <https://github.com/Naituw/AskHuman>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "askhuman",
-  "version": "0.4.2",
-  "description": "Human-in-the-loop interaction tool. The `AskHuman` CLI pops up a window (or uses Telegram) to collect human input and prints the result to stdout — usable standalone or as a dependency.",
+  "version": "0.5.0",
+  "description": "Human-in-the-loop interaction tool. The `AskHuman` CLI pops up a window (or uses Telegram / Slack / DingTalk / Feishu) to collect a human response and return it to the AI — usable standalone or as a dependency.",
   "license": "MIT",
   "author": "Naituw",
   "homepage": "https://github.com/Naituw/AskHuman",
@@ -33,9 +33,9 @@
     "prompt"
   ],
   "optionalDependencies": {
-    "@humaninloop/darwin-arm64": "0.4.2",
-    "@humaninloop/darwin-x64": "0.4.2",
-    "@humaninloop/win32-x64": "0.4.2",
-    "@humaninloop/linux-x64": "0.4.2"
+    "@humaninloop/darwin-arm64": "0.5.0",
+    "@humaninloop/darwin-x64": "0.5.0",
+    "@humaninloop/win32-x64": "0.5.0",
+    "@humaninloop/linux-x64": "0.5.0"
   }
 }