vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-18 20:14:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(cli): expand docs and tasks-flow CLI references with verified options

Browse Source
This commit is contained in:
Vincent Koc
2026-05-10 22:16:55 +08:00
parent 8b82b9dfcf
commit 33eb0b9eee
2 changed files with 82 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/cli/flows.md
View File

@@ -1,23 +1,52 @@
---
summary: "Redirect: flow commands live under `openclaw tasks flow`"
read_when:
- You encounter openclaw flows in older docs or release notes
- You encounter `openclaw flows` in older docs or release notes
- You want a quick TaskFlow inspection reference
title: "Flows (redirect)"
---
# `openclaw tasks flow`
Flow commands are subcommands of `openclaw tasks`, not a standalone `flows` command.
There is no top-level `openclaw flows` command. Durable TaskFlow inspection lives under `openclaw tasks flow`.
## Subcommands
```bash
openclaw tasks flow list [--json]
openclaw tasks flow show <lookup>
openclaw tasks flow list [--json] [--status <name>]
openclaw tasks flow show <lookup> [--json]
openclaw tasks flow cancel <lookup>
```
For full documentation see [Task Flow](/automation/taskflow) and the [tasks CLI reference](/cli/tasks).
| Subcommand | Description | Arguments / options |
| ---------- | -------------------------- | ------------------------------------------------------------------------------------- |
| `list` | List tracked TaskFlows. | `--json` machine-readable output; `--status <name>` filter (see status values below). |
| `show` | Show one TaskFlow. | `<lookup>` flow id or owner key; `--json` machine-readable output. |
| `cancel` | Cancel a running TaskFlow. | `<lookup>` flow id or owner key. |
`<lookup>` accepts either a flow id (returned by `list` / `show`) or the flow's owner key (the stable identifier the owning subsystem uses to track the flow).
### Status filter values
`--status` on `list` accepts one of:
`queued`, `running`, `waiting`, `blocked`, `succeeded`, `failed`, `cancelled`, `lost`
## Examples
```bash
openclaw tasks flow list
openclaw tasks flow list --status running
openclaw tasks flow list --json
openclaw tasks flow show flow_abc123
openclaw tasks flow show flow_abc123 --json
openclaw tasks flow cancel flow_abc123
```
For full TaskFlow concepts and authoring see [TaskFlow](/automation/taskflow). For the parent `tasks` command see [tasks CLI reference](/cli/tasks).
## Related
- [CLI reference](/cli)
- [Automation](/automation)
- [TaskFlow](/automation/taskflow)