@simbimbo/memory-ocmemog 0.1.11 → 0.1.13

package/docs/usage.md

@@ -6,7 +6,7 @@ ocmemog is a repo-local OpenClaw memory sidecar backed by SQLite with llama.cpp-
 
 - search/get over local memory are supported
 - provider-backed local embeddings are the primary path
-- several advanced brAIn memory flows are copied in but still degraded by missing runtime dependencies
+- some advanced memory flows still depend on compatibility-shimmed runtime surfaces and may run in degraded mode depending on the configured provider/runtime
 
 ## Running the sidecar
 
@@ -21,9 +21,15 @@ scripts/ocmemog-sidecar.sh
 Manual watcher:
 
 ```bash
-# defaults to ~/.openclaw/workspace/memory/transcripts if not set
+# if you set OCMEMOG_TRANSCRIPT_DIR, that path is watched; otherwise defaults to
+# ~/.openclaw/workspace/memory/transcripts (or ~/.openclaw/agents/main/sessions when
+# OCMEMOG_SESSION_DIR is set and no transcript path is given)
 export OCMEMOG_TRANSCRIPT_DIR="$HOME/.openclaw/workspace/memory/transcripts"
-export OCMEMOG_INGEST_ENDPOINT="http://127.0.0.1:17891/memory/ingest"
+export OCMEMOG_SESSION_DIR="$HOME/.openclaw/agents/main/sessions"
+export OCMEMOG_INGEST_ENDPOINT="http://127.0.0.1:17891/memory/ingest_async"
+export OCMEMOG_TRANSCRIPT_POLL_SECONDS=30
+export OCMEMOG_INGEST_BATCH_SECONDS=30
+export OCMEMOG_INGEST_BATCH_MAX=25
 ./scripts/ocmemog-transcript-watcher.sh
 ```
 
@@ -42,7 +48,7 @@ Useful environment variables:
 export OCMEMOG_HOST=127.0.0.1
 export OCMEMOG_PORT=17891
 export OCMEMOG_STATE_DIR=/path/to/state
-export OCMEMOG_DB_PATH=/path/to/brain_memory.sqlite3
+export OCMEMOG_DB_PATH=/path/to/ocmemog_memory.sqlite3
 export OCMEMOG_MEMORY_MODEL=gpt-4o-mini
 export OCMEMOG_OPENAI_API_KEY=sk-...
 export OCMEMOG_OPENAI_API_BASE=https://api.openai.com/v1
@@ -51,18 +57,30 @@ export OCMEMOG_LOCAL_LLM_BASE_URL=http://127.0.0.1:18080/v1
 export OCMEMOG_LOCAL_LLM_MODEL=qwen2.5-7b-instruct
 export OCMEMOG_LOCAL_EMBED_BASE_URL=http://127.0.0.1:18081/v1
 export OCMEMOG_LOCAL_EMBED_MODEL=nomic-embed-text-v1.5
-export BRAIN_EMBED_MODEL_LOCAL=simple
-export BRAIN_EMBED_MODEL_PROVIDER=local-openai
+export OCMEMOG_EMBED_MODEL_LOCAL=simple
+export OCMEMOG_EMBED_MODEL_PROVIDER=local-openai
+export OCMEMOG_SESSION_DIR=$HOME/.openclaw/agents/main/sessions
 export OCMEMOG_TRANSCRIPT_DIR=$HOME/.openclaw/workspace/memory/transcripts
 export OCMEMOG_TRANSCRIPT_GLOB=*.log
-export OCMEMOG_TRANSCRIPT_POLL_SECONDS=1
+export OCMEMOG_TRANSCRIPT_WATCHER=true
+export OCMEMOG_TRANSCRIPT_POLL_SECONDS=30
 export OCMEMOG_INGEST_KIND=memory
 export OCMEMOG_INGEST_SOURCE=transcript
