mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 08:10:44 +00:00
fix: align docs with cli and provider surfaces
This commit is contained in:
@@ -15,4 +15,4 @@ openclaw tasks flow show <lookup>
|
||||
openclaw tasks flow cancel <lookup>
|
||||
```
|
||||
|
||||
For full documentation see [Task Flow](/automation/taskflow) and the [tasks CLI reference](/cli/index#tasks).
|
||||
For full documentation see [Task Flow](/automation/taskflow) and the [tasks CLI reference](/cli/tasks).
|
||||
|
||||
@@ -47,7 +47,7 @@ This page describes the current CLI behavior. If commands change, update this do
|
||||
- [`tui`](/cli/tui)
|
||||
- [`browser`](/cli/browser)
|
||||
- [`cron`](/cli/cron)
|
||||
- [`tasks`](/cli/index#tasks)
|
||||
- [`tasks`](/cli/tasks)
|
||||
- [`flows`](/cli/flows)
|
||||
- [`dns`](/cli/dns)
|
||||
- [`docs`](/cli/docs)
|
||||
@@ -431,7 +431,7 @@ Notes:
|
||||
|
||||
## Plugins
|
||||
|
||||
Manage extensions and their config:
|
||||
Manage plugins and their config:
|
||||
|
||||
- `openclaw plugins list` — discover plugins (use `--json` for machine output).
|
||||
- `openclaw plugins inspect <id>` — show details for a plugin (`info` is an alias).
|
||||
|
||||
@@ -8,7 +8,7 @@ title: "plugins"
|
||||
|
||||
# `openclaw plugins`
|
||||
|
||||
Manage Gateway plugins/extensions, hook packs, and compatible bundles.
|
||||
Manage Gateway plugins, hook packs, and compatible bundles.
|
||||
|
||||
Related:
|
||||
|
||||
|
||||
98
docs/cli/tasks.md
Normal file
98
docs/cli/tasks.md
Normal file
@@ -0,0 +1,98 @@
|
||||
---
|
||||
summary: "CLI reference for `openclaw tasks` (background task ledger and Task Flow state)"
|
||||
read_when:
|
||||
- You want to inspect, audit, or cancel background task records
|
||||
- You are documenting Task Flow commands under `openclaw tasks flow`
|
||||
title: "`openclaw tasks`"
|
||||
---
|
||||
|
||||
# `openclaw tasks`
|
||||
|
||||
Inspect durable background tasks and Task Flow state. With no subcommand,
|
||||
`openclaw tasks` is equivalent to `openclaw tasks list`.
|
||||
|
||||
See [Background Tasks](/automation/tasks) for the lifecycle and delivery model.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
openclaw tasks
|
||||
openclaw tasks list
|
||||
openclaw tasks list --runtime acp
|
||||
openclaw tasks list --status running
|
||||
openclaw tasks show <lookup>
|
||||
openclaw tasks notify <lookup> state_changes
|
||||
openclaw tasks cancel <lookup>
|
||||
openclaw tasks audit
|
||||
openclaw tasks maintenance
|
||||
openclaw tasks maintenance --apply
|
||||
openclaw tasks flow list
|
||||
openclaw tasks flow show <lookup>
|
||||
openclaw tasks flow cancel <lookup>
|
||||
```
|
||||
|
||||
## Root Options
|
||||
|
||||
- `--json`: output JSON.
|
||||
- `--runtime <name>`: filter by kind: `subagent`, `acp`, `cron`, or `cli`.
|
||||
- `--status <name>`: filter by status: `queued`, `running`, `succeeded`, `failed`, `timed_out`, `cancelled`, or `lost`.
|
||||
|
||||
## Subcommands
|
||||
|
||||
### `list`
|
||||
|
||||
```bash
|
||||
openclaw tasks list [--runtime <name>] [--status <name>] [--json]
|
||||
```
|
||||
|
||||
Lists tracked background tasks newest first.
|
||||
|
||||
### `show`
|
||||
|
||||
```bash
|
||||
openclaw tasks show <lookup> [--json]
|
||||
```
|
||||
|
||||
Shows one task by task ID, run ID, or session key.
|
||||
|
||||
### `notify`
|
||||
|
||||
```bash
|
||||
openclaw tasks notify <lookup> <done_only|state_changes|silent>
|
||||
```
|
||||
|
||||
Changes the notification policy for a running task.
|
||||
|
||||
### `cancel`
|
||||
|
||||
```bash
|
||||
openclaw tasks cancel <lookup>
|
||||
```
|
||||
|
||||
Cancels a running background task.
|
||||
|
||||
### `audit`
|
||||
|
||||
```bash
|
||||
openclaw tasks audit [--severity <warn|error>] [--code <name>] [--limit <n>] [--json]
|
||||
```
|
||||
|
||||
Surfaces stale, lost, delivery-failed, or otherwise inconsistent task and Task Flow records.
|
||||
|
||||
### `maintenance`
|
||||
|
||||
```bash
|
||||
openclaw tasks maintenance [--apply] [--json]
|
||||
```
|
||||
|
||||
Previews or applies task and Task Flow reconciliation, cleanup stamping, and pruning.
|
||||
|
||||
### `flow`
|
||||
|
||||
```bash
|
||||
openclaw tasks flow list [--status <name>] [--json]
|
||||
openclaw tasks flow show <lookup> [--json]
|
||||
openclaw tasks flow cancel <lookup>
|
||||
```
|
||||
|
||||
Inspects or cancels durable Task Flow state under the task ledger.
|
||||
Reference in New Issue
Block a user