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:04:05

    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.

    ACP agents — setup

    For the overview, operator runbook, and concepts, see ACP agents.

    The sections below cover acpx harness config, plugin setup for the MCP bridges, and permission configuration.

    Use this page only when you are setting up the ACP/acpx route. For native Codex app-server runtime config, use Codex harness. For OpenAI API keys or Codex OAuth model-provider config, use OpenAI.

    Codex has two OpenClaw routes:

    RouteConfig/commandSetup page
    Native Codex app-server
    text
    /codex ...
    ,
    text
    agentRuntime.id: "codex"
    Codex harness
    Explicit Codex ACP adapter
    text
    /acp spawn codex
    ,
    text
    runtime: "acp", agentId: "codex"
    This page

    Prefer the native route unless you explicitly need ACP/acpx behavior.

    acpx harness support (current)

    Current acpx built-in harness aliases:

    • text
      claude
    • text
      codex
    • text
      copilot
    • text
      cursor
      (Cursor CLI:
      text
      cursor-agent acp
      )
    • text
      droid
    • text
      gemini
    • text
      iflow
    • text
      kilocode
    • text
      kimi
    • text
      kiro
    • text
      openclaw
    • text
      opencode
    • text
      pi
    • text
      qwen

    When OpenClaw uses the acpx backend, prefer these values for

    text
    agentId
    unless your acpx config defines custom agent aliases. If your local Cursor install still exposes ACP as
    text
    agent acp
    , override the
    text
    cursor
    agent command in your acpx config instead of changing the built-in default.

    Direct acpx CLI usage can also target arbitrary adapters via

    text
    --agent <command>
    , but that raw escape hatch is an acpx CLI feature (not the normal OpenClaw
    text
    agentId
    path).

    Model control is adapter-capability dependent. Codex ACP model refs are normalized by OpenClaw before startup. Other harnesses need ACP

    text
    models
    plus
    text
    session/set_model
    support; if a harness exposes neither that ACP capability nor its own startup model flag, OpenClaw/acpx cannot force a model selection.

    Required config

    Core ACP baseline:

    json5
    { acp: { enabled: true, // Optional. Default is true; set false to pause ACP dispatch while keeping /acp controls. dispatch: { enabled: true }, backend: "acpx", defaultAgent: "codex", allowedAgents: [ "claude", "codex", "copilot", "cursor", "droid", "gemini", "iflow", "kilocode", "kimi", "kiro", "openclaw", "opencode", "pi", "qwen", ], maxConcurrentSessions: 8, stream: { coalesceIdleMs: 300, maxChunkChars: 1200, }, runtime: { ttlMinutes: 120, }, }, }

    Thread binding config is channel-adapter specific. Example for Discord:

    json5
    { session: { threadBindings: { enabled: true, idleHours: 24, maxAgeHours: 0, }, }, channels: { discord: { threadBindings: { enabled: true, spawnAcpSessions: true, }, }, }, }

    If thread-bound ACP spawn does not work, verify the adapter feature flag first:

    • Discord:
      text
      channels.discord.threadBindings.spawnAcpSessions=true

    Current-conversation binds do not require child-thread creation. They require an active conversation context and a channel adapter that exposes ACP conversation bindings.

    See Configuration Reference.

    Plugin setup for acpx backend

    Fresh installs ship the bundled

    text
    acpx
    runtime plugin enabled by default, so ACP usually works without a manual plugin install step.

    Start with:

    text
    /acp doctor

    If you disabled

    text
    acpx
    , denied it via
    text
    plugins.allow
    /
    text
    plugins.deny
    , or want to switch to a local development checkout, use the explicit plugin path:

    bash
    openclaw plugins install acpx openclaw config set plugins.entries.acpx.enabled true

    Local workspace install during development:

    bash
    openclaw plugins install ./path/to/local/acpx-plugin

    Then verify backend health:

    text
    /acp doctor

    acpx command and version configuration

    By default, the bundled

    text
    acpx
    plugin registers the embedded ACP backend without spawning an ACP agent during Gateway startup. Run
    text
    /acp doctor
    for an explicit live probe. Set
    text
    OPENCLAW_ACPX_RUNTIME_STARTUP_PROBE=1
    only when you need the Gateway to probe the configured agent at startup.

    Override the command or version in plugin config:

    json
    { "plugins": { "entries": { "acpx": { "enabled": true, "config": { "command": "../acpx/dist/cli.js", "expectedVersion": "any" } } } } }
    • text
      command
      accepts an absolute path, relative path (resolved from the OpenClaw workspace), or command name.
    • text
      expectedVersion: "any"
      disables strict version matching.
    • Custom
      text
      command
      paths disable plugin-local auto-install.

    See Plugins.

    Automatic dependency install

    When you install OpenClaw globally with

    text
    npm install -g openclaw
    , the acpx runtime dependencies (platform-specific binaries) are installed automatically via a postinstall hook. If the automatic install fails, the gateway still starts normally and reports the missing dependency through
    text
    openclaw acp doctor
    .

    Plugin tools MCP bridge

    By default, ACPX sessions do not expose OpenClaw plugin-registered tools to the ACP harness.

    If you want ACP agents such as Codex or Claude Code to call installed OpenClaw plugin tools such as memory recall/store, enable the dedicated bridge:

    bash
    openclaw config set plugins.entries.acpx.config.pluginToolsMcpBridge true

    What this does:

    • Injects a built-in MCP server named
      text
      openclaw-plugin-tools
      into ACPX session bootstrap.
    • Exposes plugin tools already registered by installed and enabled OpenClaw plugins.
    • Keeps the feature explicit and default-off.

    Security and trust notes:

    • This expands the ACP harness tool surface.
    • ACP agents get access only to plugin tools already active in the gateway.
    • Treat this as the same trust boundary as letting those plugins execute in OpenClaw itself.
    • Review installed plugins before enabling it.

    Custom

    text
    mcpServers
    still work as before. The built-in plugin-tools bridge is an additional opt-in convenience, not a replacement for generic MCP server config.

    OpenClaw tools MCP bridge

    By default, ACPX sessions also do not expose built-in OpenClaw tools through MCP. Enable the separate core-tools bridge when an ACP agent needs selected built-in tools such as

    text
    cron
    :

    bash
    openclaw config set plugins.entries.acpx.config.openClawToolsMcpBridge true

    What this does:

    • Injects a built-in MCP server named
      text
      openclaw-tools
      into ACPX session bootstrap.
    • Exposes selected built-in OpenClaw tools. The initial server exposes
      text
      cron
      .
    • Keeps core-tool exposure explicit and default-off.

    Runtime timeout configuration

    The bundled

    text
    acpx
    plugin defaults embedded runtime turns to a 120-second timeout. This gives slower harnesses such as Gemini CLI enough time to complete ACP startup and initialization. Override it if your host needs a different runtime limit:

    bash
    openclaw config set plugins.entries.acpx.config.timeoutSeconds 180

    Restart the gateway after changing this value.

    Health probe agent configuration

    When

    text
    /acp doctor
    or the opt-in startup probe checks the backend, the bundled
    text
    acpx
    plugin probes one harness agent. If
    text
    acp.allowedAgents
    is set, it defaults to the first allowed agent; otherwise it defaults to
    text
    codex
    . If your deployment needs a different ACP agent for health checks, set the probe agent explicitly:

    bash
    openclaw config set plugins.entries.acpx.config.probeAgent claude

    Restart the gateway after changing this value.

    Permission configuration

    ACP sessions run non-interactively — there is no TTY to approve or deny file-write and shell-exec permission prompts. The acpx plugin provides two config keys that control how permissions are handled:

    These ACPX harness permissions are separate from OpenClaw exec approvals and separate from CLI-backend vendor bypass flags such as Claude CLI

    text
    --permission-mode bypassPermissions
    . ACPX
    text
    approve-all
    is the harness-level break-glass switch for ACP sessions.

    text
    permissionMode

    Controls which operations the harness agent can perform without prompting.

    ValueBehavior
    text
    approve-all
    Auto-approve all file writes and shell commands.
    text
    approve-reads
    Auto-approve reads only; writes and exec require prompts.
    text
    deny-all
    Deny all permission prompts.

    text
    nonInteractivePermissions

    Controls what happens when a permission prompt would be shown but no interactive TTY is available (which is always the case for ACP sessions).

    ValueBehavior
    text
    fail
    Abort the session with
    text
    AcpRuntimeError
    . (default)
    text
    deny
    Silently deny the permission and continue (graceful degradation).

    Configuration

    Set via plugin config:

    bash
    openclaw config set plugins.entries.acpx.config.permissionMode approve-all openclaw config set plugins.entries.acpx.config.nonInteractivePermissions fail

    Restart the gateway after changing these values.

    warning

    OpenClaw defaults to `permissionMode=approve-reads` and `nonInteractivePermissions=fail`. In non-interactive ACP sessions, any write or exec that triggers a permission prompt can fail with `AcpRuntimeError: Permission prompt unavailable in non-interactive mode`.

    If you need to restrict permissions, set

    text
    nonInteractivePermissions
    to
    text
    deny
    so sessions degrade gracefully instead of crashing.

    Related

    • ACP agents — overview, operator runbook, concepts
    • Sub-agents
    • Multi-agent routing

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine