mirror of https://github.com/openclaw/openclaw.git
72 lines
2.0 KiB
Markdown
72 lines
2.0 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. 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.
|
|
|
|
Flags:
|
|
|
|
- `--text <text>`: required system event text.
|
|
- `--mode <mode>`: `now` or `next-heartbeat` (default).
|
|
- `--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.
|