Skip to main content
The gateway command manages the SimpleClaw WebSocket Gateway server that connects messaging channels to AI agents.

​
Commands

​
gateway run

Run the WebSocket Gateway in the foreground. 
simpleclaw gateway run
​
--port
number
Gateway port number
​
--bind
string
Bind mode: loopback, tailnet, lan, auto, or custom
​
--force
boolean
Force start even if validation fails

​
gateway status

Show gateway service status and probe the Gateway. 
simpleclaw gateway status

​
gateway call

Call a Gateway RPC method directly. 
simpleclaw gateway call <method>
​
method
string
required
Method name (e.g., health, status, system-presence, cron.*)
​
--params
json
JSON object string for method parameters (default: {})
​
--url
string
Gateway WebSocket URL
​
--token
string
Gateway authentication token
​
--password
string
Gateway authentication password
​
--json
boolean
Output result as JSON
Example: 
simpleclaw gateway call health
simpleclaw gateway call status --json

​
gateway usage-cost

Fetch usage cost summary from session logs. 
simpleclaw gateway usage-cost
​
--days
number
Number of days to include (default: 30)
​
--url
string
Gateway WebSocket URL
​
--token
string
Gateway authentication token
​
--json
boolean
Output result as JSON

​
gateway health

Fetch Gateway health status. 
simpleclaw gateway health
​
--url
string
Gateway WebSocket URL
​
--token
string
Gateway authentication token
​
--json
boolean
Output result as JSON

​
gateway probe

Show gateway reachability, discovery, health, and status summary (local and remote). 
simpleclaw gateway probe
​
--url
string
Explicit Gateway WebSocket URL (still probes localhost)
​
--ssh
string
SSH target for remote gateway tunnel (user@host or user@host:port)
​
--ssh-identity
string
SSH identity file path
​
--ssh-auto
boolean
Try to derive an SSH target from Bonjour discovery
​
--token
string
Gateway token (applies to all probes)
​
--password
string
Gateway password (applies to all probes)
​
--timeout
number
Overall probe budget in milliseconds (default: 3000)
​
--json
boolean
Output JSON

​
gateway discover

Discover gateways via Bonjour (local and wide-area if configured). 
simpleclaw gateway discover
​
--timeout
number
Per-command timeout in milliseconds (default: 2000)
​
--json
boolean
Output JSON

​
Examples

# Run the gateway in the foreground
simpleclaw gateway run

# Show service status and probe reachability
simpleclaw gateway status

# Find local and wide-area gateway beacons
simpleclaw gateway discover

# Call a gateway RPC method directly
simpleclaw gateway call health

Build docs developers (and LLMs) love

Get started for freeTalk to us