Skip to content

CLI Reference

claw-insights start

Start the Claw Insights server.

OptionDescription
--port <number>Server port (default: 41041)
--no-authDisable authentication (not recommended for production)
--server-onlyStart API server without opening the browser

claw-insights stop

Stop the running server.

claw-insights status

Show current server status (running/stopped, port, PID).

claw-insights snapshot

Generate a dashboard snapshot from the command line.

OptionDescription
--format <type>Output format: png, svg, json
--detail <level>Detail level: compact, standard, full
--range <range>Time range: 1h, 6h, 12h, 24h (default: 6h)
--theme <theme>Theme: dark, light
--lang <lang>Language: en, zh
-o <path>Output file path
--quickShorthand for compact + png (fast mobile-friendly snapshot)
--dry-runShow what would be generated without saving
--port <number>Target server port (if not default)
--token <token>Auth token (or use environment variable)

Environment Variables

VariableDescription
CLAW_INSIGHTS_SNAPSHOT_DIRDefault directory for saved snapshots

Examples

bash
# Start with default settings
claw-insights start

# Start on a custom port, no browser
claw-insights start --port 4000 --server-only

# Quick PNG snapshot to file
claw-insights snapshot --format png -o status.png

# Full detail, light theme, Chinese
claw-insights snapshot --detail full --theme light --lang zh -o report.png

# JSON export of last hour
claw-insights snapshot --format json --range 1h -o metrics.json

# Dry run to preview
claw-insights snapshot --dry-run --detail full --range 24h

Released under the MIT License.