OpenClaw install

Keep your OpenClaw service alive. Automatically.

中文文档

Get Started

npm install -g openclaw-install
openclaw-install 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

openclaw-install watch            # Start monitoring (foreground)
openclaw-install watch -d         # Start monitoring (background)
openclaw-install unwatch          # Stop monitoring

openclaw-install status           # Quick health check

These four commands cover 90% of daily use.

Gateway Management

openclaw-install gateway start    # Start the OpenClaw gateway
openclaw-install gateway stop     # Stop the gateway
openclaw-install gateway restart  # Restart the gateway

Diagnostics & Logs

openclaw-install doctor           # Full diagnostics (binary, gateway, channels)
openclaw-install logs             # View gateway logs
openclaw-install logs --error     # View error logs only
openclaw-install logs --doctor    # View Doctor's own event logs
openclaw-install dashboard        # Web management UI (http://localhost:9090)

Install

# npm (recommended)
npm install -g openclaw-install

# or run without installing
npx openclaw-install 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

Configuration

Config is stored at ~/.openclaw-doctor/config.json. Created automatically on first run. Only Doctor's own preferences -- no OpenClaw settings needed.

{
  "checkInterval": 30,
  "failThreshold": 3,
  "dashboardPort": 9090,
  "maxRestartsPerHour": 5,
  "openclawProfile": "default",
  "notify": {
    "webhook": {
      "enabled": false,
      "url": "",
      "bodyTemplate": "{\"msgtype\":\"text\",\"text\":{\"content\":\"{{message}}\"}}"
    },
    "system": {
      "enabled": true
    }
  }
}

Notifications

Doctor notifies you across the full lifecycle:

Channels: Webhook (DingTalk, Feishu, Slack, etc.) + macOS system notifications.

Skills Integration

Doctor runs as a standalone daemon, callable by OpenClaw or other tools:

openclaw-install status --json    # Machine-readable output
openclaw-install 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

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

• Health check via openclaw health --json + auto-restart with throttling
• Auto-detect OpenClaw config (gateway port, channels, agents, launchd)
• Background daemon mode (watch -d / unwatch)
• Gateway management (gateway start/stop/restart)
• Read and display OpenClaw gateway logs
• Web status dashboard
• --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

Publishing

This repo publishes two npm packages from the same codebase:

• openclaw-install — the main package (package.json)
• openclaw-install — alias package (package.openclaw-install.json)

Both packages share the same version number and dist output.

Release a new version

# 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-install with the default package.json
3. Temporarily swaps in package.openclaw-install.json, publishes openclaw-install, then restores

To update the openclaw-install package metadata (description, keywords, bin name, etc.), edit package.openclaw-install.json. Keep version in sync — it's automatically picked up from whichever package.json is active during publish.