diff --git a/docs/automation/index.md b/docs/automation/index.md index 9afd3cc94a5..203dd0b83c0 100644 --- a/docs/automation/index.md +++ b/docs/automation/index.md @@ -56,7 +56,7 @@ See [Cron vs Heartbeat](/automation/cron-vs-heartbeat) for a detailed comparison ## TaskFlow -[TaskFlow](/automation/taskflow) is the flow orchestration substrate above background tasks. It manages durable multi-step flows with managed and mirrored sync modes, and exposes `openclaw flows list|show|cancel` for inspection and recovery. See [TaskFlow](/automation/taskflow) for details. +[TaskFlow](/automation/taskflow) is the flow orchestration substrate above background tasks. It manages durable multi-step flows with managed and mirrored sync modes, and exposes `openclaw tasks flow list|show|cancel` for inspection and recovery. See [TaskFlow](/automation/taskflow) for details. ## Related diff --git a/docs/automation/taskflow.md b/docs/automation/taskflow.md index 9f95228e07e..3bfd4862b47 100644 --- a/docs/automation/taskflow.md +++ b/docs/automation/taskflow.md @@ -2,7 +2,7 @@ summary: "TaskFlow flow orchestration layer above background tasks" read_when: - You want to understand how TaskFlow relates to background tasks - - You encounter TaskFlow or openclaw flows in release notes or docs + - You encounter TaskFlow or openclaw tasks flow in release notes or docs - You want to inspect or manage durable flow state title: "TaskFlow" --- @@ -26,26 +26,26 @@ Each flow persists its own state and tracks revisions so progress survives gatew ```bash # List active and recent flows -openclaw flows list +openclaw tasks flow list # Show details for a specific flow -openclaw flows show +openclaw tasks flow show # Cancel a running flow -openclaw flows cancel +openclaw tasks flow cancel ``` -- `openclaw flows list` — shows tracked flows with status and sync mode -- `openclaw flows show ` — inspect one flow by flow id or lookup key -- `openclaw flows cancel ` — cancel a running flow and its active tasks +- `openclaw tasks flow list` — shows tracked flows with status and sync mode +- `openclaw tasks flow show ` — inspect one flow by flow id or lookup key +- `openclaw tasks flow cancel ` — cancel a running flow and its active tasks ## How flows relate to tasks -Flows coordinate tasks, not replace them. A single flow may drive multiple background tasks over its lifetime. Use `openclaw tasks` to inspect individual task records and `openclaw flows` to inspect the orchestrating flow. +Flows coordinate tasks, not replace them. A single flow may drive multiple background tasks over its lifetime. Use `openclaw tasks` to inspect individual task records and `openclaw tasks flow` to inspect the orchestrating flow. ## Related - [Background Tasks](/automation/tasks) — the detached work ledger that flows coordinate -- [CLI: flows](/cli/flows) — CLI command reference for `openclaw flows` +- [CLI: tasks](/cli/index#tasks) — CLI command reference for `openclaw tasks flow` - [Automation Overview](/automation) — all automation mechanisms at a glance - [Cron Jobs](/automation/cron-jobs) — scheduled jobs that may feed into flows diff --git a/docs/automation/tasks.md b/docs/automation/tasks.md index a55f677e219..1bc3375447b 100644 --- a/docs/automation/tasks.md +++ b/docs/automation/tasks.md @@ -59,7 +59,7 @@ openclaw tasks audit | ACP background runs | `acp` | Spawning a child ACP session | `done_only` | | Subagent orchestration | `subagent` | Spawning a subagent via `sessions_spawn` | `done_only` | | Cron jobs (all types) | `cron` | Every cron execution (main-session and isolated) | `silent` | -| CLI operations | `cli` | `openclaw agent` commands that run through the gateway | `done_only` | +| CLI operations | `cli` | `openclaw agent` commands that run through the gateway | `silent` | Main-session cron tasks use `silent` notify policy by default — they create records for tracking but do not generate notifications. Isolated cron tasks also default to `silent` but are more visible because they run in their own session. @@ -226,9 +226,9 @@ A sweeper runs every **60 seconds** and handles three things: ### Tasks and TaskFlow -[TaskFlow](/automation/taskflow) is the flow orchestration layer above background tasks. A single flow may coordinate multiple tasks over its lifetime using managed or mirrored sync modes. Use `openclaw tasks` to inspect individual task records and `openclaw flows` to inspect the orchestrating flow. +[TaskFlow](/automation/taskflow) is the flow orchestration layer above background tasks. A single flow may coordinate multiple tasks over its lifetime using managed or mirrored sync modes. Use `openclaw tasks` to inspect individual task records and `openclaw tasks flow` to inspect the orchestrating flow. -See [TaskFlow](/automation/taskflow) and [CLI: flows](/cli/flows) for details. +See [TaskFlow](/automation/taskflow) for details. ### Tasks and cron @@ -257,5 +257,5 @@ A task's `runId` links to the agent run doing the work. Agent lifecycle events ( - [Cron Jobs](/automation/cron-jobs) — scheduling background work - [Cron vs Heartbeat](/automation/cron-vs-heartbeat) — choosing the right mechanism - [Heartbeat](/gateway/heartbeat) — periodic main-session turns -- [CLI: flows](/cli/flows) — CLI reference for `openclaw flows` +- [CLI: tasks](/cli/index#tasks) — CLI reference for `openclaw tasks flow` - [CLI: Tasks](/cli/index#tasks) — CLI command reference diff --git a/docs/cli/flows.md b/docs/cli/flows.md index 997af36a675..47f437dd870 100644 --- a/docs/cli/flows.md +++ b/docs/cli/flows.md @@ -1,43 +1,18 @@ --- -summary: "CLI reference for `openclaw flows` commands" +summary: "Redirect: flow commands live under `openclaw tasks flow`" read_when: - - You want to list, inspect, or cancel TaskFlow flows from the CLI - - You encounter openclaw flows in release notes or docs -title: "flows" + - You encounter openclaw flows in older docs or release notes +title: "flows (redirect)" --- -# `openclaw flows` +# `openclaw tasks flow` -Inspect and manage [TaskFlow](/automation/taskflow) flows from the command line. - -## Commands - -### `flows list` +Flow commands are subcommands of `openclaw tasks`, not a standalone `flows` command. ```bash -openclaw flows list [--json] +openclaw tasks flow list [--json] +openclaw tasks flow show +openclaw tasks flow cancel ``` -List active and recent flows with status and sync mode. - -### `flows show` - -```bash -openclaw flows show -``` - -Show details for a specific flow by flow id or lookup key, including state, revision history, and associated tasks. - -### `flows cancel` - -```bash -openclaw flows cancel -``` - -Cancel a running flow and its active tasks. - -## Related - -- [TaskFlow](/automation/taskflow) — flow orchestration overview -- [Background Tasks](/automation/tasks) — the detached work ledger -- [CLI reference](/cli/index) — full command tree +For full documentation see [TaskFlow](/automation/taskflow) and the [tasks CLI reference](/cli/index#tasks). diff --git a/docs/cli/index.md b/docs/cli/index.md index 1b3747be011..20ee06d3821 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -46,7 +46,6 @@ This page describes the current CLI behavior. If commands change, update this do - [`browser`](/cli/browser) - [`cron`](/cli/cron) - [`tasks`](/cli/index#tasks) -- [`flows`](/cli/flows) - [`dns`](/cli/dns) - [`docs`](/cli/docs) - [`hooks`](/cli/hooks) @@ -173,10 +172,7 @@ openclaw [--dev] [--profile ] show notify cancel - flows - list - show - cancel + flow list|show|cancel gateway call health @@ -814,6 +810,9 @@ List and manage [background task](/automation/tasks) runs across agents. - `tasks notify ` — change notification policy for a task run - `tasks cancel ` — cancel a running task - `tasks audit` — surface operational issues (stale, lost, delivery failures) +- `tasks flow list` — list active and recent TaskFlow flows +- `tasks flow show ` — inspect a flow by id or lookup key +- `tasks flow cancel ` — cancel a running flow and its active tasks ## Gateway diff --git a/docs/tools/lobster.md b/docs/tools/lobster.md index 08e9ae3b3a1..f71f749b393 100644 --- a/docs/tools/lobster.md +++ b/docs/tools/lobster.md @@ -10,7 +10,7 @@ read_when: Lobster is a workflow shell that lets OpenClaw run multi-step tool sequences as a single, deterministic operation with explicit approval checkpoints. -Lobster is one authoring layer above detached background work. For flow orchestration above individual tasks, see [TaskFlow](/automation/taskflow) (`openclaw flows`). For the task activity ledger, see [`openclaw tasks`](/automation/tasks). +Lobster is one authoring layer above detached background work. For flow orchestration above individual tasks, see [TaskFlow](/automation/taskflow) (`openclaw tasks flow`). For the task activity ledger, see [`openclaw tasks`](/automation/tasks). ## Hook