-export OCMEMOG_TRANSCRIPT_WATCHER=true
+export OCMEMOG_INGEST_ASYNC_WORKER=true
+export OCMEMOG_INGEST_ASYNC_POLL_SECONDS=5
+export OCMEMOG_INGEST_ASYNC_BATCH_MAX=25
+export OCMEMOG_INGEST_BATCH_SECONDS=30
+export OCMEMOG_INGEST_BATCH_MAX=25
+export OCMEMOG_SHUTDOWN_DRAIN_QUEUE=false
+export OCMEMOG_WORKER_SHUTDOWN_TIMEOUT_SECONDS=0.35
+export OCMEMOG_SHUTDOWN_TIMING=true
+export OCMEMOG_SHUTDOWN_DUMP_THREADS=false
 ```
 
 Default state location in this repo is `.ocmemog-state/`.
 
+On shutdown, set `OCMEMOG_SHUTDOWN_DRAIN_QUEUE=true` to synchronously flush queued ingest entries before exit. This is useful for short-running deployments and tests that expect strong delivery guarantees.
+
 ## Plugin API
 
 Health:
@@ -183,15 +201,13 @@ Notes:
 
 ## What is not safe to rely on yet
 
-- `brain/runtime/memory/api.py`
-  - It targets missing/legacy tables and columns.
 - Provider-backed embeddings
-  - Available when `BRAIN_EMBED_MODEL_PROVIDER=local-openai` and the local embedding endpoint is reachable.
-  - Legacy OpenAI-hosted embeddings remain available when `BRAIN_EMBED_MODEL_PROVIDER=openai` and `OCMEMOG_OPENAI_API_KEY` is set.
+  - Available when `OCMEMOG_EMBED_MODEL_PROVIDER=local-openai` and the local embedding endpoint is reachable.
+  - Legacy OpenAI-hosted embeddings remain available when `OCMEMOG_EMBED_MODEL_PROVIDER=openai` and `OCMEMOG_OPENAI_API_KEY` is set.
 - Model-backed distillation
   - Available when `OCMEMOG_OPENAI_API_KEY` is set; otherwise falls back to heuristic distill.
 - Role-prioritized context building
-  - `brain.runtime.roles.role_registry` is not bundled here.
+  - `brain.runtime.roles.role_registry` is now provided by `ocmemog.runtime.roles` and mirrored in compatibility probes.
 - Full brAIn memory parity
   - The repo ships only a subset of the original runtime architecture.
 
@@ -201,7 +217,7 @@ To inspect memory state quickly:
 
 ```bash
 python3 - <<'PY'
-from brain.runtime.memory import store
+from ocmemog.runtime.memory import store
 store.init_db()
 conn = store.connect()
 for table in ("knowledge", "reflections", "directives", "tasks", "candidates", "promotions"):
@@ -215,7 +231,7 @@ To rebuild embeddings for recent knowledge rows:
 
 ```bash
 python3 - <<'PY'
-from brain.runtime.memory import vector_index
+from ocmemog.runtime.memory import vector_index
 print(vector_index.index_memory())
 PY
 ```
@@ -223,7 +239,7 @@ PY
 ## TODO: Missing runtime dependencies
 
 - TODO: wire a real inference backend before enabling distill/promote as an operator-facing workflow
-- TODO: wire real provider execution if `BRAIN_EMBED_MODEL_PROVIDER` is meant to do anything
-- TODO: add or remove role-based context selection; the current import path is absent
+- Provider execution is now native-first through `OCMEMOG_EMBED_MODEL_PROVIDER`; `BRAIN_EMBED_MODEL_PROVIDER` remains as a compatibility alias.
+- Role-based context selection now has native ownership coverage via `ocmemog.runtime.roles` with shim-aware capability reporting.
 - TODO: harden `/memory/get` with a table allow-list before exposing the sidecar outside trusted local use
 - TODO: decide whether to expose `runbooks` and `lessons` in the plugin API

package/index.ts

@@ -6,6 +6,7 @@ const DEFAULT_TIMEOUT_MS = 30_000;
 type PluginConfig = {
   endpoint: string;
   timeoutMs: number;
+  token?: string;
 };
 
 const AUTO_HYDRATION_ENABLED = ["1", "true", "yes"].includes(
@@ -80,6 +81,7 @@ function readConfig(raw: unknown): PluginConfig {
       typeof cfg.timeoutMs === "number" && Number.isFinite(cfg.timeoutMs) && cfg.timeoutMs > 0
         ? cfg.timeoutMs
         : DEFAULT_TIMEOUT_MS,
+    token: typeof cfg.token === "string" && cfg.token.trim() ? cfg.token.trim() : undefined,
   };
 }
 
@@ -88,9 +90,14 @@ async function postJson<T>(config: PluginConfig, path: string, body: Record<stri
   const timeout = setTimeout(() => controller.abort(), config.timeoutMs);
 
   try {
+    const headers: Record<string, string> = { "content-type": "application/json" };
+    if (config.token) {
+      headers["x-ocmemog-token"] = config.token;
+    }
+
     const response = await fetch(new URL(path, config.endpoint).toString(), {
       method: "POST",
-      headers: { "content-type": "application/json" },
+      headers,
       body: JSON.stringify(body),
       signal: controller.signal,
     });

package/ocmemog/__init__.py

@@ -1 +1,12 @@
 """ocmemog sidecar package."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version as _package_version
+
+try:
+    __version__ = _package_version("ocmemog-sidecar")
+except PackageNotFoundError:  # pragma: no cover - package metadata may be unavailable in source layouts.
+    __version__ = "0.1.12"
+
+__all__ = ["__version__"]