TaskFlow
DashboardFreewriteWhiteboardsProjectsCRMTasksNotificationsSettingsAgent TowerAPI Docs
OpenClaw Docs
?

User

Member

Caricamento in corso...

Home
Progetti
Task
Notifiche
CRM

    OpenClaw

    Documentation Mirror

    Documentation Overview

    Docs

    Auth credential semantics
    Scheduled tasks
    Hooks
    Automation & tasks
    Standing orders
    Task flow
    Background tasks
    BlueBubbles
    Broadcast groups
    Channel routing
    Discord
    Feishu
    Google Chat
    Group messages
    Groups
    iMessage
    Chat channels
    IRC
    LINE
    Channel location parsing
    Matrix
    Matrix migration
    Matrix push rules for quiet previews
    Mattermost
    Microsoft Teams
    Nextcloud Talk
    Nostr
    Pairing
    QA channel
    QQ bot
    Signal
    Slack
    Synology Chat
    Telegram
    Tlon
    Channel troubleshooting
    Twitch
    WeChat
    WhatsApp
    Yuanbao
    Zalo
    Zalo personal
    CI pipeline
    ACP
    Agent
    Agents
    Approvals
    Backup
    Browser
    Channels
    Clawbot
    `openclaw commitments`
    Completion
    Config
    Configure
    Cron
    Daemon
    Dashboard
    Devices
    Directory
    DNS
    Docs
    Doctor
    Flows (redirect)
    Gateway
    Health
    Hooks
    CLI reference
    Inference CLI
    Logs
    MCP
    Memory
    Message
    Migrate
    Models
    Node
    Nodes
    Onboard
    Pairing
    Plugins
    Proxy
    QR
    Reset
    Sandbox CLI
    Secrets
    Security
    Sessions
    Setup
    Skills
    Status
    System
    `openclaw tasks`
    TUI
    Uninstall
    Update
    Voicecall
    Webhooks
    Wiki
    Active memory
    Agent runtime
    Agent loop
    Agent runtimes
    Agent workspace
    Gateway architecture
    Channel docking
    Inferred commitments
    Compaction
    Context
    Context engine
    Delegate architecture
    Dreaming
    Experimental features
    Features
    Markdown formatting
    Memory overview
    Builtin memory engine
    Honcho memory
    QMD memory engine
    Memory search
    Messages
    Model failover
    Model providers
    Models CLI
    Multi-agent routing
    OAuth
    OpenClaw App SDK
    Presence
    QA overview
    Matrix QA
    Command queue
    Steering queue
    Retry policy
    Session management
    Session pruning
    Session tools
    SOUL.md personality guide
    Streaming and chunking
    System prompt
    Timezones
    TypeBox
    Typing indicators
    Usage tracking
    Date and time
    Node + tsx crash
    Diagnostics flags
    Authentication
    Background exec and process tool
    Bonjour discovery
    Bridge protocol
    CLI backends
    Configuration — agents
    Configuration — channels
    Configuration — tools and custom providers
    Configuration
    Configuration examples
    Configuration reference
    Diagnostics export
    Discovery and transports
    Doctor
    Gateway lock
    Health checks
    Heartbeat
    Gateway runbook
    Local models
    Gateway logging
    Multiple gateways
    Network model
    OpenAI chat completions
    OpenResponses API
    OpenShell
    OpenTelemetry export
    Gateway-owned pairing
    Prometheus metrics
    Gateway protocol
    Remote access
    Remote gateway setup
    Sandbox vs tool policy vs elevated
    Sandboxing
    Secrets management
    Secrets apply plan contract
    Security audit checks
    Security
    Tailscale
    Tools invoke API
    Troubleshooting
    Trusted proxy auth
    Debugging
    Environment variables
    FAQ
    FAQ: first-run setup
    FAQ: models and auth
    GPT-5.5 / Codex agentic parity
    GPT-5.5 / Codex parity maintainer notes
    Help
    Scripts
    Testing
    Testing: live suites
    General troubleshooting
    OpenClaw
    Ansible
    Azure
    Bun (experimental)
    ClawDock
    Release channels
    DigitalOcean
    Docker
    Docker VM runtime
    exe.dev
    Fly.io
    GCP
    Hetzner
    Hostinger
    Install
    Installer internals
    Kubernetes
    macOS VMs
    Migration guide
    Migrating from Claude
    Migrating from Hermes
    Nix
    Node.js
    Northflank
    Oracle Cloud
    Podman
    Railway
    Raspberry Pi
    Render
    Uninstall
    Updating
    Logging
    Network
    Audio and voice notes
    Camera capture
    Image and media support
    Nodes
    Location command
    Media understanding
    Talk mode
    Node troubleshooting
    Voice wake
    Pi integration architecture
    Pi development workflow
    Android app
    Platforms
    iOS app
    Linux app
    Gateway on macOS
    Canvas
    Gateway lifecycle
    macOS dev setup
    Health checks (macOS)
    Menu bar icon
    macOS logging
    Menu bar
    Peekaboo bridge
    macOS permissions
    Remote control
    macOS signing
    Skills (macOS)
    Voice overlay
    Voice wake (macOS)
    WebChat (macOS)
    macOS IPC
    macOS app
    Windows
    Plugin internals
    Plugin architecture internals
    Building plugins
    Plugin bundles
    Codex Computer Use
    Codex harness
    Community plugins
    Plugin compatibility
    Google Meet plugin
    Plugin hooks
    Plugin manifest
    Memory LanceDB
    Memory wiki
    Message presentation
    Agent harness plugins
    Building channel plugins
    Channel turn kernel
    Plugin entry points
    Plugin SDK migration
    Plugin SDK overview
    Building provider plugins
    Plugin runtime helpers
    Plugin setup and config
    Plugin SDK subpaths
    Plugin testing
    Skill workshop plugin
    Voice call plugin
    Webhooks plugin
    Zalo personal plugin
    OpenProse
    Alibaba Model Studio
    Anthropic
    Arcee AI
    Azure Speech
    Amazon Bedrock
    Amazon Bedrock Mantle
    Chutes
    Claude Max API proxy
    Cloudflare AI gateway
    ComfyUI
    Deepgram
    Deepinfra
    DeepSeek
    ElevenLabs
    Fal
    Fireworks
    GitHub Copilot
    GLM (Zhipu)
    Google (Gemini)
    Gradium
    Groq
    Hugging Face (inference)
    Provider directory
    Inferrs
    Inworld
    Kilocode
    LiteLLM
    LM Studio
    MiniMax
    Mistral
    Model provider quickstart
    Moonshot AI
    NVIDIA
    Ollama
    OpenAI
    OpenCode
    OpenCode Go
    OpenRouter
    Perplexity
    Qianfan
    Qwen
    Runway
    SGLang
    StepFun
    Synthetic
    Tencent Cloud (TokenHub)
    Together AI
    Venice AI
    Vercel AI gateway
    vLLM
    Volcengine (Doubao)
    Vydra
    xAI
    Xiaomi MiMo
    Z.AI
    Default AGENTS.md
    Release policy
    API usage and costs
    Credits
    Device model database
    Full release validation
    Memory configuration reference
    OpenClaw App SDK API design
    Prompt caching
    Rich output protocol
    RPC adapters
    SecretRef credential surface
    Session management deep dive
    AGENTS.md template
    BOOT.md template
    BOOTSTRAP.md template
    HEARTBEAT.md template
    IDENTITY template
    SOUL.md template
    TOOLS.md template
    USER template
    Tests
    Token use and costs
    Transcript hygiene
    Onboarding reference
    Contributing to the threat model
    Threat model (MITRE ATLAS)
    Formal verification (security models)
    Network proxy
    Agent bootstrapping
    Docs directory
    Getting started
    Docs hubs
    OpenClaw lore
    Onboarding (macOS app)
    Onboarding overview
    Personal assistant setup
    Setup
    Showcase
    Onboarding (CLI)
    CLI automation
    CLI setup reference
    ACP agents
    ACP agents — setup
    Agent send
    apply_patch tool
    Brave search
    Browser (OpenClaw-managed)
    Browser control API
    Browser troubleshooting
    Browser login
    WSL2 + Windows + remote Chrome CDP troubleshooting
    BTW side questions
    ClawHub
    Code execution
    Creating skills
    Diffs
    DuckDuckGo search
    Elevated mode
    Exa search
    Exec tool
    Exec approvals
    Exec approvals — advanced
    Firecrawl
    Gemini search
    Grok search
    Image generation
    Tools and plugins
    Kimi search
    LLM task
    Lobster
    Tool-loop detection
    Media overview
    MiniMax search
    Multi-agent sandbox and tools
    Music generation
    Ollama web search
    PDF tool
    Perplexity search
    Plugins
    Reactions
    SearXNG search
    Skills
    Skills config
    Slash commands
    Sub-agents
    Tavily
    Thinking levels
    Tokenjuice
    Trajectory bundles
    Text-to-speech
    Video generation
    Web search
    Web fetch
    Linux server
    Control UI
    Dashboard
    Web
    TUI
    WebChat

    OpenAPI Specs

    openapi
    TaskFlow
    docs/openclaw
    Original Docs

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:03:00

    Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

    OpenClaw Docs

    v2.4.0 Production

    Last synced: Today, 22:00

    Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

    Use this file to discover all available pages before exploring further.

    Lobster

    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 Task Flow (

    text
    openclaw tasks flow
    ). For the task activity ledger, see
    text
    openclaw tasks
    .

    Hook

    Your assistant can build the tools that manage itself. Ask for a workflow, and 30 minutes later you have a CLI plus pipelines that run as one call. Lobster is the missing piece: deterministic pipelines, explicit approvals, and resumable state.

    Why

    Today, complex workflows require many back-and-forth tool calls. Each call costs tokens, and the LLM has to orchestrate every step. Lobster moves that orchestration into a typed runtime:

    • One call instead of many: OpenClaw runs one Lobster tool call and gets a structured result.
    • Approvals built in: Side effects (send email, post comment) halt the workflow until explicitly approved.
    • Resumable: Halted workflows return a token; approve and resume without re-running everything.

    Why a DSL instead of plain programs?

    Lobster is intentionally small. The goal is not "a new language," it's a predictable, AI-friendly pipeline spec with first-class approvals and resume tokens.

    • Approve/resume is built in: A normal program can prompt a human, but it can’t pause and resume with a durable token without you inventing that runtime yourself.
    • Determinism + auditability: Pipelines are data, so they’re easy to log, diff, replay, and review.
    • Constrained surface for AI: A tiny grammar + JSON piping reduces “creative” code paths and makes validation realistic.
    • Safety policy baked in: Timeouts, output caps, sandbox checks, and allowlists are enforced by the runtime, not each script.
    • Still programmable: Each step can call any CLI or script. If you want JS/TS, generate
      text
      .lobster
      files from code.

    How it works

    OpenClaw runs Lobster workflows in-process using an embedded runner. No external CLI subprocess is spawned; the workflow engine executes inside the gateway process and returns a JSON envelope directly. If the pipeline pauses for approval, the tool returns a

    text
    resumeToken
    so you can continue later.

    Pattern: small CLI + JSON pipes + approvals

    Build tiny commands that speak JSON, then chain them into a single Lobster call. (Example command names below — swap in your own.)

    bash
    inbox list --json inbox categorize --json inbox apply --json
    json
    { "action": "run", "pipeline": "exec --json --shell 'inbox list --json' | exec --stdin json --shell 'inbox categorize --json' | exec --stdin json --shell 'inbox apply --json' | approve --preview-from-stdin --limit 5 --prompt 'Apply changes?'", "timeoutMs": 30000 }

    If the pipeline requests approval, resume with the token:

    json
    { "action": "resume", "token": "<resumeToken>", "approve": true }

    AI triggers the workflow; Lobster executes the steps. Approval gates keep side effects explicit and auditable.

    Example: map input items into tool calls:

    bash
    gog.gmail.search --query 'newer_than:1d' \ | openclaw.invoke --tool message --action send --each --item-key message --args-json '{"provider":"telegram","to":"..."}'

    JSON-only LLM steps (llm-task)

    For workflows that need a structured LLM step, enable the optional

    text
    llm-task
    plugin tool and call it from Lobster. This keeps the workflow deterministic while still letting you classify/summarize/draft with a model.

    Enable the tool:

    json
    { "plugins": { "entries": { "llm-task": { "enabled": true } } }, "agents": { "list": [ { "id": "main", "tools": { "allow": ["llm-task"] } } ] } }

    Use it in a pipeline:

    lobster
    openclaw.invoke --tool llm-task --action json --args-json '{ "prompt": "Given the input email, return intent and draft.", "thinking": "low", "input": { "subject": "Hello", "body": "Can you help?" }, "schema": { "type": "object", "properties": { "intent": { "type": "string" }, "draft": { "type": "string" } }, "required": ["intent", "draft"], "additionalProperties": false } }'

    See LLM Task for details and configuration options.

    Workflow files (.lobster)

    Lobster can run YAML/JSON workflow files with

    text
    name
    ,
    text
    args
    ,
    text
    steps
    ,
    text
    env
    ,
    text
    condition
    , and
    text
    approval
    fields. In OpenClaw tool calls, set
    text
    pipeline
    to the file path.

    yaml
    name: inbox-triage args: tag: default: "family" steps: - id: collect command: inbox list --json - id: categorize command: inbox categorize --json stdin: $collect.stdout - id: approve command: inbox apply --approve stdin: $categorize.stdout approval: required - id: execute command: inbox apply --execute stdin: $categorize.stdout condition: $approve.approved

    Notes:

    • text
      stdin: $step.stdout
      and
      text
      stdin: $step.json
      pass a prior step’s output.
    • text
      condition
      (or
      text
      when
      ) can gate steps on
      text
      $step.approved
      .

    Install Lobster

    Bundled Lobster workflows run in-process; no separate

    text
    lobster
    binary is required. The embedded runner ships with the Lobster plugin.

    If you need the standalone Lobster CLI for development or external pipelines, install it from the Lobster repo and ensure

    text
    lobster
    is on
    text
    PATH
    .

    Enable the tool

    Lobster is an optional plugin tool (not enabled by default).

    Recommended (additive, safe):

    json
    { "tools": { "alsoAllow": ["lobster"] } }

    Or per-agent:

    json
    { "agents": { "list": [ { "id": "main", "tools": { "alsoAllow": ["lobster"] } } ] } }

    Avoid using

    text
    tools.allow: ["lobster"]
    unless you intend to run in restrictive allowlist mode.

    note

    Allowlists are opt-in for optional plugins. If your allowlist only names plugin tools (like `lobster`), OpenClaw keeps core tools enabled. To restrict core tools, include the core tools or groups you want in the allowlist too.

    Example: Email triage

    Without Lobster:

    text
    User: "Check my email and draft replies" → openclaw calls gmail.list → LLM summarizes → User: "draft replies to #2 and #5" → LLM drafts → User: "send #2" → openclaw calls gmail.send (repeat daily, no memory of what was triaged)

    With Lobster:

    json
    { "action": "run", "pipeline": "email.triage --limit 20", "timeoutMs": 30000 }

    Returns a JSON envelope (truncated):

    json
    { "ok": true, "status": "needs_approval", "output": [{ "summary": "5 need replies, 2 need action" }], "requiresApproval": { "type": "approval_request", "prompt": "Send 2 draft replies?", "items": [], "resumeToken": "..." } }

    User approves → resume:

    json
    { "action": "resume", "token": "<resumeToken>", "approve": true }

    One workflow. Deterministic. Safe.

    Tool parameters

    text
    run

    Run a pipeline in tool mode.

    json
    { "action": "run", "pipeline": "gog.gmail.search --query 'newer_than:1d' | email.triage", "cwd": "workspace", "timeoutMs": 30000, "maxStdoutBytes": 512000 }

    Run a workflow file with args:

    json
    { "action": "run", "pipeline": "/path/to/inbox-triage.lobster", "argsJson": "{\"tag\":\"family\"}" }

    text
    resume

    Continue a halted workflow after approval.

    json
    { "action": "resume", "token": "<resumeToken>", "approve": true }

    Optional inputs

    • text
      cwd
      : Relative working directory for the pipeline (must stay within the gateway working directory).
    • text
      timeoutMs
      : Abort the workflow if it exceeds this duration (default: 20000).
    • text
      maxStdoutBytes
      : Abort the workflow if output exceeds this size (default: 512000).
    • text
      argsJson
      : JSON string passed to
      text
      lobster run --args-json
      (workflow files only).

    Output envelope

    Lobster returns a JSON envelope with one of three statuses:

    • text
      ok
      → finished successfully
    • text
      needs_approval
      → paused;
      text
      requiresApproval.resumeToken
      is required to resume
    • text
      cancelled
      → explicitly denied or cancelled

    The tool surfaces the envelope in both

    text
    content
    (pretty JSON) and
    text
    details
    (raw object).

    Approvals

    If

    text
    requiresApproval
    is present, inspect the prompt and decide:

    • text
      approve: true
      → resume and continue side effects
    • text
      approve: false
      → cancel and finalize the workflow

    Use

    text
    approve --preview-from-stdin --limit N
    to attach a JSON preview to approval requests without custom jq/heredoc glue. Resume tokens are now compact: Lobster stores workflow resume state under its state dir and hands back a small token key.

    OpenProse

    OpenProse pairs well with Lobster: use

    text
    /prose
    to orchestrate multi-agent prep, then run a Lobster pipeline for deterministic approvals. If a Prose program needs Lobster, allow the
    text
    lobster
    tool for sub-agents via
    text
    tools.subagents.tools
    . See OpenProse.

    Safety

    • Local in-process only — workflows execute inside the gateway process; no network calls from the plugin itself.
    • No secrets — Lobster doesn't manage OAuth; it calls OpenClaw tools that do.
    • Sandbox-aware — disabled when the tool context is sandboxed.
    • Hardened — timeouts and output caps enforced by the embedded runner.

    Troubleshooting

    • text
      lobster timed out
      → increase
      text
      timeoutMs
      , or split a long pipeline.
    • text
      lobster output exceeded maxStdoutBytes
      → raise
      text
      maxStdoutBytes
      or reduce output size.
    • text
      lobster returned invalid JSON
      → ensure the pipeline runs in tool mode and prints only JSON.
    • text
      lobster failed
      → check gateway logs for the embedded runner error details.

    Learn more

    • Plugins
    • Plugin tool authoring

    Case study: community workflows

    One public example: a “second brain” CLI + Lobster pipelines that manage three Markdown vaults (personal, partner, shared). The CLI emits JSON for stats, inbox listings, and stale scans; Lobster chains those commands into workflows like

    text
    weekly-review
    ,
    text
    inbox-triage
    ,
    text
    memory-consolidation
    , and
    text
    shared-task-sync
    , each with approval gates. AI handles judgment (categorization) when available and falls back to deterministic rules when not.

    • Thread: https://x.com/plattenschieber/status/2014508656335770033
    • Repo: https://github.com/bloomedai/brain-cli

    Related

    • Automation & Tasks — scheduling Lobster workflows
    • Automation Overview — all automation mechanisms
    • Tools Overview — all available agent tools

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine