diff --git a/CHANGELOG.md b/CHANGELOG.md index be684087773..7a9c5f95fb7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -42,7 +42,7 @@ Docs: https://docs.openclaw.ai - Podman/launch: remove noisy container output from `scripts/run-openclaw-podman.sh` and align the Podman install guidance with the quieter startup flow. (#59368) Thanks @sallyom. - MS Teams/streaming: strip already-streamed text from fallback block delivery when replies exceed the 4000-character streaming limit so long responses stop duplicating content. (#59297) Thanks @bradgroux. - MS Teams/logging: format non-`Error` failures with the shared unknown-error helper so logs stop collapsing caught SDK or Axios objects into `[object Object]`. (#59321) Thanks @bradgroux. -- Slack/thread context: filter thread starter and history by the effective conversation allowlist without dropping valid open-room, DM, or group DM context. (#58380) +- Slack/thread context: filter thread starter and history by the effective conversation allowlist without dropping valid open-room, DM, or group DM context. (#58380) Thanks @jacobtomlinson. - ACP/gateway reconnects: reject stale pre-ack ACP prompts after reconnect grace expiry so callers fail cleanly instead of hanging indefinitely when the gateway never confirms the run. ## 2026.4.1-beta.1 diff --git a/docs/automation/clawflow.md b/docs/automation/clawflow.md index f1c5db74a3d..7e9a662dedf 100644 --- a/docs/automation/clawflow.md +++ b/docs/automation/clawflow.md @@ -1,50 +1,51 @@ --- -summary: "Compatibility note for older ClawFlow references in release notes and docs" +summary: "TaskFlow flow orchestration layer above background tasks" read_when: - - You encounter ClawFlow or openclaw flows in older release notes or docs - - You want to understand what ClawFlow terminology maps to in the current CLI - - You want to translate older flow references into the supported task commands -title: "ClawFlow" + - You want to understand how TaskFlow relates to background tasks + - You encounter ClawFlow or openclaw flows in release notes or docs + - You want to inspect or manage durable flow state +title: "TaskFlow" --- -# ClawFlow +# TaskFlow -`ClawFlow` appears in some older OpenClaw release notes and documentation as if it were a user-facing runtime with its own `openclaw flows` command surface. +TaskFlow is the flow orchestration substrate that sits above [background tasks](/automation/tasks). It manages durable multi-step flows with their own state, revision tracking, and sync semantics while individual tasks remain the unit of detached work. -That is not the current operator-facing surface in this repository. +## Sync modes -Today, the supported CLI surface for inspecting and managing detached work is [`openclaw tasks`](/automation/tasks). +TaskFlow supports two sync modes: -## What to use today +- **Managed** — TaskFlow owns the lifecycle end-to-end, creating and driving tasks as flow steps progress. +- **Mirrored** — TaskFlow observes externally created tasks and keeps flow state in sync without taking ownership of task creation. -- `openclaw tasks list` shows tracked detached runs -- `openclaw tasks show ` shows one task by task id, run id, or session key -- `openclaw tasks cancel ` cancels a running task -- `openclaw tasks audit` surfaces stale or broken task runs +## Durable state and revision tracking + +Each flow persists its own state and tracks revisions so progress survives gateway restarts. Revision tracking enables conflict detection when multiple sources attempt to advance the same flow. + +## CLI commands ```bash -openclaw tasks list -openclaw tasks show -openclaw tasks cancel +# List active and recent flows +openclaw flows list + +# Show details for a specific flow +openclaw flows show + +# Cancel a running flow +openclaw flows cancel ``` -## What this means for older references +- `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 -If you see `ClawFlow` or `openclaw flows` in: +## How flows relate to tasks -- old release notes -- issue threads -- stale search results -- outdated local notes - -translate those instructions to the current task CLI: - -- `openclaw flows list` -> `openclaw tasks list` -- `openclaw flows show ` -> `openclaw tasks show ` -- `openclaw flows cancel ` -> `openclaw tasks cancel ` +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. ## Related -- [Background Tasks](/automation/tasks) — detached work ledger -- [CLI: flows](/cli/flows) — compatibility note for the mistaken command name -- [Cron Jobs](/automation/cron-jobs) — scheduled jobs that may create tasks +- [Background Tasks](/automation/tasks) — the detached work ledger that flows coordinate +- [CLI: flows](/cli/flows) — CLI command reference for `openclaw flows` +- [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/index.md b/docs/automation/index.md index dace088af36..5f5e60217a7 100644 --- a/docs/automation/index.md +++ b/docs/automation/index.md @@ -54,15 +54,13 @@ The most effective setups combine multiple mechanisms: See [Cron vs Heartbeat](/automation/cron-vs-heartbeat) for a detailed comparison of the two scheduling mechanisms. -## Older ClawFlow references +## TaskFlow -Older release notes and docs may mention `ClawFlow` or `openclaw flows`, but the current CLI surface in this repo is `openclaw tasks`. - -See [Background Tasks](/automation/tasks) for the supported task ledger commands, plus [ClawFlow](/automation/clawflow) and [CLI: flows](/cli/flows) for compatibility notes. +[TaskFlow](/automation/clawflow) 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/clawflow) for details. ## Related - [Cron vs Heartbeat](/automation/cron-vs-heartbeat) — detailed comparison guide -- [ClawFlow](/automation/clawflow) — compatibility note for older docs and release notes +- [TaskFlow](/automation/clawflow) — flow orchestration above tasks - [Troubleshooting](/automation/troubleshooting) — debugging automation issues - [Configuration Reference](/gateway/configuration-reference) — all config keys diff --git a/docs/automation/tasks.md b/docs/automation/tasks.md index d8d76fba10c..675f6447a71 100644 --- a/docs/automation/tasks.md +++ b/docs/automation/tasks.md @@ -224,11 +224,11 @@ A sweeper runs every **60 seconds** and handles three things: ## How tasks relate to other systems -### Tasks and older flow references +### Tasks and TaskFlow -Some older OpenClaw release notes and docs referred to task management as `ClawFlow` and documented an `openclaw flows` command surface. +[TaskFlow](/automation/clawflow) 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. -In the current codebase, the supported operator surface is `openclaw tasks`. See [ClawFlow](/automation/clawflow) and [CLI: flows](/cli/flows) for compatibility notes that map those older references to the current task commands. +See [TaskFlow](/automation/clawflow) and [CLI: flows](/cli/flows) for details. ### Tasks and cron @@ -253,9 +253,9 @@ A task's `runId` links to the agent run doing the work. Agent lifecycle events ( ## Related - [Automation Overview](/automation) — all automation mechanisms at a glance -- [ClawFlow](/automation/clawflow) — compatibility note for older docs and release notes +- [TaskFlow](/automation/clawflow) — flow orchestration above tasks - [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) — compatibility note for the mistaken command name +- [CLI: flows](/cli/flows) — CLI reference for `openclaw flows` - [CLI: Tasks](/cli/index#tasks) — CLI command reference diff --git a/docs/cli/flows.md b/docs/cli/flows.md index 667c75f5c90..92e6c73e048 100644 --- a/docs/cli/flows.md +++ b/docs/cli/flows.md @@ -1,36 +1,43 @@ --- -summary: "Compatibility note for the mistakenly documented `openclaw flows` command" +summary: "CLI reference for `openclaw flows` commands" read_when: - - You encounter openclaw flows in older release notes, issue threads, or search results - - You want to know what command replaced openclaw flows + - You want to list, inspect, or cancel TaskFlow flows from the CLI + - You encounter openclaw flows in release notes or docs title: "flows" --- # `openclaw flows` -`openclaw flows` is **not** a current OpenClaw CLI command. +Inspect and manage [TaskFlow](/automation/clawflow) flows from the command line. -Some older release notes and docs mistakenly documented a `flows` command surface. The supported operator surface is [`openclaw tasks`](/automation/tasks). +## Commands + +### `flows list` ```bash -openclaw tasks list -openclaw tasks show -openclaw tasks cancel +openclaw flows list [--json] ``` -## Use instead +List active and recent flows with status and sync mode. -- `openclaw tasks list` — list tracked background tasks -- `openclaw tasks show ` — inspect one task by task id, run id, or session key -- `openclaw tasks cancel ` — cancel a running background task -- `openclaw tasks notify ` — change task notification behavior -- `openclaw tasks audit` — surface stale or broken task runs +### `flows show` -## Why this page exists +```bash +openclaw flows show +``` -This page stays in place so existing links from older changelog entries, issue threads, and search results have a clear correction instead of a dead end. +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 -- [Background Tasks](/automation/tasks) — detached work ledger +- [TaskFlow](/automation/clawflow) — flow orchestration overview +- [Background Tasks](/automation/tasks) — the detached work ledger - [CLI reference](/cli/index) — full command tree diff --git a/docs/cli/index.md b/docs/cli/index.md index 3754c12112b..1b3747be011 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -46,6 +46,7 @@ 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) @@ -172,6 +173,10 @@ openclaw [--dev] [--profile ] show notify cancel + flows + list + show + cancel gateway call health diff --git a/docs/tools/lobster.md b/docs/tools/lobster.md index 8fae07459de..e6be9721196 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. If you run into older `ClawFlow` terminology, treat it as historical naming around the same task-oriented runtime area; the current operator-facing CLI surface is [`openclaw tasks`](/automation/tasks). +Lobster is one authoring layer above detached background work. For flow orchestration above individual tasks, see [TaskFlow](/automation/clawflow) (`openclaw flows`). For the task activity ledger, see [`openclaw tasks`](/automation/tasks). ## Hook