Files
openclaw/docs/cli/system.md
Kaspre 4ddd942f5f feat(wake): expose typed sessionKey on wake protocol + system event CLI
Adds an optional sessionKey to the WakeParamsSchema and threads it through
the gateway wake handler, CronService.wake(), and the underlying timer.wake()
ops so callers can target a specific session for async-task completion
relays instead of always hitting the agent's main session.

Also adds --session-key to `openclaw system event`.

The schema rejects empty/non-string sessionKey at the gateway boundary;
mismatched session keys (a key that does not belong to the resolving agent)
fall back to the agent's main session inside resolveCronSessionKey, which
is the existing safety path.

Refs #52305 (companion to PR #50818, which closes the related cron-run
remap slice at internal enqueue sites). Doesn't depend on #50818.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-11 17:24:30 +01:00

2.4 KiB

summary, read_when, title
summary read_when title
CLI reference for `openclaw system` (system events, heartbeat, presence)
You want to enqueue a system event without creating a cron job
You need to enable or disable heartbeats
You want to inspect system presence entries
System

openclaw system

System-level helpers for the Gateway: enqueue system events, control heartbeats, and view presence.

All system subcommands use Gateway RPC and accept the shared client flags:

  • --url <url>
  • --token <token>
  • --timeout <ms>
  • --expect-final

Common commands

openclaw system event --text "Check for urgent follow-ups" --mode now
openclaw system event --text "Check for urgent follow-ups" --url ws://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"
openclaw system heartbeat enable
openclaw system heartbeat last
openclaw system presence

system event

Enqueue a system event on the main session by default. The next heartbeat will inject it as a System: line in the prompt. Use --mode now to trigger the heartbeat immediately; next-heartbeat waits for the next scheduled tick.

Pass --session-key to target a specific session (for example to relay an async-task completion back to the channel that started it).

Flags:

  • --text <text>: required system event text.
  • --mode <mode>: now or next-heartbeat (default).
  • --session-key <sessionKey>: optional; target a specific agent session instead of the agent's main session. Keys that do not belong to the resolved agent fall back to the agent's main session.
  • --json: machine-readable output.
  • --url, --token, --timeout, --expect-final: shared Gateway RPC flags.

system heartbeat last|enable|disable

Heartbeat controls:

  • last: show the last heartbeat event.
  • enable: turn heartbeats back on (use this if they were disabled).
  • disable: pause heartbeats.

Flags:

  • --json: machine-readable output.
  • --url, --token, --timeout, --expect-final: shared Gateway RPC flags.

system presence

List the current system presence entries the Gateway knows about (nodes, instances, and similar status lines).

Flags:

  • --json: machine-readable output.
  • --url, --token, --timeout, --expect-final: shared Gateway RPC flags.

Notes

  • Requires a running Gateway reachable by your current config (local or remote).
  • System events are ephemeral and not persisted across restarts.