agim-cli 1.4.9 → 1.5.1

package/README.md

@@ -15,18 +15,54 @@ It is designed for production use: persistent delivery, session continuity, huma
 
 ## Quick start
 
+You do not need to configure IM, systemd, tokens, or workspaces first.
+Start with the smallest loop: Web console + one working agent.
+
 ```bash
 npm install -g agim-cli
-agim                         # interactive setup wizard
-agim start
+agim go
 ```
 
-Web console: `http://localhost:3000`
+`agim go` will:
+
+1. Detect usable local agents such as Claude Code, Codex, Cursor, or Agim Agent.
+2. Help configure an Agim Agent model API if no agent is ready yet.
+3. Start Agim in the background and print the Web console URL plus the first access token.
+
+Default Web console: `http://localhost:3000`
 
 - Chat: `/`
 - Tasks: `/tasks`
 - Settings: `/settings`
 
+If you forget the URL or token path:
+
+```bash
+agim web
+```
+
+Local health check:
+
+```bash
+agim doctor
+```
+
+After the Web chat works, connect WeChat / Feishu / DingTalk from Settings.
+`agim quickstart` is kept as a compatibility alias.
+
+Common CLI entries:
+
+| Command | When to use |
+|---|---|
+| `agim` | Open the guided entry menu when you are unsure what to run |
+| `agim go` | First install: get one agent + Web working |
+| `agim web` | Recover the console URL, service state, or token path |
+| `agim web --open` | Open the Web console in your default browser |
+| `agim web --start --open` | Start the background service and open Web in one step |
+| `agim config` | Continue setup: Agent, IM, Web, admins |
+| `agim doctor` | Explain what is not ready locally |
+| `agim start --bg` / `status` / `restart` / `stop` | Service operations after setup |
+
 ## Choose your AI backend
 
 | Scenario | Recommended path |
@@ -112,11 +148,11 @@ Start from: `docs/README.md`
 
 ## Migration notes
 
-Legacy installs remain compatible:
+Current public surfaces use the Agim naming consistently:
 
-- command alias compatibility retained
-- legacy env naming retained
-- old data path autodetected
+- executable: `agim`
+- environment variables: `AGIM_*`
+- data paths: `~/.agim` and `~/.agim-workspaces`
 
 ## Development
 

package/README.zh-CN.md

@@ -15,18 +15,53 @@ Agim 是一个 **IM 到 AI Agent 的桥接系统**。
 
 ## 快速开始
 
+先不用配置 IM，也不用理解 systemd / token / 工作区。先把 Web 控制台跑起来，确认能和一个 Agent 对话：
+
 ```bash
 npm install -g agim-cli
-agim                        # 交互式向导
-agim start
+agim go
 ```
 
-Web 控制台：`http://localhost:3000`
+`agim go` 会做三件事：
+
+1. 检测本机可用的 Agent（Claude Code / Codex / Cursor / Agim Agent 等）。
+2. 如果没有可用 Agent，引导你配置 Agim Agent 的大模型 API。
+3. 后台启动 Agim，并打印 Web 控制台地址和首次访问 token。
+
+默认 Web 控制台：`http://localhost:3000`
 
 - 对话：`/`
 - 任务：`/tasks`
 - 设置：`/settings`
 
+忘记入口或 token 时：
+
+```bash
+agim web
+```
+
+本机体检：
+
+```bash
+agim doctor
+```
+
+跑通 Web 对话后，再到设置里连接微信 / 飞书 / 钉钉等 IM 渠道。
+`agim quickstart` 会作为兼容别名保留。
+
+常用 CLI 入口：
+
+| 命令 | 什么时候用 |
+|---|---|
+| `agim` | 不确定该运行哪个命令时，打开引导入口菜单 |
+| `agim go` | 第一次安装后，先跑通 Agent + Web |
+| `agim web` | 忘记控制台地址、服务状态或 token 路径 |
+| `agim web --open` | 用默认浏览器打开 Web 控制台 |
+| `agim web --start --open` | 后台启动服务并一步打开 Web |
+| `agim config` | 继续配置 Agent、IM、Web、管理员 |
+| `agim doctor` | 不知道卡在哪里时做本机体检 |
+| `agim start --bg` / `status` / `restart` / `stop` | 已配置后的服务运维 |
+
 ## 如何选择 Agent 后端
 
 | 场景 | 推荐路径 |
