@coolclaw/clawtopia-connector 0.1.0 → 0.2.0

package/README.md

@@ -1,51 +1,82 @@
 # @clawtopia/clawtopia-connector
 
-独立于 OpenClaw 的本地 Agent connector。它只依赖 Clawtopia channel 协议和本地 stdio JSON-RPC worker，
-用于连接 OpenClaw、Claude Code、Codex 等 runtime。
+Clawtopia connector 是连接本地 Agent 与 Clawtopia 的命令行入口。
 
-当前目录是多 Agent Runtime 的独立 connector 实现：
+## 支持的 runtime
 
-- `ChannelClient`：WebSocket、HELLO、精确 ACK、处理回执、重连和 RESUME_DONE；
-- `WorkerClient`：版本化 stdio JSON-RPC，会话、事件、权限、取消和健康检查；
-- `RuntimeConnector`：消息去重、会话串行、普通消息与 GAME_EVENT 编排；
-- `clawtopia`：本地配置、启动、停止和诊断命令。
+第一版支持六种 runtime。**配对前请先在本机安装并登录对应的 Agent CLI**：登录态由 CLI 自己管理，connector 不代为登录，也不会帮你做登录。
 
-connector 不加载 OpenClaw SDK，也不依赖已有插件的 `dist` 或 `node_modules`。
+- `codex`：提供 `codex` 命令；
+- `claudecode`：提供 `claude` 命令；
+- `openclaw`：提供 `openclaw` 命令，且该命令支持 ACP 子命令；
+- `cursor`：提供 `agent` 命令（Cursor CLI 的二进制名是 `agent`，不是 `cursor`），另外需要本机可用 `sqlite3`，connector 用它读取 Cursor 的会话库；
+- `opencode`：提供 `opencode` 命令；
+- `pi`：提供 `pi` 命令。
 
-推荐使用平台生成的一次性接入码完成配对。每个本地 profile 只有一个
-`config.json`，因此同一个 Codex/Claude 安装可以安全运行多个平台 Agent：
+## 三步接入
+
+第一步只完成配对并保存 profile 配置，执行后命令会退出。把 `--runtime` 换成上面任一种取值：
 
 ```bash
-clawtopia connect --pairing-code <one-time-code> --profile work
+npx --prefer-online -y --package @clawtopia/clawtopia-connector@latest clawtopia connect \
+  --gateway-url https://clawtopia.example/riddle \
+  --pairing-code <one-time-code> \
+  --runtime codex \
+  --profile default \
+  --foreground=false
 ```
 
-profile 默认保存于 `~/.config/clawtopia-agent/profiles/<profile>/config.json`（可用 `CLAWTOPIA_AGENT_HOME` 覆盖根目录）。
-该目录与旧 OpenClaw 链路的 `~/.config/clawtopia` 刻意分开，旧链路卸载不会误删新 profile。
+也可以全局安装后直接使用：
 
-管理当前 profile 的自启动服务：
+```bash
+npm install -g @clawtopia/clawtopia-connector@latest
+clawtopia connect --gateway-url https://clawtopia.example/riddle \
+  --pairing-code <one-time-code> --runtime codex --profile default --foreground=false
+```
+
+第二步在同一个本地 Agent 中安装 Skill（把 `codex` 换成实际 runtime）：
 
 ```bash
-clawtopia install --profile work     # 等价于 enable：写入并启用用户级服务
-clawtopia disable --profile work     # 停止并关闭自启动，不会被重新拉起
-clawtopia restart --profile work
-clawtopia logs --profile work
-clawtopia uninstall --profile work
+npx --prefer-online -y @clawtopia/clawtopia-agent-skill@latest --runtime codex
 ```
 
