openclaw/docs/cli/agent.md
Dan Lewis 3807a53ca2 feat(cli): add --url flag for agent command
This option allows specifying a custom Gateway WebSocket URL (e.g., ws://gateway:18789), which is critical for Docker environments where localhost resolution differs between containers.

Changes:

- Add --url/-u option to agent command

- Update gateway connection logic to prioritize --url flag

- Add documentation and tests
2026-01-27 14:37:29 -09:00

1.3 KiB

summary read_when
CLI reference for `clawdbot agent` (send one agent turn via the Gateway)
You want to run one agent turn from scripts (optionally deliver reply)

clawdbot agent

Run an agent turn via the Gateway (use --local for embedded). Use --agent <id> to target a configured agent directly.

Related:

Options

Flag Description
--url <url> Gateway WebSocket URL (for Docker setups where gateway is on a different host/container)
--local Run embedded agent locally instead of via gateway
--deliver Send the agent's reply back to the channel
--json Output result as JSON
--timeout <seconds> Override agent command timeout

See clawdbot agent --help for the full list of options.

Examples

clawdbot agent --to +15555550123 --message "status update" --deliver
clawdbot agent --agent ops --message "Summarize logs"
clawdbot agent --session-id 1234 --message "Summarize inbox" --thinking medium
clawdbot agent --agent ops --message "Generate report" --deliver --reply-channel slack --reply-to "#reports"

# Docker: connect CLI container to gateway container
docker compose run --rm clawdbot-cli agent --agent main --message "test" --url ws://clawdbot-gateway:18789