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
    Access groups
    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
    Testing: updates and plugins
    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
    Plugin dependency resolution
    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: 02/05/2026 04:08:02

    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.

    Testing: updates and plugins

    This is the dedicated checklist for update and plugin validation. The goal is simple: prove the installable package can update real user state, repair stale legacy state through

    text
    doctor
    , and still install, load, update, and uninstall plugins from the supported sources.

    For the broader test runner map, see Testing. For live provider keys and network-touching suites, see Testing live.

    What we protect

    Update and plugin tests protect these contracts:

    • A package tarball is complete, has a valid
      text
      dist/postinstall-inventory.json
      , and does not depend on unpacked repo files.
    • A user can move from an older published package to the candidate package without losing config, agents, sessions, workspaces, plugin allowlists, or channel config.
    • text
      openclaw doctor --fix --non-interactive
      owns legacy cleanup and repair paths. Startup should not grow hidden compatibility migrations for stale plugin state.
    • Plugin installs work from local directories, git repos, npm packages, and the ClawHub registry path.
    • Plugin npm dependencies are installed in the managed npm root, scanned before trust, and removed through npm during uninstall so hoisted dependencies do not linger.
    • Plugin update is stable when nothing changed: install records, resolved source, installed dependency layout, and enabled state stay intact.

    Local proof during development

    Start narrow:

    bash
    pnpm changed:lanes --json pnpm check:changed pnpm test:changed

    For plugin install, uninstall, dependency, or package-inventory changes, also run the focused tests that cover the edited seam:

    bash
    pnpm test src/plugins/uninstall.test.ts src/infra/package-dist-inventory.test.ts test/scripts/package-acceptance-workflow.test.ts

    Before any package Docker lane consumes a tarball, prove the package artifact:

    bash
    pnpm release:check

    text
    release:check
    runs config/docs/API drift checks, writes the package dist inventory, runs
    text
    npm pack --dry-run
    , rejects forbidden packed files, installs the tarball into a temp prefix, runs postinstall, and smokes bundled channel entrypoints.

    Docker lanes

    The Docker lanes are the product-level proof. They install or update a real package inside Linux containers and assert behavior through CLI commands, Gateway startup, HTTP probes, RPC status, and filesystem state.

    Use focused lanes while iterating:

    bash
    pnpm test:docker:plugins pnpm test:docker:plugin-update pnpm test:docker:upgrade-survivor pnpm test:docker:published-upgrade-survivor pnpm test:docker:update-migration

    Important lanes:

    • text
      test:docker:plugins
      validates plugin install smoke, local folder installs, local folder update skip behavior, local folders with preinstalled dependencies,
      text
      file:
      package installs, git installs with CLI execution, git moving-ref updates, npm registry installs with hoisted transitive dependencies, npm update no-ops, local ClawHub fixture installs and update no-ops, marketplace update behavior, and Claude-bundle enable/inspect. Set
      text
      OPENCLAW_PLUGINS_E2E_CLAWHUB=0
      to keep the ClawHub block hermetic/offline.
    • text
      test:docker:plugin-update
      validates that an unchanged installed plugin does not reinstall or lose install metadata during
      text
      openclaw plugins update
      .
    • text
      test:docker:upgrade-survivor
      installs the candidate tarball over a dirty old-user fixture, runs package update plus non-interactive doctor, then starts a loopback Gateway and checks state preservation.
    • text
      test:docker:published-upgrade-survivor
      first installs a published baseline, configures it through a baked
      text
      openclaw config set
      recipe, updates it to the candidate tarball, runs doctor, checks legacy cleanup, starts the Gateway, and probes
      text
      /healthz
      ,
      text
      /readyz
      , and RPC status.
    • text
      test:docker:update-migration
      is the cleanup-heavy published-update lane. It starts from a configured Discord/Telegram-style user state, runs baseline doctor so configured plugin dependencies have a chance to materialize, seeds legacy plugin dependency debris for a configured packaged plugin, updates to the candidate tarball, and requires post-update doctor to remove the legacy dependency roots.

    Useful published-upgrade survivor variants:

    bash
    OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC=openclaw@2026.4.23 \ OPENCLAW_UPGRADE_SURVIVOR_SCENARIO=versioned-runtime-deps \ pnpm test:docker:published-upgrade-survivor OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC=openclaw@latest \ OPENCLAW_UPGRADE_SURVIVOR_SCENARIO=bootstrap-persona \ pnpm test:docker:published-upgrade-survivor

    Available scenarios are

    text
    base
    ,
    text
    feishu-channel
    ,
    text
    bootstrap-persona
    ,
    text
    plugin-deps-cleanup
    ,
    text
    tilde-log-path
    , and
    text
    versioned-runtime-deps
    . In aggregate runs,
    text
    OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS=reported-issues
    expands to all reported issue-shaped scenarios.

    Full update migration is intentionally separate from Full Release CI. Use the manual

    text
    Update Migration
    workflow when the release question is "can every published stable release from 2026.4.23 onward update to this candidate and clean up plugin dependency debris?":

    bash
    gh workflow run update-migration.yml \ --ref main \ -f workflow_ref=main \ -f package_ref=main \ -f baselines=all-since-2026.4.23 \ -f scenarios=plugin-deps-cleanup

    Package Acceptance

    Package Acceptance is the GitHub-native package gate. It resolves one candidate package into a

    text
    package-under-test
    tarball, records version and SHA-256, then runs reusable Docker E2E lanes against that exact tarball. The workflow harness ref is separate from the package source ref, so current test logic can validate older trusted releases.

    Candidate sources:

    • text
      source=npm
      : validate
      text
      openclaw@beta
      ,
      text
      openclaw@latest
      , or an exact published version.
    • text
      source=ref
      : pack a trusted branch, tag, or commit with the selected current harness.
    • text
      source=url
      : validate an HTTPS tarball with required
      text
      package_sha256
      .
    • text
      source=artifact
      : reuse a tarball uploaded by another Actions run.

    Release checks call Package Acceptance with the package/update/plugin set:

    text
    doctor-switch update-channel-switch upgrade-survivor published-upgrade-survivor plugins-offline plugin-update

    They also pass:

    text
    published_upgrade_survivor_baselines=release-history published_upgrade_survivor_scenarios=reported-issues telegram_mode=mock-openai

    This keeps package migration, update channel switching, stale plugin dependency cleanup, offline plugin coverage, plugin update behavior, and Telegram package QA on the same resolved artifact.

    text
    release-history
    is a bounded release-check sample: latest six stable releases,
    text
    2026.4.23
    , and one older pre-date anchor. For exhaustive published update migration coverage, use
    text
    all-since-2026.4.23
    in the separate Update Migration workflow instead of Full Release CI.

    Run a package profile manually when validating a candidate before release:

    bash
    gh workflow run package-acceptance.yml \ --ref main \ -f workflow_ref=main \ -f source=npm \ -f package_spec=openclaw@beta \ -f suite_profile=package \ -f published_upgrade_survivor_baselines=release-history \ -f published_upgrade_survivor_scenarios=reported-issues \ -f telegram_mode=mock-openai

    Use

    text
    suite_profile=product
    when the release question includes MCP channels, cron/subagent cleanup, OpenAI web search, or OpenWebUI. Use
    text
    suite_profile=full
    only when you need full Docker release-path coverage.

    Release default

    For release candidates, the default proof stack is:

    1. text
      pnpm check:changed
      and
      text
      pnpm test:changed
      for source-level regressions.
    2. text
      pnpm release:check
      for package artifact integrity.
    3. Package Acceptance
      text
      package
      profile or the release-check custom package lanes for install/update/plugin contracts.
    4. Cross-OS release checks for OS-specific installer, onboarding, and platform behavior.
    5. Live suites only when the changed surface touches provider or hosted-service behavior.

    On maintainer machines, broad gates and Docker/package product proof should run in Testbox unless explicitly doing local proof.

    Legacy compatibility

    Compatibility leniency is narrow and time boxed:

    • Packages through
      text
      2026.4.25
      , including
      text
      2026.4.25-beta.*
      , may tolerate already-shipped package metadata gaps in Package Acceptance.
    • The published
      text
      2026.4.26
      package may warn for local build metadata stamp files already shipped.
    • Later packages must satisfy modern contracts. The same gaps fail instead of warning or skipping.

    Do not add new startup migrations for these old shapes. Add or extend a doctor repair, then prove it with

    text
    upgrade-survivor
    or
    text
    published-upgrade-survivor
    .

    Adding coverage

    When changing update or plugin behavior, add coverage at the lowest layer that can fail for the right reason:

    • Pure path or metadata logic: unit test beside the source.
    • Package inventory or packed-file behavior:
      text
      package-dist-inventory
      or tarball checker test.
    • CLI install/update behavior: Docker lane assertion or fixture.
    • Published-release migration behavior:
      text
      published-upgrade-survivor
      scenario.
    • Registry/package source behavior:
      text
      test:docker:plugins
      fixture or ClawHub fixture server.
    • Dependency layout or cleanup behavior: assert both runtime execution and the filesystem boundary. npm dependencies may be hoisted under the managed npm root, so tests should prove the root is scanned/cleaned instead of assuming a package-local
      text
      node_modules
      tree.

    Keep new Docker fixtures hermetic by default. Use local fixture registries and fake packages unless the point of the test is live registry behavior.

    Failure triage

    Start with the artifact identity:

    • Package Acceptance
      text
      resolve_package
      summary: source, version, SHA-256, and artifact name.
    • Docker artifacts:
      text
      .artifacts/docker-tests/**/summary.json
      ,
      text
      failures.json
      , lane logs, and rerun commands.
    • Upgrade survivor summary:
      text
      .artifacts/upgrade-survivor/summary.json
      , including baseline version, candidate version, scenario, phase timings, and recipe steps.

    Prefer rerunning the failed exact lane with the same package artifact over rerunning the whole release umbrella.

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine