Skip to content

Getting Started

Installation

Prerequisites: Node.js ≥ 22.5, OpenClaw gateway running.

bash
# Install globally
npm install -g claw-insights

# Start
claw-insights start

On first launch you'll see:

✅ Claw Insights v0.1.0    ready in 1.2s

➜  Open:  http://127.0.0.1:41041/?token=abc123...
   Auth:  Stable Bearer token + rotating session cookie

PID 12345 · Dashboard + API · Port 41041
Running in background — this terminal is free to use.

claw-insights status | stop | logs

Open the URL — a stable Bearer token is used for scripts and API access, while a rotating session cookie keeps your browser authenticated automatically.

Quick Taste: Snapshot

Before even opening the browser, try generating a snapshot image:

bash
claw-insights snapshot -o status.png

This renders your current dashboard state as a PNG — no browser required. Open status.png to see your gateway status, active sessions, and token usage at a glance.

For more options (formats, detail levels, themes), see Snapshot.

Authentication

By default, Claw Insights generates a random token on startup and prints the URL with the token embedded. After opening the URL once, your browser stores a cookie and you won't need the token again.

For scripts and automation, use the Bearer token header:

bash
curl -H "Authorization: Bearer YOUR_TOKEN" http://127.0.0.1:41041/graphql ...

To disable auth entirely (e.g., local-only use):

bash
claw-insights start --no-auth

See Configuration for more auth options.

Alternative Install Methods

From source

bash
git clone https://github.com/LucaL6/claw-insights.git
cd claw-insights && npm install && npm run build && npm link

CLI Commands

bash
claw-insights start               # Start with default settings
claw-insights start --no-auth     # Disable authentication
claw-insights start --port 8080   # Custom port
claw-insights start --server-only # API only, no web UI
claw-insights status              # Show current access URL
claw-insights stop                # Stop daemon
claw-insights restart             # Restart daemon
claw-insights logs                # View daemon logs
claw-insights snapshot -o out.png # Capture dashboard as PNG

Troubleshooting

ProblemSolution
command not foundnpx claw-insights start, or add npm global bin to PATH
gateway: disconnectedEnsure OpenClaw is running: openclaw gateway start
EADDRINUSEPort in use — set CLAW_INSIGHTS_SERVER_PORT or use --port
Empty dashboardCheck OpenClaw has active sessions: openclaw status
Token expired / cookie lostRun claw-insights status to get a fresh URL with token
Snapshot shows "No data"Gateway must be running and have at least one session

Released under the MIT License.