CLI Reference

Complete reference for the scalyclaw command-line interface. All commands connect to Redis to communicate with running processes — ensure REDIS_URL is set or pass --redis-url on each invocation.

Commands

Global

Top-level commands that operate across the full ScalyClaw stack.

`scalyclaw setup`

Interactive setup wizard. Walks through Redis connection, LLM provider credentials, embedding model selection, and dashboard password. Writes config to Redis at scalyclaw:config and secrets to scalyclaw:secret:*. Safe to re-run — existing values are shown as defaults.

bash

scalyclaw setup

`scalyclaw start`

Start the node, a worker, and the dashboard together in a single command. Streams combined log output with per-process prefixes. Ctrl-C stops all three.

bash

scalyclaw start

`scalyclaw stop`

Gracefully stop all running ScalyClaw processes. Sends a shutdown signal via the system BullMQ queue; each process drains its active jobs before exiting.

bash

scalyclaw stop

`scalyclaw status`

Print a summary table of all processes: node, worker(s), and dashboard. Shows PID, uptime, queue depths, and last heartbeat timestamp.

bash

scalyclaw status

`scalyclaw version`

Print the installed ScalyClaw version.

bash

scalyclaw version

Node

Commands for the node process — the orchestrator that manages channels, builds system prompts, and enqueues LLM work.

`scalyclaw node start`

Start the node process in the foreground. The node connects to all configured channels, initialises the session state machine in Redis, and begins consuming from the messages and system BullMQ queues.

bash

scalyclaw node start

`scalyclaw node stop`

Gracefully stop the running node. Waits for in-flight message processing to complete before exiting.

bash

scalyclaw node stop

`scalyclaw node status`

Show node health: process uptime, connected channels, active session count, and pending message queue depth per channel.

bash

scalyclaw node status

Worker

Commands for worker processes — stateless BullMQ consumers that execute code, run skills, invoke agents, and forward MCP tool calls.

`scalyclaw worker start`

Start a worker process. Multiple workers can run simultaneously against the same Redis instance; BullMQ distributes jobs across them automatically. Use --concurrency to control how many jobs a single worker processes in parallel.

bash

scalyclaw worker start
scalyclaw worker start --concurrency 8

`scalyclaw worker stop`

Stop all running worker processes. Each worker drains its active jobs before shutting down.

bash

scalyclaw worker stop

`scalyclaw worker status`

Show worker health and queue statistics: active jobs, waiting jobs, failed jobs, and throughput for each BullMQ queue (tools, agents, scheduler).

bash

scalyclaw worker status

Dashboard

Commands for the dashboard process — the React admin interface served by a lightweight HTTP server.

`scalyclaw dashboard start`

Start the dashboard server. Defaults to port 3000. Use --port to change it.

bash

scalyclaw dashboard start
scalyclaw dashboard start --port 8080

`scalyclaw dashboard stop`

Stop the running dashboard server.

bash

scalyclaw dashboard stop

`scalyclaw dashboard status`

Show dashboard status: process uptime, bound address, and port.

bash

scalyclaw dashboard status

Global Flags

These flags are accepted by all commands that communicate with Redis or bind to a port.

Flag	Default	Description
`--redis-url <url>`	`redis://localhost:6379`	Redis connection URL. Overrides the `REDIS_URL` environment variable when both are present.
`--port <number>`	Varies per command	Override the default port. Applies to `dashboard start` (default `3000`).
`--concurrency <number>`	`4`	Number of BullMQ jobs a single worker processes in parallel. Applies to `worker start`.
`--verbose`	off	Enable debug-level logging. Prints queue events, Redis round-trips, and LLM request/response details.

Tip

Set REDIS_URL as an environment variable instead of passing --redis-url on every command. All scalyclaw commands read it automatically, keeping your shell history clean.

Command Reference

Full list of all commands and their accepted flags at a glance.

Command	--redis-url	--port	--concurrency	--verbose
`scalyclaw setup`	Yes	—	—	—
`scalyclaw start`	Yes	Yes	Yes	Yes
`scalyclaw stop`	Yes	—	—	Yes
`scalyclaw status`	Yes	—	—	—
`scalyclaw version`	—	—	—	—
`scalyclaw node start`	Yes	—	—	Yes
`scalyclaw node stop`	Yes	—	—	Yes
`scalyclaw node status`	Yes	—	—	—
`scalyclaw worker start`	Yes	—	Yes	Yes
`scalyclaw worker stop`	Yes	—	—	Yes
`scalyclaw worker status`	Yes	—	—	—
`scalyclaw dashboard start`	Yes	Yes	—	Yes
`scalyclaw dashboard stop`	Yes	—	—	Yes
`scalyclaw dashboard status`	Yes	—	—	—