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

    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.

    Memory

    text
    openclaw memory

    Manage semantic memory indexing and search. Provided by the active memory plugin (default:

    text
    memory-core
    ; set
    text
    plugins.slots.memory = "none"
    to disable).

    Related:

    • Memory concept: Memory
    • Memory wiki: Memory Wiki
    • Wiki CLI: wiki
    • Plugins: Plugins

    Examples

    bash
    openclaw memory status openclaw memory status --deep openclaw memory status --fix openclaw memory index --force openclaw memory search "meeting notes" openclaw memory search --query "deployment" --max-results 20 openclaw memory promote --limit 10 --min-score 0.75 openclaw memory promote --apply openclaw memory promote --json --min-recall-count 0 --min-unique-queries 0 openclaw memory promote-explain "router vlan" openclaw memory promote-explain "router vlan" --json openclaw memory rem-harness openclaw memory rem-harness --json openclaw memory status --json openclaw memory status --deep --index openclaw memory status --deep --index --verbose openclaw memory status --agent main openclaw memory index --agent main --verbose

    Options

    text
    memory status
    and
    text
    memory index
    :

    • text
      --agent <id>
      : scope to a single agent. Without it, these commands run for each configured agent; if no agent list is configured, they fall back to the default agent.
    • text
      --verbose
      : emit detailed logs during probes and indexing.

    text
    memory status
    :

    • text
      --deep
      : probe vector + embedding availability. Plain
      text
      memory status
      stays fast and does not run a live embedding ping. QMD lexical
      text
      searchMode: "search"
      skips semantic vector probes and embedding maintenance even with
      text
      --deep
      .
    • text
      --index
      : run a reindex if the store is dirty (implies
      text
      --deep
      ).
    • text
      --fix
      : repair stale recall locks and normalize promotion metadata.
    • text
      --json
      : print JSON output.

    If

    text
    memory status
    shows
    text
    Dreaming status: blocked
    , the managed dreaming cron is enabled but the heartbeat that drives it is not firing for the default agent. See Dreaming never runs for the two common causes.

    text
    memory index
    :

    • text
      --force
      : force a full reindex.

    text
    memory search
    :

    • Query input: pass either positional
      text
      [query]
      or
      text
      --query <text>
      .
    • If both are provided,
      text
      --query
      wins.
    • If neither is provided, the command exits with an error.
    • text
      --agent <id>
      : scope to a single agent (default: the default agent).
    • text
      --max-results <n>
      : limit the number of results returned.
    • text
      --min-score <n>
      : filter out low-score matches.
    • text
      --json
      : print JSON results.

    text
    memory promote
    :

    Preview and apply short-term memory promotions.

    bash
    openclaw memory promote [--apply] [--limit <n>] [--include-promoted]
    • text
      --apply
      -- write promotions to
      text
      MEMORY.md
      (default: preview only).
    • text
      --limit <n>
      -- cap the number of candidates shown.
    • text
      --include-promoted
      -- include entries already promoted in previous cycles.

    Full options:

    • Ranks short-term candidates from
      text
      memory/YYYY-MM-DD.md
      using weighted promotion signals (
      text
      frequency
      ,
      text
      relevance
      ,
      text
      query diversity
      ,
      text
      recency
      ,
      text
      consolidation
      ,
      text
      conceptual richness
      ).
    • Uses short-term signals from both memory recalls and daily-ingestion passes, plus light/REM phase reinforcement signals.
    • When dreaming is enabled,
      text
      memory-core
      auto-manages one cron job that runs a full sweep (
      text
      light -> REM -> deep
      ) in the background (no manual
      text
      openclaw cron add
      required).
    • text
      --agent <id>
      : scope to a single agent (default: the default agent).
    • text
      --limit <n>
      : max candidates to return/apply.
    • text
      --min-score <n>
      : minimum weighted promotion score.
    • text
      --min-recall-count <n>
      : minimum recall count required for a candidate.
    • text
      --min-unique-queries <n>
      : minimum distinct query count required for a candidate.
    • text
      --apply
      : append selected candidates into
      text
      MEMORY.md
      and mark them promoted.
    • text
      --include-promoted
      : include already promoted candidates in output.
    • text
      --json
      : print JSON output.

    text
    memory promote-explain
    :

    Explain a specific promotion candidate and its score breakdown.

    bash
    openclaw memory promote-explain <selector> [--agent <id>] [--include-promoted] [--json]
    • text
      <selector>
      : candidate key, path fragment, or snippet fragment to look up.
    • text
      --agent <id>
      : scope to a single agent (default: the default agent).
    • text
      --include-promoted
      : include already promoted candidates.
    • text
      --json
      : print JSON output.

    text
    memory rem-harness
    :

    Preview REM reflections, candidate truths, and deep promotion output without writing anything.

    bash
    openclaw memory rem-harness [--agent <id>] [--include-promoted] [--json]
    • text
      --agent <id>
      : scope to a single agent (default: the default agent).
    • text
      --include-promoted
      : include already promoted deep candidates.
    • text
      --json
      : print JSON output.

    Dreaming

    Dreaming is the background memory consolidation system with three cooperative phases: light (sort/stage short-term material), deep (promote durable facts into

    text
    MEMORY.md
    ), and REM (reflect and surface themes).

    • Enable with
      text
      plugins.entries.memory-core.config.dreaming.enabled: true
      .
    • Toggle from chat with
      text
      /dreaming on|off
      (or inspect with
      text
      /dreaming status
      ).
    • Dreaming runs on one managed sweep schedule (
      text
      dreaming.frequency
      ) and executes phases in order: light, REM, deep.
    • Only the deep phase writes durable memory to
      text
      MEMORY.md
      .
    • Human-readable phase output and diary entries are written to
      text
      DREAMS.md
      (or existing
      text
      dreams.md
      ), with optional per-phase reports in
      text
      memory/dreaming/<phase>/YYYY-MM-DD.md
      .
    • Ranking uses weighted signals: recall frequency, retrieval relevance, query diversity, temporal recency, cross-day consolidation, and derived concept richness.
    • Promotion re-reads the live daily note before writing to
      text
      MEMORY.md
      , so edited or deleted short-term snippets do not get promoted from stale recall-store snapshots.
    • Scheduled and manual
      text
      memory promote
      runs share the same deep phase defaults unless you pass CLI threshold overrides.
    • Automatic runs fan out across configured memory workspaces.

    Default scheduling:

    • Sweep cadence:
      text
      dreaming.frequency = 0 3 * * *
    • Deep thresholds:
      text
      minScore=0.8
      ,
      text
      minRecallCount=3
      ,
      text
      minUniqueQueries=3
      ,
      text
      recencyHalfLifeDays=14
      ,
      text
      maxAgeDays=30

    Example:

    json
    { "plugins": { "entries": { "memory-core": { "config": { "dreaming": { "enabled": true } } } } } }

    Notes:

    • text
      memory index --verbose
      prints per-phase details (provider, model, sources, batch activity).
    • text
      memory status
      includes any extra paths configured via
      text
      memorySearch.extraPaths
      .
    • If effectively active memory remote API key fields are configured as SecretRefs, the command resolves those values from the active gateway snapshot. If gateway is unavailable, the command fails fast.
    • Gateway version skew note: this command path requires a gateway that supports
      text
      secrets.resolve
      ; older gateways return an unknown-method error.
    • Tune scheduled sweep cadence with
      text
      dreaming.frequency
      . Deep promotion policy is otherwise internal; use CLI flags on
      text
      memory promote
      when you need one-off manual overrides.
    • text
      memory rem-harness --path <file-or-dir> --grounded
      previews grounded
      text
      What Happened
      ,
      text
      Reflections
      , and
      text
      Possible Lasting Updates
      from historical daily notes without writing anything.
    • text
      memory rem-backfill --path <file-or-dir>
      writes reversible grounded diary entries into
      text
      DREAMS.md
      for UI review.
    • text
      memory rem-backfill --path <file-or-dir> --stage-short-term
      also seeds grounded durable candidates into the live short-term promotion store so the normal deep phase can rank them.
    • text
      memory rem-backfill --rollback
      removes previously written grounded diary entries, and
      text
      memory rem-backfill --rollback-short-term
      removes previously staged grounded short-term candidates.
    • See Dreaming for full phase descriptions and configuration reference.

    Related

    • CLI reference
    • Memory overview

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine