nyrn
/
openclaw
mirror of https://github.com/openclaw/openclaw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
openclaw/docs/cli/logs.md

1.9 KiB
Raw Blame History

summary read_when title
CLI reference for `openclaw logs` (tail gateway logs via RPC)
You need to tail Gateway logs remotely (without SSH)
You want JSON log lines for tooling
logs

openclaw logs

Tail Gateway file logs over RPC (works in remote mode).

Related:

Options

  • --limit <n>: maximum number of log lines to return (default 200)
  • --max-bytes <n>: maximum bytes to read from the log file (default 250000)
  • --follow: follow the log stream
  • --interval <ms>: polling interval while following (default 1000)
  • --json: emit line-delimited JSON events
  • --plain: plain text output without styled formatting
  • --no-color: disable ANSI colors
  • --local-time: render timestamps in your local timezone

Shared Gateway RPC options

openclaw logs also accepts the standard Gateway client flags:

  • --url <url>: Gateway WebSocket URL
  • --token <token>: Gateway token
  • --timeout <ms>: timeout in ms (default 30000)
  • --expect-final: wait for a final response when the Gateway call is agent-backed

When you pass --url, the CLI does not auto-apply config or environment credentials. Include --token explicitly if the target Gateway requires auth.

Examples

openclaw logs
openclaw logs --follow
openclaw logs --follow --interval 2000
openclaw logs --limit 500 --max-bytes 500000
openclaw logs --json
openclaw logs --plain
openclaw logs --no-color
openclaw logs --limit 500
openclaw logs --local-time
openclaw logs --follow --local-time
openclaw logs --url ws://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"

Notes

  • Use --local-time to render timestamps in your local timezone.
  • If the local loopback Gateway asks for pairing, openclaw logs falls back to the configured local log file automatically. Explicit --url targets do not use this fallback.