Skip to content

CLI Reference

RsClaw ships as a single self-contained binary rsclaw. The tables below are generated from the latest rsclaw --help output.

Global Options

rsclaw [OPTIONS] <COMMAND>

Options:
      --dev                 Isolate state to ~/.rsclaw-dev, port offset applied
      --profile <NAME>      Isolate state to ~/.rsclaw-<NAME>
      --base-dir <PATH>     Override the base directory (default: ~/.rsclaw).
                            Takes precedence over --dev and --profile
      --config-path <PATH>  Override the config file path (default: auto-detected)
      --no-color            Disable ANSI colour output
      --json                Machine-readable JSON output (disables styling)
      --container <NAME>    Run inside a container (Podman/Docker)
      --log-level <LEVEL>   Override the global log level
                            (trace, debug, info, warn, error)
  -h, --help                Print help
  -V, --version             Print version

Run rsclaw <COMMAND> --help for full flag details of any subcommand, or use rsclaw completion <shell> to generate shell-completion scripts.

Setup & Configuration

CommandDescription
setupInitialise config and workspace (non-interactive)
onboardInteractive onboarding wizard
configureInteractive configuration wizard
configConfig management sub-commands
doctorDiagnose and optionally fix configuration issues
migrateMigrate data from OpenClaw to rsclaw

Runtime & Monitoring

CommandDescription
gatewayGateway lifecycle (start / stop / restart / run)
daemonLegacy gateway alias
statusShow overall status
healthHealth check
logsTail gateway logs
tuiTerminal UI
traySystem tray icon (requires --features tray)
dashboardOpen the Control UI dashboard in a browser

Core Resources

CommandDescription
agentsAgent management sub-commands
agentAgent management via ACP
agent-turnRun a single agent turn (openclaw-compatible)
modelsModel (LLM provider) management
skillsSkill management
pluginsPlugin management
memoryMemory management
sessionsSession management
hooksWebhook hook management
secretsSecrets management
toolsExternal tool management (chromium, ffmpeg, etc.)

Channels & Pairing

CommandDescription
channelsChannel management (Telegram / Feishu / WeChat / Discord, …)
messageSend, read, and manage messages across chat channels
pairingDM pairing management
devicesDevice pairing and token management
directoryContact/group ID lookup via the gateway directory API
qrGenerate iOS pairing QR code

Automation & Tasks

CommandDescription
cronCron job management
webhooksWebhook helpers
approvalsManage exec approvals

Security & Sandbox

CommandDescription
securitySecurity audit
sandboxSandbox management

System Maintenance

CommandDescription
updateUpdate rsclaw binary
upgradeAlias for update
backupBackup management
resetReset state
uninstallUninstall service and remove data
systemSystem utilities
completionGenerate shell completion scripts

Protocols & Networking

CommandDescription
acpACP protocol commands — control coding agents
dnsDNS helpers for Tailscale wide-area discovery

Documentation

CommandDescription
docsSearch live documentation
helpPrint help for any command

Released under AGPL-3.0 License