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:00:06

    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.

    Browser

    text
    openclaw browser

    Manage OpenClaw's browser control surface and run browser actions (lifecycle, profiles, tabs, snapshots, screenshots, navigation, input, state emulation, and debugging).

    Related:

    • Browser tool + API: Browser tool

    Common flags

    • text
      --url <gatewayWsUrl>
      : Gateway WebSocket URL (defaults to config).
    • text
      --token <token>
      : Gateway token (if required).
    • text
      --timeout <ms>
      : request timeout (ms).
    • text
      --expect-final
      : wait for a final Gateway response.
    • text
      --browser-profile <name>
      : choose a browser profile (default from config).
    • text
      --json
      : machine-readable output (where supported).

    Quick start (local)

    bash
    openclaw browser profiles openclaw browser --browser-profile openclaw start openclaw browser --browser-profile openclaw open https://example.com openclaw browser --browser-profile openclaw snapshot

    Agents can run the same readiness check with

    text
    browser({ action: "doctor" })
    .

    Quick troubleshooting

    If

    text
    start
    fails with
    text
    not reachable after start
    , troubleshoot CDP readiness first. If
    text
    start
    and
    text
    tabs
    succeed but
    text
    open
    or
    text
    navigate
    fails, the browser control plane is healthy and the failure is usually navigation SSRF policy.

    Minimal sequence:

    bash
    openclaw browser --browser-profile openclaw doctor openclaw browser --browser-profile openclaw start openclaw browser --browser-profile openclaw tabs openclaw browser --browser-profile openclaw open https://example.com

    Detailed guidance: Browser troubleshooting

    Lifecycle

    bash
    openclaw browser status openclaw browser doctor openclaw browser doctor --deep openclaw browser start openclaw browser start --headless openclaw browser stop openclaw browser --browser-profile openclaw reset-profile

    Notes:

    • text
      doctor --deep
      adds a live snapshot probe. It is useful when basic CDP readiness is green but you want proof that the current tab can be inspected.
    • For
      text
      attachOnly
      and remote CDP profiles,
      text
      openclaw browser stop
      closes the active control session and clears temporary emulation overrides even when OpenClaw did not launch the browser process itself.
    • For local managed profiles,
      text
      openclaw browser stop
      stops the spawned browser process.
    • text
      openclaw browser start --headless
      applies only to that start request and only when OpenClaw launches a local managed browser. It does not rewrite
      text
      browser.headless
      or profile config, and it is a no-op for an already-running browser.
    • On Linux hosts without
      text
      DISPLAY
      or
      text
      WAYLAND_DISPLAY
      , local managed profiles run headless automatically unless
      text
      OPENCLAW_BROWSER_HEADLESS=0
      ,
      text
      browser.headless=false
      , or
      text
      browser.profiles.<name>.headless=false
      explicitly requests a visible browser.

    If the command is missing

    If

    text
    openclaw browser
    is an unknown command, check
    text
    plugins.allow
    in
    text
    ~/.openclaw/openclaw.json
    .

    When

    text
    plugins.allow
    is present, list the bundled browser plugin explicitly unless the config already has a root
    text
    browser
    block:

    json5
    { plugins: { allow: ["telegram", "browser"], }, }

    An explicit root

    text
    browser
    block, for example
    text
    browser.enabled=true
    or
    text
    browser.profiles.<name>
    , also activates the bundled browser plugin under a restrictive plugin allowlist.

    Related: Browser tool

    Profiles

    Profiles are named browser routing configs. In practice:

    • text
      openclaw
      : launches or attaches to a dedicated OpenClaw-managed Chrome instance (isolated user data dir).
    • text
      user
      : controls your existing signed-in Chrome session via Chrome DevTools MCP.
    • custom CDP profiles: point at a local or remote CDP endpoint.
    bash
    openclaw browser profiles openclaw browser create-profile --name work --color "#FF5A36" openclaw browser create-profile --name chrome-live --driver existing-session openclaw browser create-profile --name remote --cdp-url https://browser-host.example.com openclaw browser delete-profile --name work

    Use a specific profile:

    bash
    openclaw browser --browser-profile work tabs

    Tabs

    bash
    openclaw browser tabs openclaw browser tab new --label docs openclaw browser tab label t1 docs openclaw browser tab select 2 openclaw browser tab close 2 openclaw browser open https://docs.openclaw.ai --label docs openclaw browser focus docs openclaw browser close t1

    text
    tabs
    returns
    text
    suggestedTargetId
    first, then the stable
    text
    tabId
    such as
    text
    t1
    , the optional label, and the raw
    text
    targetId
    . Agents should pass
    text
    suggestedTargetId
    back into
    text
    focus
    ,
    text
    close
    , snapshots, and actions. You can assign a label with
    text
    open --label
    ,
    text
    tab new --label
    , or
    text
    tab label
    ; labels, tab ids, raw target ids, and unique target-id prefixes are all accepted. When Chromium replaces the underlying raw target during a navigation or form submit, OpenClaw keeps the stable
    text
    tabId
    /label attached to the replacement tab when it can prove the match. Raw target ids remain volatile; prefer
    text
    suggestedTargetId
    .

    Snapshot / screenshot / actions

    Snapshot:

    bash
    openclaw browser snapshot openclaw browser snapshot --urls

    Screenshot:

    bash
    openclaw browser screenshot openclaw browser screenshot --full-page openclaw browser screenshot --ref e12 openclaw browser screenshot --labels

    Notes:

    • text
      --full-page
      is for page captures only; it cannot be combined with
      text
      --ref
      or
      text
      --element
      .
    • text
      existing-session
      /
      text
      user
      profiles support page screenshots and
      text
      --ref
      screenshots from snapshot output, but not CSS
      text
      --element
      screenshots.
    • text
      --labels
      overlays current snapshot refs on the screenshot.
    • text
      snapshot --urls
      appends discovered link destinations to AI snapshots so agents can choose direct navigation targets instead of guessing from link text alone.

    Navigate/click/type (ref-based UI automation):

    bash
    openclaw browser navigate https://example.com openclaw browser click <ref> openclaw browser click-coords 120 340 openclaw browser type <ref> "hello" openclaw browser press Enter openclaw browser hover <ref> openclaw browser scrollintoview <ref> openclaw browser drag <startRef> <endRef> openclaw browser select <ref> OptionA OptionB openclaw browser fill --fields '[{"ref":"1","value":"Ada"}]' openclaw browser wait --text "Done" openclaw browser evaluate --fn '(el) => el.textContent' --ref <ref>

    Action responses return the current raw

    text
    targetId
    after action-triggered page replacement when OpenClaw can prove the replacement tab. Scripts should still store and pass
    text
    suggestedTargetId
    /labels for long-lived workflows.

    File + dialog helpers:

    bash
    openclaw browser upload /tmp/openclaw/uploads/file.pdf --ref <ref> openclaw browser waitfordownload openclaw browser download <ref> report.pdf openclaw browser dialog --accept

    Managed Chrome profiles save ordinary click-triggered downloads into the OpenClaw downloads directory (

    text
    /tmp/openclaw/downloads
    by default, or the configured temp root). Use
    text
    waitfordownload
    or
    text
    download
    when the agent needs to wait for a specific file and return its path; those explicit waiters own the next download.

    State and storage

    Viewport + emulation:

    bash
    openclaw browser resize 1280 720 openclaw browser set viewport 1280 720 openclaw browser set offline on openclaw browser set media dark openclaw browser set timezone Europe/London openclaw browser set locale en-GB openclaw browser set geo 51.5074 -0.1278 --accuracy 25 openclaw browser set device "iPhone 14" openclaw browser set headers '{"x-test":"1"}' openclaw browser set credentials myuser mypass

    Cookies + storage:

    bash
    openclaw browser cookies openclaw browser cookies set session abc123 --url https://example.com openclaw browser cookies clear openclaw browser storage local get openclaw browser storage local set token abc123 openclaw browser storage session clear

    Debugging

    bash
    openclaw browser console --level error openclaw browser pdf openclaw browser responsebody "**/api" openclaw browser highlight <ref> openclaw browser errors --clear openclaw browser requests --filter api openclaw browser trace start openclaw browser trace stop --out trace.zip

    Existing Chrome via MCP

    Use the built-in

    text
    user
    profile, or create your own
    text
    existing-session
    profile:

    bash
    openclaw browser --browser-profile user tabs openclaw browser create-profile --name chrome-live --driver existing-session openclaw browser create-profile --name brave-live --driver existing-session --user-data-dir "~/Library/Application Support/BraveSoftware/Brave-Browser" openclaw browser --browser-profile chrome-live tabs

    This path is host-only. For Docker, headless servers, Browserless, or other remote setups, use a CDP profile instead.

    Current existing-session limits:

    • snapshot-driven actions use refs, not CSS selectors
    • text
      browser.actionTimeoutMs
      defaults supported
      text
      act
      requests to 60000 ms when callers omit
      text
      timeoutMs
      ; per-call
      text
      timeoutMs
      still wins.
    • text
      click
      is left-click only
    • text
      type
      does not support
      text
      slowly=true
    • text
      press
      does not support
      text
      delayMs
    • text
      hover
      ,
      text
      scrollintoview
      ,
      text
      drag
      ,
      text
      select
      ,
      text
      fill
      , and
      text
      evaluate
      reject per-call timeout overrides
    • text
      select
      supports one value only
    • text
      wait --load networkidle
      is not supported
    • file uploads require
      text
      --ref
      /
      text
      --input-ref
      , do not support CSS
      text
      --element
      , and currently support one file at a time
    • dialog hooks do not support
      text
      --timeout
    • screenshots support page captures and
      text
      --ref
      , but not CSS
      text
      --element
    • text
      responsebody
      , download interception, PDF export, and batch actions still require a managed browser or raw CDP profile

    Remote browser control (node host proxy)

    If the Gateway runs on a different machine than the browser, run a node host on the machine that has Chrome/Brave/Edge/Chromium. The Gateway will proxy browser actions to that node (no separate browser control server required).

    Use

    text
    gateway.nodes.browser.mode
    to control auto-routing and
    text
    gateway.nodes.browser.node
    to pin a specific node if multiple are connected.

    Security + remote setup: Browser tool, Remote access, Tailscale, Security

    Related

    • CLI reference
    • Browser

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine