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:09

    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.

    Node

    text
    openclaw node

    Run a headless node host that connects to the Gateway WebSocket and exposes

    text
    system.run
    /
    text
    system.which
    on this machine.

    Why use a node host?

    Use a node host when you want agents to run commands on other machines in your network without installing a full macOS companion app there.

    Common use cases:

    • Run commands on remote Linux/Windows boxes (build servers, lab machines, NAS).
    • Keep exec sandboxed on the gateway, but delegate approved runs to other hosts.
    • Provide a lightweight, headless execution target for automation or CI nodes.

    Execution is still guarded by exec approvals and per‑agent allowlists on the node host, so you can keep command access scoped and explicit.

    Browser proxy (zero-config)

    Node hosts automatically advertise a browser proxy if

    text
    browser.enabled
    is not disabled on the node. This lets the agent use browser automation on that node without extra configuration.

    By default, the proxy exposes the node's normal browser profile surface. If you set

    text
    nodeHost.browserProxy.allowProfiles
    , the proxy becomes restrictive: non-allowlisted profile targeting is rejected, and persistent profile create/delete routes are blocked through the proxy.

    Disable it on the node if needed:

    json5
    { nodeHost: { browserProxy: { enabled: false, }, }, }

    Run (foreground)

    bash
    openclaw node run --host <gateway-host> --port 18789

    Options:

    • text
      --host <host>
      : Gateway WebSocket host (default:
      text
      127.0.0.1
      )
    • text
      --port <port>
      : Gateway WebSocket port (default:
      text
      18789
      )
    • text
      --tls
      : Use TLS for the gateway connection
    • text
      --tls-fingerprint <sha256>
      : Expected TLS certificate fingerprint (sha256)
    • text
      --node-id <id>
      : Override node id (clears pairing token)
    • text
      --display-name <name>
      : Override the node display name

    Gateway auth for node host

    text
    openclaw node run
    and
    text
    openclaw node install
    resolve gateway auth from config/env (no
    text
    --token
    /
    text
    --password
    flags on node commands):

    • text
      OPENCLAW_GATEWAY_TOKEN
      /
      text
      OPENCLAW_GATEWAY_PASSWORD
      are checked first.
    • Then local config fallback:
      text
      gateway.auth.token
      /
      text
      gateway.auth.password
      .
    • In local mode, node host intentionally does not inherit
      text
      gateway.remote.token
      /
      text
      gateway.remote.password
      .
    • If
      text
      gateway.auth.token
      /
      text
      gateway.auth.password
      is explicitly configured via SecretRef and unresolved, node auth resolution fails closed (no remote fallback masking).
    • In
      text
      gateway.mode=remote
      , remote client fields (
      text
      gateway.remote.token
      /
      text
      gateway.remote.password
      ) are also eligible per remote precedence rules.
    • Node host auth resolution only honors
      text
      OPENCLAW_GATEWAY_*
      env vars.

    For a node connecting to a non-loopback

    text
    ws://
    Gateway on a trusted private network, set
    text
    OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1
    . Without it, node startup fails closed and asks you to use
    text
    wss://
    , an SSH tunnel, or Tailscale. This is a process-environment opt-in, not an
    text
    openclaw.json
    config key.
    text
    openclaw node install
    persists it into the supervised node service when it is present in the install command environment.

    Service (background)

    Install a headless node host as a user service.

    bash
    openclaw node install --host <gateway-host> --port 18789

    Options:

    • text
      --host <host>
      : Gateway WebSocket host (default:
      text
      127.0.0.1
      )
    • text
      --port <port>
      : Gateway WebSocket port (default:
      text
      18789
      )
    • text
      --tls
      : Use TLS for the gateway connection
    • text
      --tls-fingerprint <sha256>
      : Expected TLS certificate fingerprint (sha256)
    • text
      --node-id <id>
      : Override node id (clears pairing token)
    • text
      --display-name <name>
      : Override the node display name
    • text
      --runtime <runtime>
      : Service runtime (
      text
      node
      or
      text
      bun
      )
    • text
      --force
      : Reinstall/overwrite if already installed

    Manage the service:

    bash
    openclaw node status openclaw node start openclaw node stop openclaw node restart openclaw node uninstall

    Use

    text
    openclaw node run
    for a foreground node host (no service).

    Service commands accept

    text
    --json
    for machine-readable output.

    The node host retries Gateway restart and network closes in-process. If the Gateway reports a terminal token/password/bootstrap auth pause, the node host logs the close detail and exits non-zero so launchd/systemd can restart it with fresh config and credentials. Pairing-required pauses stay in the foreground flow so the pending request can be approved.

    Pairing

    The first connection creates a pending device pairing request (

    text
    role: node
    ) on the Gateway. Approve it via:

    bash
    openclaw devices list openclaw devices approve <requestId>

    On tightly controlled node networks, the Gateway operator can explicitly opt in to auto-approving first-time node pairing from trusted CIDRs:

    json5
    { gateway: { nodes: { pairing: { autoApproveCidrs: ["192.168.1.0/24"], }, }, }, }

    This is disabled by default. It only applies to fresh

    text
    role: node
    pairing with no requested scopes. Operator/browser clients, Control UI, WebChat, and role, scope, metadata, or public-key upgrades still require manual approval.

    If the node retries pairing with changed auth details (role/scopes/public key), the previous pending request is superseded and a new

    text
    requestId
    is created. Run
    text
    openclaw devices list
    again before approval.

    The node host stores its node id, token, display name, and gateway connection info in

    text
    ~/.openclaw/node.json
    .

    Exec approvals

    text
    system.run
    is gated by local exec approvals:

    • text
      ~/.openclaw/exec-approvals.json
    • Exec approvals
    • text
      openclaw approvals --node <id|name|ip>
      (edit from the Gateway)

    For approved async node exec, OpenClaw prepares a canonical

    text
    systemRunPlan
    before prompting. The later approved
    text
    system.run
    forward reuses that stored plan, so edits to command/cwd/session fields after the approval request was created are rejected instead of changing what the node executes.

    Related

    • CLI reference
    • Nodes

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine