From ec17260e264ca816325c8068ffd36fc4aab9357a Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Thu, 2 Apr 2026 19:28:49 +0900 Subject: [PATCH] docs: rename ClawFlow to TaskFlow and update references --- docs/automation/clawflow.md | 51 +++---------------------------------- docs/automation/index.md | 4 +-- docs/automation/taskflow.md | 51 +++++++++++++++++++++++++++++++++++++ docs/automation/tasks.md | 6 ++--- docs/cli/flows.md | 4 +-- docs/docs.json | 6 ++++- docs/tools/lobster.md | 2 +- 7 files changed, 68 insertions(+), 56 deletions(-) create mode 100644 docs/automation/taskflow.md diff --git a/docs/automation/clawflow.md b/docs/automation/clawflow.md index 7e9a662dedf..13e6729f9e7 100644 --- a/docs/automation/clawflow.md +++ b/docs/automation/clawflow.md @@ -1,51 +1,8 @@ --- -summary: "TaskFlow flow orchestration layer above background tasks" -read_when: - - 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" +summary: "Redirect to TaskFlow" +title: "ClawFlow" --- -# TaskFlow +# ClawFlow -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. - -## Sync modes - -TaskFlow supports two sync modes: - -- **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. - -## 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 -# List active and recent flows -openclaw flows list - -# Show details for a specific flow -openclaw flows show - -# Cancel a running flow -openclaw flows 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 - -## 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. - -## Related - -- [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 +ClawFlow was renamed to [TaskFlow](/automation/taskflow). See [TaskFlow](/automation/taskflow) for the current documentation. diff --git a/docs/automation/index.md b/docs/automation/index.md index 5f5e60217a7..9afd3cc94a5 100644 --- a/docs/automation/index.md +++ b/docs/automation/index.md @@ -56,11 +56,11 @@ See [Cron vs Heartbeat](/automation/cron-vs-heartbeat) for a detailed comparison ## TaskFlow -[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. +[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. ## Related - [Cron vs Heartbeat](/automation/cron-vs-heartbeat) — detailed comparison guide -- [TaskFlow](/automation/clawflow) — flow orchestration above tasks +- [TaskFlow](/automation/taskflow) — flow orchestration above tasks - [Troubleshooting](/automation/troubleshooting) — debugging automation issues - [Configuration Reference](/gateway/configuration-reference) — all config keys diff --git a/docs/automation/taskflow.md b/docs/automation/taskflow.md new file mode 100644 index 00000000000..9f95228e07e --- /dev/null +++ b/docs/automation/taskflow.md @@ -0,0 +1,51 @@ +--- +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 want to inspect or manage durable flow state +title: "TaskFlow" +--- + +# TaskFlow + +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. + +## Sync modes + +TaskFlow supports two sync modes: + +- **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. + +## 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 +# List active and recent flows +openclaw flows list + +# Show details for a specific flow +openclaw flows show + +# Cancel a running flow +openclaw flows 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 + +## 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. + +## Related + +- [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/tasks.md b/docs/automation/tasks.md index 675f6447a71..a55f677e219 100644 --- a/docs/automation/tasks.md +++ b/docs/automation/tasks.md @@ -226,9 +226,9 @@ A sweeper runs every **60 seconds** and handles three things: ### Tasks and TaskFlow -[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. +[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. -See [TaskFlow](/automation/clawflow) and [CLI: flows](/cli/flows) for details. +See [TaskFlow](/automation/taskflow) and [CLI: flows](/cli/flows) for details. ### Tasks and cron @@ -253,7 +253,7 @@ 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 -- [TaskFlow](/automation/clawflow) — flow orchestration above tasks +- [TaskFlow](/automation/taskflow) — 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 diff --git a/docs/cli/flows.md b/docs/cli/flows.md index 92e6c73e048..997af36a675 100644 --- a/docs/cli/flows.md +++ b/docs/cli/flows.md @@ -8,7 +8,7 @@ title: "flows" # `openclaw flows` -Inspect and manage [TaskFlow](/automation/clawflow) flows from the command line. +Inspect and manage [TaskFlow](/automation/taskflow) flows from the command line. ## Commands @@ -38,6 +38,6 @@ Cancel a running flow and its active tasks. ## Related -- [TaskFlow](/automation/clawflow) — flow orchestration overview +- [TaskFlow](/automation/taskflow) — flow orchestration overview - [Background Tasks](/automation/tasks) — the detached work ledger - [CLI reference](/cli/index) — full command tree diff --git a/docs/docs.json b/docs/docs.json index cef0331dad2..1461e10c0a0 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -879,6 +879,10 @@ { "source": "/gateway/trusted-proxy", "destination": "/gateway/trusted-proxy-auth" + }, + { + "source": "/automation/clawflow", + "destination": "/automation/taskflow" } ], "navigation": { @@ -1122,7 +1126,7 @@ "automation/cron-jobs", "automation/cron-vs-heartbeat", "automation/tasks", - "automation/clawflow", + "automation/taskflow", "automation/troubleshooting", "automation/webhook", "automation/gmail-pubsub", diff --git a/docs/tools/lobster.md b/docs/tools/lobster.md index e6be9721196..08e9ae3b3a1 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/clawflow) (`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 flows`). For the task activity ledger, see [`openclaw tasks`](/automation/tasks). ## Hook