Skip to main content

CLI Reference

Complete reference for the openclaw command-line interface.

Global Flags

FlagDescription
--versionPrint version
--helpShow help
--config <path>Use custom config file
--verboseEnable verbose output
--quietSuppress non-essential output
--jsonOutput in JSON format

Commands

openclaw onboard

Interactive setup wizard.

openclaw onboard [--install-daemon] [--skip-channels]
FlagDescription
--install-daemonInstall gateway as a system service
--skip-channelsSkip messaging channel setup
--provider <name>Pre-select LLM provider

openclaw dashboard

Launch the Control UI in your browser for system monitoring and management.

openclaw dashboard [--no-open]
FlagDescription
--no-openPrint the tokenized URL without opening a browser

The Control UI runs on localhost:18789 and requires your gateway auth token. For remote access, use SSH port forwarding:

ssh -N -L 18789:127.0.0.1:18789 root@your-server-ip

openclaw gateway

Manage the gateway process.

openclaw gateway [start|stop|restart|status] [flags]
FlagDescription
--daemonRun as background daemon
--port <number>Override gateway port (default: 18789)
--host <addr>Override bind address (default: 127.0.0.1)

openclaw chat

Send messages to the agent.

openclaw chat [message] [flags]
FlagDescription
--format <type>Output format: markdown, plain, json
--model <name>Override model for this message
--no-memoryDon't load or save memory
--context <file>Load additional context from file

Without a message argument, starts an interactive chat session.

openclaw channel

Manage messaging channels.

openclaw channel <add|remove|list|status|reconnect> [channel-name]

openclaw skill

Manage installed skills.

openclaw skill <install|remove|list|test|config> [skill-name|path]
SubcommandDescription
install <path>Install a skill from file
remove <name>Remove an installed skill
listList all installed skills
test <path> <msg>Test a skill without installing
config <name>View/set skill configuration

openclaw plugins

Manage installed plugins.

openclaw plugins <list|inspect|install|uninstall|update|enable|disable|doctor|marketplace> [args]
SubcommandDescription
listShow installed plugins
inspect <name>View plugin details
install <name>Install a plugin
uninstall <name>Remove a plugin
update [name]Upgrade plugins (all or specific)
enable <name>Enable a disabled plugin
disable <name>Disable a plugin
doctorDiagnose plugin issues
marketplace listBrowse available plugins

openclaw clawhub

Interact with the ClawHub marketplace.

openclaw clawhub <search|install|publish|browse|info|view|login|outdated|update|report|security-report|validate> [args]

openclaw heartbeat

Manage the heartbeat system.

openclaw heartbeat [--now] [--dry-run]
FlagDescription
--nowTrigger an immediate heartbeat
--dry-runShow what would happen without executing

openclaw logs

View gateway logs.

openclaw logs [--filter <component>] [--follow] [--lines <n>]
FlagDescription
--filterFilter by component: heartbeat, channel, brain, hands
--followStream logs in real-time
--lines <n>Show last N lines (default: 50)

openclaw status

Show gateway and system status.

openclaw status [--json]

openclaw stats

Show usage statistics.

openclaw stats [heartbeat|tokens|channels] [--period <days>]

openclaw security

Security tools.

openclaw security <check|scan> [--all]
SubcommandDescription
checkAudit current security configuration
scan <path>Scan a skill file for security issues
scan --allScan all installed skills

openclaw config

View and modify configuration.

openclaw config <get|set|list> [key] [value]

Exit Codes

CodeMeaning
0Success
1General error
2Configuration error
3Gateway not running
4Authentication failure
5Network error

See Also