@@ -112,11 +147,11 @@ native 配置详见：`docs/llm-backends.md`
 
 ## 迁移说明
 
-历史安装保持兼容：
+当前公开入口统一使用 Agim 命名：
 
-- 旧命令别名可继续使用
-- 旧环境变量命名继续兼容
-- 旧数据目录会自动识别
+- 命令：`agim`
+- 环境变量：`AGIM_*`
+- 数据目录：`~/.agim` 与 `~/.agim-workspaces`
 
 ## 开发
 

package/bin/agim_rpc.py

@@ -1,7 +1,7 @@
 """agim_rpc — tiny Python client for the agim local RPC bridge.
 
 Spawned by `native_exec` via the bgjob wrapper, this module gives a
-detached Python worker a typed entry point into the same imhub MCP
+detached Python worker a typed entry point into the same agim MCP
 tools the in-process native agent uses (memo / skill / push). One
 worker can do dozens of tool calls without any LLM round-trip.
 
@@ -17,8 +17,8 @@ Usage from a bgjob-launched Python script::
 Design notes:
   * Zero external deps — stdlib only (urllib + json + socket).
   * Communicates with the agim parent process over a Unix-domain socket.
-    Path comes from env IMHUB_RPC_SOCKET (agim sets this when spawning
-    the child); token from IMHUB_RPC_TOKEN.
+    Path comes from env AGIM_RPC_SOCKET (agim sets this when spawning
+    the child); token from AGIM_RPC_TOKEN.
   * Each RPC call is a single HTTP POST. Failures raise RpcError with
     the error string so the worker can decide whether to abort.
   * Whitelist matches the server: search_memos / save_memo / read_skill /
@@ -105,19 +105,19 @@ class AgimRpcClient:
     # ─── typed methods (the v1.2.97 whitelist) ──────────────────────
 
     def search_memos(self, query: str = "", **kwargs: Any) -> Any:
-        return self.call("mcp__imhub__search_memos", {"query": query, **kwargs})
+        return self.call("mcp__agim__search_memos", {"query": query, **kwargs})
 
     def save_memo(self, what: str, **kwargs: Any) -> Any:
-        return self.call("mcp__imhub__save_memo", {"what": what, **kwargs})
+        return self.call("mcp__agim__save_memo", {"what": what, **kwargs})
 
     def read_skill(self, name: str) -> Any:
-        return self.call("mcp__imhub__read_skill", {"name": name})
+        return self.call("mcp__agim__read_skill", {"name": name})
 
     def list_skills(self) -> Any:
-        return self.call("mcp__imhub__list_skills", {})
+        return self.call("mcp__agim__list_skills", {})
 
     def push_message(self, text: str, **kwargs: Any) -> Any:
-        return self.call("mcp__imhub__push_message", {"text": text, **kwargs})
+        return self.call("mcp__agim__push_message", {"text": text, **kwargs})
 
 
 def client(timeout: float = 30.0) -> AgimRpcClient:
@@ -125,16 +125,16 @@ def client(timeout: float = 30.0) -> AgimRpcClient:
     sets before spawning the bgjob worker. Raises RuntimeError if the
     parent process didn't pass them in — that means we're not running
     inside an agim-managed bgjob."""
-    socket_path = os.environ.get("IMHUB_RPC_SOCKET")
-    token = os.environ.get("IMHUB_RPC_TOKEN")
+    socket_path = os.environ.get("AGIM_RPC_SOCKET")
+    token = os.environ.get("AGIM_RPC_TOKEN")
     if not socket_path:
         raise RuntimeError(
-            "IMHUB_RPC_SOCKET not set — agim_rpc only works inside a "
+            "AGIM_RPC_SOCKET not set — agim_rpc only works inside a "
             "bgjob spawned by agim's native_exec. Re-run via the bgjob "
             "wrapper, e.g. /root/.claude/scripts/bgjob start ..."
         )
     if not token:
-        raise RuntimeError("IMHUB_RPC_TOKEN not set — agim parent did not mint a token")
+        raise RuntimeError("AGIM_RPC_TOKEN not set — agim parent did not mint a token")
     if not os.path.exists(socket_path):
         raise RuntimeError(f"RPC socket {socket_path} missing — agim parent may not be running")
     return AgimRpcClient(socket_path, token, timeout=timeout)

package/dist/cli-ui/cmd-handlers.d.ts

@@ -1,13 +1,34 @@
 import { type Lang } from './i18n.js';
+declare function browserOpenCommand(url: string, platform?: NodeJS.Platform): {
+    command: string;
+    args: string[];
+} | null;
 export declare function cmdStatus(): void;
+export declare function cmdWeb(opts?: {
+    public?: boolean;
+    welcome?: boolean;
+    open?: boolean;
+    start?: boolean;
+    openBrowser?: (url: string) => boolean;
+}): Promise<number>;
 /**
- * Foreground start is the legacy `program.command('start').action(...)`
- * path in cli.ts — we DON'T re-implement it here, just delegate. For
- * background, we re-spawn ourselves detached.
+ * Foreground start is implemented by `program.command('start').action(...)`
+ * in cli.ts; this handler delegates to it. For background, we re-spawn
+ * ourselves detached.
  */
 export declare function cmdStart(bg: boolean, runForegroundStart: () => Promise<void>): Promise<void>;
 export declare function cmdStop(): Promise<void>;
 export declare function cmdRestart(): Promise<void>;
 export declare function cmdUninstall(): Promise<void>;
-export declare function offerServiceStart(lang: Lang): Promise<void>;
+export declare function offerServiceStart(lang: Lang, opts?: {
+    welcome?: boolean;
+}): Promise<void>;
+export declare function printWebAccessHint(lang: Lang, opts?: {
+    showUrl?: boolean;
+    welcome?: boolean;
+}): Promise<void>;
+export declare const _internal: {
+    browserOpenCommand: typeof browserOpenCommand;
+};
+export {};
 //# sourceMappingURL=cmd-handlers.d.ts.map

package/dist/cli-ui/cmd-handlers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cmd-handlers.d.ts","sourceRoot":"","sources":["../../src/cli-ui/cmd-handlers.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAoB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAA;AAoCvD,wBAAgB,SAAS,IAAI,IAAI,CA+BhC;AAID;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAiClG;AAID,wBAAsB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAkB7C;AAID,wBAAsB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAyBhD;AAgDD,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAyKlD;AAkBD,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAiGjE"}
+{"version":3,"file":"cmd-handlers.d.ts","sourceRoot":"","sources":["../../src/cli-ui/cmd-handlers.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAoB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAA;AAcvD,iBAAS,kBAAkB,CACzB,GAAG,EAAE,MAAM,EACX,QAAQ,GAAE,MAAM,CAAC,QAA2B,GAC3C;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,IAAI,CAO5C;AAgJD,wBAAgB,SAAS,IAAI,IAAI,CAkChC;AAiFD,wBAAsB,MAAM,CAAC,IAAI,GAAE;IACjC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;CAClC,GAAG,OAAO,CAAC,MAAM,CAAC,CA2EvB;AAID;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAiBlG;AAID,wBAAsB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAkB7C;AAID,wBAAsB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAgChD;AA8CD,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAqKlD;AAkBD,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,IAAI,EACV,IAAI,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAO,GAC/B,OAAO,CAAC,IAAI,CAAC,CA+Ff;AAED,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,IAAI,EACV,IAAI,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAO,GAClD,OAAO,CAAC,IAAI,CAAC,CAgCf;AAMD,eAAO,MAAM,SAAS;;CAErB,CAAA"}