openclaw-tools 0.2.1

package/README.openclaw-watch.md

@@ -0,0 +1,239 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Sobranier/openclaw-doctor/main/assets/welcome.png" alt="OpenClaw watch" width="400" />
+</p>
+
+<h1 align="center">OpenClaw watch</h1>
+
+<p align="center">
+  Keep your OpenClaw service alive. Automatically.
+</p>
+
+<p align="center">
+  <a href="./README.zh-CN.md">中文文档</a>
+</p>
+
+## Get Started
+
+```bash
+npm install -g openclaw-watch
+openclaw-watch watch -d
+```
+
+That's it. Doctor monitors your OpenClaw gateway in the background, restarts it when it goes down, and tells you what happened. Zero configuration needed -- it reads everything from your existing OpenClaw setup.
+
+## Core Commands
+
+```bash
+openclaw-watch watch            # Start monitoring (foreground)
+openclaw-watch watch -d         # Start monitoring (background)
+openclaw-watch unwatch          # Stop monitoring
+
+openclaw-watch status           # Quick health check
+```
+
+These four commands cover 90% of daily use.
+
+## Gateway Management
+
+```bash
+openclaw-watch gateway start    # Start the OpenClaw gateway
+openclaw-watch gateway stop     # Stop the gateway
+openclaw-watch gateway restart  # Restart the gateway
+```
+
+## Diagnostics & Logs
+
+```bash
+openclaw-watch doctor           # Full diagnostics (binary, gateway, channels)
+openclaw-watch logs             # View gateway logs
+openclaw-watch logs --error     # View error logs only
+openclaw-watch logs --doctor    # View Doctor's own event logs
+openclaw-watch dashboard        # Web management UI (http://localhost:9090)
+```
+
+## Install
+
+```bash
+# npm (recommended)
+npm install -g openclaw-watch
+
+# or run without installing
+npx openclaw-watch status
+```
+
+Requires Node >= 22 (same as OpenClaw).
+
+## How It Works
+
+Doctor auto-detects your OpenClaw installation:
+
+- Reads `~/.openclaw/openclaw.json` for gateway port, channels, agents
+- Finds the launchd service from `~/Library/LaunchAgents/`
+- Checks health via `openclaw health --json` (real gateway RPC, not HTTP)
+- Restarts via `launchctl kickstart` when needed
+
+**You don't configure OpenClaw details.** Doctor figures them out.
+
+## All Commands
+
+| Command | Description |
+|---------|-------------|
+| **Monitoring** | |
+| `watch` | Start health monitoring (foreground) |
+| `watch -d` | Start health monitoring (background) |
+| `watch -d --dashboard` | Background monitoring + web dashboard |
+| `unwatch` | Stop monitoring |
+| **Gateway** | |
+| `gateway start` | Start the OpenClaw gateway |
+| `gateway stop` | Stop the gateway |
+| `gateway restart` | Restart the gateway |
+| **Info** | |
+| `status` | Show gateway and channel health |
+| `status --json` | Machine-readable JSON output |
+| `doctor` | Run full diagnostics |
+| `dashboard` | Start web management UI |
+| `logs` | Show gateway logs |
+| `logs --error` | Show error logs only |
+| `logs --doctor` | Show Doctor event logs |
+
+## Configuration
+
+Config is stored at `~/.openclaw-doctor/config.json`. Created automatically on first run. Only Doctor's own preferences -- no OpenClaw settings needed.
+
+```json
+{
+  "checkInterval": 30,
+  "failThreshold": 3,
+  "dashboardPort": 9090,
+  "maxRestartsPerHour": 5,
+  "openclawProfile": "default",
+  "notify": {
+    "webhook": {
+      "enabled": false,
+      "url": "",
+      "bodyTemplate": "{\"msgtype\":\"text\",\"text\":{\"content\":\"{{message}}\"}}"
+    },
+    "system": {
+      "enabled": true
+    }
+  }
+}
+```
+
+| Field | Description | Default |
+|-------|-------------|---------|
+| `checkInterval` | Seconds between health checks | `30` |
+| `failThreshold` | Consecutive failures before restart | `3` |
+| `dashboardPort` | Web dashboard port | `9090` |
+| `maxRestartsPerHour` | Restart throttle | `5` |
+| `openclawProfile` | OpenClaw profile to monitor (`default`, `dev`, ...) | `default` |
+| `notify.webhook.url` | Webhook for notifications | -- |
+| `notify.system.enabled` | macOS native notifications | `true` |
+
+## Notifications
+
+Doctor notifies you across the full lifecycle:
+
+| Event | Example |
+|-------|---------|
+| Monitoring started | "Doctor is watching your OpenClaw service" |
+| Health degraded | "Service unhealthy (attempt 2/3)" |
+| Restarting | "Restarting gateway..." |
+| Restart succeeded | "Gateway back online" |
+| Restart failed | "Restart failed: [error]" |
+| Throttled | "Too many restarts, manual intervention needed" |
+| Recovered | "Service recovered on its own" |
+| Monitoring stopped | "Doctor stopped" |
+
+Channels: **Webhook** (DingTalk, Feishu, Slack, etc.) + **macOS system notifications**.
+
+## Skills Integration
+
+Doctor runs as a standalone daemon, callable by OpenClaw or other tools:
+
+```bash
+openclaw-watch status --json    # Machine-readable output
+openclaw-watch watch -d         # Idempotent -- safe to call repeatedly
+```
+
+If the caller crashes, Doctor keeps running.
+
+## Architecture
+
+```
+                          +-----------------+
+                          |  Notification   |
+                          |  (Webhook/OS)   |
+                          +--------^--------+
+                                   |
++-------------+    CLI    +--------+--------+    RPC      +-----------+
+|  OpenClaw   | --------> |                 | ---------> |  OpenClaw |
+|  / Scripts  |           | openclaw-doctor |            |  Gateway  |
+|  / Skills   | <-------- |  (daemon)       | <--------- | :18789    |
++-------------+  stdout   +--------+--------+  health    +-----------+
+                                   |
+                          +--------v--------+
+                          | ~/.openclaw/logs |
+                          | (read & analyze) |
+                          +-----------------+
+```
+
+## Development
+
+```bash
+git clone https://github.com/openclaw/openclaw-doctor.git
+cd openclaw-doctor
+npm install
+
+npm run dev -- status          # Quick test
+npm run dev -- watch           # Foreground monitoring
+npm run dev -- watch -d        # Background daemon
+npm run dev -- unwatch         # Stop daemon
+
+npm run build                  # Build for distribution
+```
+
+## Roadmap
+
+- [x] Health check via `openclaw health --json` + auto-restart with throttling
+- [x] Auto-detect OpenClaw config (gateway port, channels, agents, launchd)
+- [x] Background daemon mode (`watch -d` / `unwatch`)
+- [x] Gateway management (`gateway start/stop/restart`)
+- [x] Read and display OpenClaw gateway logs
+- [x] Web status dashboard
+- [x] `--json` output for status
+- [ ] Notification system (Webhook + macOS)
+- [ ] `logs --tail` (real-time follow)
+- [ ] `config` command (get/set)
+- [ ] Multiple service monitoring
+- [ ] Linux systemd support
+
+## License
+
+[MIT](./LICENSE)
+
+## Publishing
+
+This repo publishes two npm packages from the same codebase:
+
+- **`openclaw-watch`** — the main package (`package.json`)
+- **`openclaw-watch`** — alias package (`package.openclaw-watch.json`)
+
+Both packages share the same version number and dist output.
+
+### Release a new version
+
+```bash
+# 1. Bump version (patch / minor / major)
+npm version patch
+
+# 2. Build + publish both packages
+npm run release
+```
+
+`npm run release` calls `scripts/publish.sh`, which:
+1. Builds once (`npm run build`)
+2. Publishes `openclaw-watch` with the default `package.json`
+3. Temporarily swaps in `package.openclaw-watch.json`, publishes `openclaw-watch`, then restores
+
+To update the `openclaw-watch` package metadata (description, keywords, bin name, etc.), edit `package.openclaw-watch.json`. Keep `version` in sync — it's automatically picked up from whichever `package.json` is active during publish.

package/README.zh-CN.md

@@ -0,0 +1,213 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Sobranier/openclaw-doctor/main/assets/welcome.png" alt="OpenClaw Doctor" width="400" />
+</p>
+
+<h1 align="center">OpenClaw Doctor</h1>
+
+<p align="center">
+  让你的 OpenClaw 服务永不宕机。
+</p>
+
+<p align="center">
+  <a href="./README.md">English</a>
+</p>
+
+## 开始使用
+
+```bash
+npm install -g openclaw-doctor
+openclaw-doctor watch -d
+```
+
+就这样。Doctor 在后台监控你的 OpenClaw 网关，挂了自动重启，全程通知你。无需任何配置——它会自动读取你现有的 OpenClaw 设置。
+
+## 核心命令
+
+```bash
+openclaw-doctor watch            # 开始监控（前台）
+openclaw-doctor watch -d         # 开始监控（后台）
+openclaw-doctor unwatch          # 停止监控
+
+openclaw-doctor status           # 快速健康检查
+```
+
+这四个命令覆盖日常 90% 的使用场景。
+
+## 网关管理
+
+```bash
+openclaw-doctor gateway start    # 启动 OpenClaw 网关
+openclaw-doctor gateway stop     # 停止网关
+openclaw-doctor gateway restart  # 重启网关
+```
+
+## 诊断和日志
+
+```bash
+openclaw-doctor doctor           # 完整诊断（二进制、网关、通道）
+openclaw-doctor logs             # 查看网关日志
+openclaw-doctor logs --error     # 只看错误日志
+openclaw-doctor logs --doctor    # 查看 Doctor 自身事件日志
+openclaw-doctor dashboard        # Web 管理面板（http://localhost:9090）
+```
+
+## 安装
+
+```bash
+# npm（推荐）
+npm install -g openclaw-doctor
+
+# 或免安装直接跑
+npx openclaw-doctor status
+```
+
+需要 Node >= 22（和 OpenClaw 一致）。
+
+## 工作原理
+
+Doctor 自动探测你的 OpenClaw 安装：
+
+- 读取 `~/.openclaw/openclaw.json` 获取网关端口、通道、Agent 信息
+- 扫描 `~/Library/LaunchAgents/` 找到 launchd 服务
+- 通过 `openclaw health --json` 检查健康（真正的网关 RPC，不是 HTTP 探测）
+- 需要时通过 `launchctl kickstart` 重启
+
+**你不需要配置 OpenClaw 的任何信息。** Doctor 会自动搞定。
+
+## 完整命令
+
+| 命令 | 说明 |
+|------|------|
+| **监控** | |
+| `watch` | 开始健康监控（前台） |
+| `watch -d` | 开始健康监控（后台） |
+| `watch -d --dashboard` | 后台监控 + Web 面板 |
+| `unwatch` | 停止监控 |
+| **网关** | |
+| `gateway start` | 启动 OpenClaw 网关 |
+| `gateway stop` | 停止网关 |
+| `gateway restart` | 重启网关 |
+| **信息** | |
+| `status` | 显示网关和通道健康状态 |
+| `status --json` | 机器可读的 JSON 输出 |
+| `doctor` | 运行完整诊断 |
+| `dashboard` | 启动 Web 管理面板 |
+| `logs` | 查看网关日志 |
+| `logs --error` | 只看错误日志 |
+| `logs --doctor` | 查看 Doctor 事件日志 |
+
+## 配置
+
+配置文件位于 `~/.openclaw-doctor/config.json`，首次运行时自动创建。只包含 Doctor 自身的偏好——无需配置 OpenClaw 的信息。
+
+```json
+{
+  "checkInterval": 30,
+  "failThreshold": 3,
+  "dashboardPort": 9090,
+  "maxRestartsPerHour": 5,
+  "openclawProfile": "default",
+  "notify": {
+    "webhook": {
+      "enabled": false,
+      "url": "",
+      "bodyTemplate": "{\"msgtype\":\"text\",\"text\":{\"content\":\"{{message}}\"}}"
+    },
+    "system": {
+      "enabled": true
+    }
+  }
+}
+```
+
+| 字段 | 说明 | 默认值 |
+|------|------|--------|
+| `checkInterval` | 健康检查间隔（秒） | `30` |
+| `failThreshold` | 连续失败几次后重启 | `3` |
+| `dashboardPort` | Web 面板端口 | `9090` |
+| `maxRestartsPerHour` | 每小时最多重启次数 | `5` |
+| `openclawProfile` | 监控的 OpenClaw 配置（`default`、`dev`...） | `default` |
+| `notify.webhook.url` | Webhook 通知地址 | -- |
+| `notify.system.enabled` | macOS 系统通知 | `true` |
+
+## 通知系统
+
+Doctor 在整个生命周期都会通知你：
+
+| 事件 | 示例消息 |
+|------|----------|
+| 开始监控 | "Doctor 正在守护你的 OpenClaw 服务" |
+| 状态异常 | "服务异常（第 2/3 次检测）" |
+| 准备重启 | "正在重启网关..." |
+| 重启成功 | "网关已恢复上线" |
+| 重启失败 | "重启失败：[错误详情]" |
+| 重启受限 | "重启次数过多，需要人工介入" |
+| 自行恢复 | "服务自行恢复，无需重启" |
+| 停止监控 | "Doctor 已停止" |
+
+支持渠道：**Webhook**（钉钉、飞书、Slack、企业微信等）+ **macOS 系统通知**。
+
+## Skills 集成
+
+Doctor 作为独立守护进程运行，可被 OpenClaw 或其他工具调用：
+
+```bash
+openclaw-doctor status --json    # 机器可读输出
+openclaw-doctor watch -d         # 幂等——重复调用安全
+```
+
+即使调用方崩溃，Doctor 继续运行。
+
+## 架构
+
+```
+                          +-----------------+
+                          |     通知系统     |
+                          |  (Webhook/OS)   |
+                          +--------^--------+
+                                   |
++-------------+    CLI    +--------+--------+    RPC      +-----------+
+|  OpenClaw   | --------> |                 | ---------> |  OpenClaw |
+|  / 脚本     |           | openclaw-doctor |            |    网关    |
+|  / Skills   | <-------- |   (守护进程)     | <--------- |  :18789   |
++-------------+  stdout   +--------+--------+   health   +-----------+
+                                   |
+                          +--------v--------+
+                          | ~/.openclaw/logs |
+                          |   (读取并分析)    |
+                          +-----------------+
+```
+
+## 开发
+
+```bash
+git clone https://github.com/Sobranier/openclaw-doctor.git
+cd openclaw-doctor
+npm install
+
+npm run dev -- status          # 快速测试
+npm run dev -- watch           # 前台监控
+npm run dev -- watch -d        # 后台守护
+npm run dev -- unwatch         # 停止守护
+
+npm run build                  # 构建发布版本
+```
+
+## 路线图
+
+- [x] 通过 `openclaw health --json` 检查健康 + 自动重启（含频率限制）
+- [x] 自动探测 OpenClaw 配置（网关端口、通道、Agent、launchd）
+- [x] 后台守护模式（`watch -d` / `unwatch`）
+- [x] 网关管理（`gateway start/stop/restart`）
+- [x] 读取并展示 OpenClaw 网关日志
+- [x] Web 状态面板
+- [x] `status --json` 输出
+- [ ] 通知系统（Webhook + macOS）
+- [ ] `logs --tail`（实时跟踪）
+- [ ] `config` 命令（get/set）
+- [ ] 多服务监控
+- [ ] Linux systemd 支持
+
+## 协议
+
+[MIT](./LICENSE)