Files
openclaw/docs/cli/commitments.md
TJ Paulson a7df4dd933 docs: sync heartbeat, memory, commitments, and system-prompt docs with current behavior (#112295)
* docs: sync heartbeat, memory, commitments, and system-prompt docs with current behavior

The heartbeat doc described a removed broad default prompt; the memory doc
claimed automatic distillation that does not run on a default install; the
commitments docs advertised a snoozed status nothing currently writes; the
system-prompt doc omitted the Promised Work and Proactive Sub-Agent
Orchestration sections.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs(heartbeat): describe scheduled work accurately

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Peter Steinberger <steipete@gmail.com>
2026-07-25 06:49:14 -07:00

95 lines
2.3 KiB
Markdown

---
summary: "CLI reference for `openclaw commitments` (inspect and dismiss inferred follow-ups)"
read_when:
- You want to inspect inferred follow-up commitments
- You want to dismiss pending check-ins
- You are auditing what heartbeat may deliver
title: "`openclaw commitments`"
---
Inspect and dismiss records left by the retired inferred commitments experiment.
OpenClaw no longer creates or delivers new commitments, but keeps the maintenance
command so upgrades can audit and clean up existing SQLite rows.
With no subcommand, `openclaw commitments` lists pending commitments.
## Usage
```bash
openclaw commitments [--all] [--agent <id>] [--status <status>] [--json]
openclaw commitments list [--all] [--agent <id>] [--status <status>] [--json]
openclaw commitments dismiss <id...> [--json]
```
## Options
- `--all`: show all statuses instead of only pending commitments.
- `--agent <id>`: filter to one agent id.
- `--status <status>`: filter by status. Values: `pending`, `sent`,
`dismissed`, `snoozed`, or `expired`. Unknown values exit with an error.
The `snoozed` status is reserved: no built-in flow currently snoozes a
commitment; snoozed records can appear only when imported from legacy state.
- `--json`: output machine-readable JSON.
`dismiss` marks the given commitment ids as `dismissed`.
## Examples
List pending commitments:
```bash
openclaw commitments
```
List every stored commitment:
```bash
openclaw commitments --all
```
Filter to one agent:
```bash
openclaw commitments --agent main
```
Filter by status:
```bash
openclaw commitments --status dismissed
```
Dismiss one or more commitments:
```bash
openclaw commitments dismiss cm_abc123 cm_def456
```
Export as JSON:
```bash
openclaw commitments --all --json
```
## Output
Text output prints the commitment count, the shared SQLite database path, any active filters,
and one row per commitment:
- commitment id
- status
- kind (`event_check_in`, `deadline_check`, `care_check_in`, or `open_loop`)
- earliest due time
- scope (agent/channel/target)
- suggested check-in text
JSON output includes the count, the active status and agent filters, the
shared SQLite database path, and the full stored records.
## Related
- [Inferred commitments](/concepts/commitments)
- [Memory overview](/concepts/memory)
- [Heartbeat](/gateway/heartbeat)
- [Scheduled tasks](/automation/cron-jobs)