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 started (PID 12345, mode: full, port: 41041)
🔑 http://127.0.0.1:41041/?token=abc123...

Open the URL — the token is set as a cookie (valid 7 days). That's it.

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

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
Empty dashboardCheck OpenClaw has active sessions: openclaw status

Released under the MIT License.