mirror of
https://github.com/moltbot/moltbot.git
synced 2026-05-16 18:34:18 +00:00
8399ff888f
Codex review on PR #78687 [P3] flagged that the docs say next-heartbeat "waits for the next scheduled tick" while the patched timer collapses next-heartbeat+sessionKey to an immediate targeted wake. Add a callout describing the exception and pointing callers who want delayed delivery back at the no-session-key path. Refs #78687. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
90 lines
2.9 KiB
Markdown
90 lines
2.9 KiB
Markdown
---
|
|
summary: "CLI reference for `openclaw system` (system events, heartbeat, presence)"
|
|
read_when:
|
|
- 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
|
|
title: "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
|
|
|
|
```bash
|
|
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).
|
|
|
|
> **Timing exception with `--session-key`:** when `--session-key` is supplied,
|
|
> `--mode next-heartbeat` collapses to an immediate targeted wake instead of
|
|
> waiting for the next scheduled tick. Targeted wakes use heartbeat intent
|
|
> `immediate` so they bypass the runner's not-due gate that would otherwise
|
|
> defer (and effectively drop) an `event`-intent wake. If you want delayed
|
|
> delivery, omit `--session-key` so the event lands on the main session and
|
|
> rides the next regular heartbeat.
|
|
|
|
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.
|
|
|
|
## Related
|
|
|
|
- [CLI reference](/cli)
|