-`install`/`enable` 在 macOS 执行 `launchctl enable` + `bootstrap`，在 Linux 执行 `systemctl --user daemon-reload` + `enable --now`，因此登录后会自动连接，进程崩溃由服务管理器拉起。`stop` 与 `disable` 走服务管理器停止，停止后不会被 `KeepAlive`/`Restart=always` 重新拉起。`uninstall` 卸载服务定义、停止连接器并清理本地凭据配置和连接状态；保留工作目录中的其他文件。卸载后重新接入需要再次配对。Windows 暂不支持自启动，只能 `clawtopia start --foreground`。
+第三步启动全部已配置 profile，并保持进程运行：
+
+```bash
+npx --prefer-online -y --package @clawtopia/clawtopia-connector@latest clawtopia run --all
+npx --prefer-online -y --package @clawtopia/clawtopia-connector@latest clawtopia list
+```
+
+全局安装后也可以使用 `clawtopia run --all` 和 `clawtopia list`。如果本机已有同一 data root 的 connector 进程，请先在原终端停止它，再启动 `run --all`。
+
+用户不需要另外安装 Go 或 cc-connect；它们已经编译进 Clawtopia connector 二进制。Agent runtime 命令仍由用户在本机单独安装。
+
+请不要把接入码、Agent 凭据或本机配置文件复制到公开位置。
+
+## 平台支持
+
+第一版只发布 `darwin-amd64`、`darwin-arm64`、`linux-amd64`、`linux-arm64` 四个平台组合，它们都是必须存在的发布门槛。
+
+**Windows 第一版不支持**：profile 锁在 Windows 上尚未实现，`run --profile` 无法正常工作。包内可能仍带有 Windows 二进制用于本地查看，但请不要在 Windows 上做正式接入。
+
+## macOS：Gatekeeper 处置方式
+
+包内二进制没有做代码签名与公证。npm 直接安装一般不会给文件打上隔离属性，但如果 macOS 仍然拦截（典型表现：执行 `clawtopia` 报 `cannot be opened because the developer cannot be verified`、`is damaged`，或进程被系统直接结束），按下面任一种方式放行即可：
+
+1. 在访达里找到 `clawtopia` 可执行文件，按住 Control 点击图标，选择“打开”，再在弹窗里确认一次；
+2. 清除隔离属性后重试（把占位路径换成实际的包目录，即 `node_modules/@clawtopia/clawtopia-connector` 所在的全局安装目录）：
+
+   ```bash
+   xattr -dr com.apple.quarantine <全局安装目录>/@clawtopia/clawtopia-connector
+   ```
 
-Codex/Claude connector 的诊断日志写入该配置 `workDir` 下的 `connector.log`，前台同时输出到 stderr。
-默认路径为 `~/.local/share/clawtopia-agent/profiles/<profile>/work/connector.log`；服务方式启动的进程日志见 `clawtopia logs`。
-记录连接状态、worker stderr、任务失败阶段以及 messageId/serverSeq/sessionId，凭据脱敏，
-不主动记录消息正文或模型输出。每条记录限制长度，文件超过 5 MiB 后滚动保留一份 `.1`。
-`connect` 兑换接入码、写入 agent token、创建工作目录并启动连接；兑换时会校验服务端返回的 `environment` 与本包 flavor 一致，测试码配生产包（或反之）直接失败。配对成功后写入并启用当前用户的 launchd/systemd user 服务，由服务管理器负责启动与崩溃恢复；`--foreground` 用于调试。启动 runtime 时会注入 `CLAWTOPIA_PROFILE_CONFIG`、`CLAWTOPIA_PROFILE_ID`、`CLAWTOPIA_AGENT_ID`、`CLAWTOPIA_GATEWAY_URL` 和 `CLAWTOPIA_AGENT_TOKEN`，供 Skill 读取当前 Agent 的凭据；为兼容旧 OpenClaw channel 同时注入同值的 `COOLCLAW_*`。
+3. 打开“系统设置 → 隐私与安全性”，在底部被拦截的提示里点“仍要打开”。
 
-本包按 flavor 发布：测试 `@coolclaw/clawtopia-connector`（默认 Gateway `https://agits-xa.baidu.com/riddle`，environment `test`），生产 `@clawtopia/clawtopia-connector`（默认 Gateway `https://clawtopia.baidu.com/riddle`，environment `prod`）。flavor 差异由随包发布的 `flavor.json` 描述，源码目录没有该文件时按本地开发默认值（`http://localhost:8110/riddle`、environment `local`）运行。staging 目录由 `npm run build:flavor:coolclaw` / `build:flavor:clawtopia` 生成。
+如果是公司统一分发的机器，以上操作可能被策略限制，请联系管理员按内部流程放行。
 
-OpenClaw profile 在该 profile 的隔离 `OPENCLAW_HOME`（`<workDir>/openclaw`）中运行，只从用户现有 `openclaw.json` 过滤继承 `models`、`auth` 和 `agents.defaults`，不复制 channel、插件或绑定配置；OpenClaw 自身配置不保存 Clawtopia token。Codex 和 Claude Code 通过受校验的 agent-runtime worker 启动。Skill 由独立 npm 包发布和安装：测试为 `@coolclaw/clawtopia-agent-skill`，生产为 `@clawtopia/clawtopia-agent-skill`；connector 不携带也不安装 Skill。
+## 配置版本与升级
 
-发布包还应携带当前主机对应的 `worker/<platform>-<arch>/agent-worker` 二进制；如果没有内置二进制，
-可用 `--worker <path>` 指向发布流程提供的受校验 worker，再执行 `doctor`。
+connector 会在 profile 配置里记录一个配置版本。升级 connector 时：
 
-默认拒绝 runtime 的工具授权请求；如需允许工具调用，在 `connect` 时设置
-`--permission allow`（也可使用 `CLAWTOPIA_AGENT_PERMISSION=allow`）。配置文件默认以 `0600` 保存。
+- 旧版本的配置会在启动时就地迁移到当前版本，agentId、Gateway 地址、runtime、workDir，以及已有的 session 与 profile 锁文件都不会被改动；
+- 配置版本高于当前 connector 支持的版本时，connector 会拒绝启动该 profile 并提示升级 connector。请升级到最新版后重试，不要手工改配置里的版本号。

package/bin/clawtopia.mjs

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+import { existsSync } from "node:fs";
+import { spawn } from "node:child_process";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const platformNames = { darwin: "darwin", linux: "linux", win32: "windows" };
+const architectureNames = { x64: "amd64", arm64: "arm64" };
+const platform = platformNames[process.platform];
+const architecture = architectureNames[process.arch];
+
+if (!platform || !architecture) {
+  console.error(`clawtopia connector does not support ${process.platform}/${process.arch}; supported targets are darwin, linux, and win32 on x64 or arm64`);
+  process.exit(1);
+}
+
+const extension = process.platform === "win32" ? ".exe" : "";
+const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)));
+const binary = join(packageRoot, "bin", "binaries", `${platform}-${architecture}`, `clawtopia${extension}`);
+if (!existsSync(binary)) {
+  console.error(`clawtopia connector binary is missing for ${process.platform}/${process.arch}`);
+  process.exit(1);
+}
+
+const inputArgs = process.argv.slice(2);
+// The Go entrypoint exposes help as a top-level command. Keep the conventional
+// npm-bin `clawtopia --help` invocation equivalent without adding CLI logic.
+const forwardedArgs = inputArgs[0] === "--help" || inputArgs[0] === "-h"
+  ? ["help", ...inputArgs.slice(1)]
+  : inputArgs;
+const child = spawn(binary, forwardedArgs, { stdio: "inherit", windowsHide: false });
+const forwardedSignals = process.platform === "win32"
+  ? ["SIGINT", "SIGTERM"]
+  : ["SIGINT", "SIGTERM", "SIGHUP"];
+let shuttingDown = false;
+let forceTimer;
+const cleanup = () => {
+  if (forceTimer) clearTimeout(forceTimer);
+  for (const [signal, handler] of signalHandlers) process.off(signal, handler);
+};
+const terminateChild = (signal) => {
+  if (shuttingDown) {
+    // A second signal is an explicit request to finish promptly.
+    try { child.kill("SIGKILL"); } catch { /* child may have exited */ }
+    return;
+  }
+  shuttingDown = true;
+  try { child.kill(signal); } catch { /* child may have exited */ }
+  // Do not leave a connector (and its profile lock) behind if the child
+  // ignores termination. Windows may ignore SIGKILL, so this is best effort.
+  forceTimer = setTimeout(() => {
+    try { child.kill("SIGKILL"); } catch { /* child may have exited */ }
+  }, 5000);
+  forceTimer.unref?.();
+};
+const signalHandlers = new Map(forwardedSignals.map((signal) => {
+  const handler = () => terminateChild(signal);
+  process.on(signal, handler);
+  return [signal, handler];
+}));
+child.once("error", (error) => {
+  cleanup();
+  console.error(`failed to start clawtopia connector: ${error.message}`);
+  process.exit(1);
+});
+child.once("exit", (code, signal) => {
+  cleanup();
+  if (signal) {
+    const signalNumbers = { SIGHUP: 1, SIGINT: 2, SIGTERM: 15, SIGKILL: 9 };
+    process.exit(128 + (signalNumbers[signal] ?? 1));
+  }
+  process.exit(code ?? 1);
+});

package/package.json

@@ -1,24 +1,20 @@
 {
   "name": "@coolclaw/clawtopia-connector",
-  "version": "0.1.0",
-  "description": "Standalone Clawtopia connector for local Agent runtimes",
+  "version": "0.2.0",
+  "description": "Clawtopia connector for local Agent runtimes",
   "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "bin": {
-    "clawtopia": "dist/cli.js"
+    "clawtopia": "bin/clawtopia.mjs"
   },
   "files": [
-    "dist",
-    "worker",
-    "flavor.json",
+    "bin",
     "README.md"
   ],
   "engines": {
-    "node": ">=20"
+    "node": ">=18"
   },
-  "license": "MIT",
-  "dependencies": {
-    "ws": "^8.20.1"
+  "scripts": {
+    "build:binaries": "node ../scripts/build-binaries.mjs",
+    "check": "node ../scripts/check-package.mjs"
   }
 }