Skip to content

xDarkicex/openclaw-memory-libravdb

Repository files navigation

♎ LibraVDB - Memory and Context Management

LibraVDB
Go 1.25+ TypeScript 5.x OpenClaw memory plugin Release

@xdarkicex/openclaw-memory-libravdb is a local-first OpenClaw memory plugin backed by the libravdbd vector service. It replaces the lightweight default memory path with scoped session, user, and global memory; continuity-aware prompt assembly; durable recall; and sidecar-owned compaction.

Install · Full installation reference · Architecture · Security · Performance and tuning · Contributing

New install? Start here: Install guide.

Install

Install libravdbd with your system package manager, then install the OpenClaw plugin.

macOS (Homebrew)

brew tap xDarkicex/homebrew-openclaw-libravdb-memory
brew install libravdbd
brew services start libravdbd

Linux (APT)

sudo apt install libravdbd
systemctl --user enable --now libravdbd

Linux (AUR)

yay -S libravdbd-bin
systemctl --user enable --now libravdbd

Plugin (all platforms)

openclaw plugins install @xdarkicex/openclaw-memory-libravdb

Then activate the plugin in ~/.openclaw/openclaw.json:

{
  "plugins": {
    "slots": {
      "memory": "libravdb-memory"
    },
    "entries": {
      "libravdb-memory": {
        "enabled": true,
        "config": {
          "sidecarPath": "auto"
        }
      }
    }
  }
}

Verify the service and plugin:

openclaw memory status

Healthy output should show Sidecar=running, stored memory counts, the active gate threshold, and the loaded embedding profile.

Quick Start

Runtime requirements:

  • OpenClaw >= 2026.3.22
  • Node.js >= 22
  • a separately installed libravdbd service

Compatibility note:

  • this plugin is currently verified against OpenClaw 2026.4.23

Default endpoints:

  • macOS/Linux user-local service: unix:$HOME/.libravdbd/run/libravdb.sock
  • Homebrew service on Apple Silicon: unix:/opt/homebrew/var/libravdbd/run/libravdb.sock
  • Windows service: tcp:127.0.0.1:37421

If your service runs elsewhere, set sidecarPath:

{
  "plugins": {
    "entries": {
      "libravdb-memory": {
        "enabled": true,
        "config": {
          "sidecarPath": "tcp:127.0.0.1:37421"
        }
      }
    }
  }
}

Highlights

  • Memory capability ownership - owns the OpenClaw memory slot and registers the context engine capability at runtime.
  • Memory runtime bridge - routes built-in memory_search calls to the same libraVDB-backed sidecar on hosts that expose the runtime API.
  • Three memory scopes - keeps active session, durable user, and global memory separate.
  • Hybrid retrieval - blends semantic similarity, scope, recency, and summary quality instead of relying on cosine similarity alone.
  • Continuity-aware assembly - preserves the recent working tail while fitting recalled memory into a bounded prompt budget.
  • Sidecar compaction - summarizes older session turns without flattening the newest working context.
  • Local-first inference - uses local embedding and compaction paths by default, with optional external summarizer configuration.
  • Explicit service lifecycle - the npm/OpenClaw package stays connect-only; libravdbd is installed and supervised separately.

Security Defaults

Stored memory is treated as untrusted historical context. Retrieved memory is framed before it reaches the downstream model, memory collections are scoped by session/user/global namespace, and service installation is outside the npm plugin package.

Before exposing OpenClaw over remote channels, read Security.

Operator Quick Refs

openclaw memory status [--deep] [--json]
openclaw memory index --force
openclaw memory search "prior context"
openclaw memory export --user-id <userId>
openclaw memory flush --user-id <userId>
openclaw memory journal --limit 50
openclaw memory dream-promote --user-id <userId> --dream-file /path/to/DREAMS.md

Use Install for service lifecycle commands and Uninstall for safe shutdown and removal.

Configuration

All keys are optional. For the full reference, see Configuration.

Key Type Default
sidecarPath string auto "auto" probes standard paths; set unix:/path or tcp:host:port to override
embeddingProfile string nomic-embed-text-v1.5 Primary embedding model
fallbackProfile string bge-small-en-v1.5 Fallback profile for dimension mismatches
onnxDevice string auto ONNX execution provider; set cpu to bypass CoreML/MPS on Intel Macs
userId string auto-derived Stable identity for cross-session durable memory
crossSessionRecall boolean true When false, only session-scoped memories are retrieved
compactSessionTokenBudget number 2000 Auto-compaction token threshold; 0 disables

Optional Features

  • Markdown ingestion watches OpenClaw-owned markdown roots or Obsidian vaults and syncs eligible notes into memory. See Features.
  • Dream promotion promotes vetted dream diary bullets into an isolated dream:{userId} collection. See Features.
  • Embedding profiles default to nomic-embed-text-v1.5 with bge-small-en-v1.5 fallback. See Embedding profiles.

Docs By Goal

From Source

pnpm install
pnpm check
bash scripts/build-daemon.sh

scripts/build-daemon.sh prepares .daemon-bin/libravdbd for local plugin testing when you have a published service binary, a Homebrew service, or a local service checkout. For the full source workflow, read Development.

Runtime Facts

  • npm package: @xdarkicex/openclaw-memory-libravdb
  • OpenClaw plugin id: libravdb-memory
  • plugin kind: memory, context-engine
  • minimum OpenClaw host version: >= 2026.3.22
  • default data path: $HOME/.libravdbd/data_nomic-embed-text-v1_5.libravdb
  • default macOS/Linux endpoint: unix:$HOME/.libravdbd/run/libravdb.sock
  • default Windows endpoint: tcp:127.0.0.1:37421

About

Persistent local memory engine for OpenClaw — replaces default memory-system with a full context lifecycle: hybrid vector recall, automatic compaction, and domain-adaptive gating over LibraVDB

Topics

Resources

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors