mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 17:20:45 +00:00
Docs: document inferred commitments
This commit is contained in:
90
docs/cli/commitments.md
Normal file
90
docs/cli/commitments.md
Normal file
@@ -0,0 +1,90 @@
|
||||
---
|
||||
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`"
|
||||
---
|
||||
|
||||
List and manage inferred follow-up commitments.
|
||||
|
||||
Commitments are opt-in, short-lived follow-up memories created from
|
||||
conversation context. See [Inferred commitments](/concepts/commitments) for the
|
||||
conceptual guide.
|
||||
|
||||
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`.
|
||||
- `--json`: output machine-readable JSON.
|
||||
|
||||
## Examples
|
||||
|
||||
List pending commitments:
|
||||
|
||||
```bash
|
||||
openclaw commitments
|
||||
```
|
||||
|
||||
List every stored commitment:
|
||||
|
||||
```bash
|
||||
openclaw commitments --all
|
||||
```
|
||||
|
||||
Filter to one agent:
|
||||
|
||||
```bash
|
||||
openclaw commitments --agent main
|
||||
```
|
||||
|
||||
Find snoozed commitments:
|
||||
|
||||
```bash
|
||||
openclaw commitments --status snoozed
|
||||
```
|
||||
|
||||
Dismiss one or more commitments:
|
||||
|
||||
```bash
|
||||
openclaw commitments dismiss cm_abc123 cm_def456
|
||||
```
|
||||
|
||||
Export as JSON:
|
||||
|
||||
```bash
|
||||
openclaw commitments --all --json
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
Text output includes:
|
||||
|
||||
- commitment id
|
||||
- status
|
||||
- kind
|
||||
- earliest due time
|
||||
- scope
|
||||
- suggested check-in text
|
||||
|
||||
JSON output also includes the commitment store path and full stored records.
|
||||
|
||||
## Related
|
||||
|
||||
- [Inferred commitments](/concepts/commitments)
|
||||
- [Memory overview](/concepts/memory)
|
||||
- [Heartbeat](/gateway/heartbeat)
|
||||
- [Scheduled tasks](/automation/cron-jobs)
|
||||
@@ -20,7 +20,7 @@ apply across the CLI.
|
||||
| Messaging and agents | [`message`](/cli/message) · [`agent`](/cli/agent) · [`agents`](/cli/agents) · [`acp`](/cli/acp) · [`mcp`](/cli/mcp) |
|
||||
| Health and sessions | [`status`](/cli/status) · [`health`](/cli/health) · [`sessions`](/cli/sessions) |
|
||||
| Gateway and logs | [`gateway`](/cli/gateway) · [`logs`](/cli/logs) · [`system`](/cli/system) |
|
||||
| Models and inference | [`models`](/cli/models) · [`infer`](/cli/infer) · `capability` (alias for [`infer`](/cli/infer)) · [`memory`](/cli/memory) · [`wiki`](/cli/wiki) |
|
||||
| Models and inference | [`models`](/cli/models) · [`infer`](/cli/infer) · `capability` (alias for [`infer`](/cli/infer)) · [`memory`](/cli/memory) · [`commitments`](/cli/commitments) · [`wiki`](/cli/wiki) |
|
||||
| Network and nodes | [`directory`](/cli/directory) · [`nodes`](/cli/nodes) · [`devices`](/cli/devices) · [`node`](/cli/node) |
|
||||
| Runtime and sandbox | [`approvals`](/cli/approvals) · `exec-policy` (see [`approvals`](/cli/approvals)) · [`sandbox`](/cli/sandbox) · [`tui`](/cli/tui) · `chat`/`terminal` (aliases for [`tui --local`](/cli/tui)) · [`browser`](/cli/browser) |
|
||||
| Automation | [`cron`](/cli/cron) · [`tasks`](/cli/tasks) · [`hooks`](/cli/hooks) · [`webhooks`](/cli/webhooks) |
|
||||
@@ -121,6 +121,9 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
status
|
||||
index
|
||||
search
|
||||
commitments
|
||||
list
|
||||
dismiss
|
||||
wiki
|
||||
status
|
||||
doctor
|
||||
|
||||
Reference in New Issue
Block a user