open-mem 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.0] - 2026-02-08
+
+### Added
+- **Pluggable workflow modes** — JSON-based mode definitions that customize observation types, concept vocabulary, entity types, and AI prompt templates. Ships with `code` (default) and `research` modes. Configure via `OPEN_MEM_MODE` env var. New `/v1/workflow-modes` API endpoint.
+- **Enhanced session compaction** — compaction hook now injects compressed recent observation narratives, facts, and key decisions with smart budget allocation (40% summaries/index, 40% observation details, 20% decisions). Graceful degradation when full observations unavailable.
+- **VitePress documentation website** — 11-page docs site covering getting started, architecture, tools reference, search guide, configuration, platforms, privacy, API, troubleshooting, and changelog. Build with `bun run docs:build`.
+- **Dashboard documentation** in README — "Web Dashboard" section describing all 6 pages (Timeline, Sessions, Search, Stats, Operations, Settings) with enable/access instructions.
+- **"Why open-mem?" section** in README — competitive positioning highlighting native vector search, knowledge graph, 5 AI providers, revision lineage, and MIT license.
+- **Feature highlights comparison table** in README — side-by-side comparison vs typical alternatives.
+
+### Fixed
+- CI platform worker tests now use portable bun path and project root.
+
 ## [0.10.0] - 2026-02-08
 
 ### Added

package/README.md

@@ -75,6 +75,19 @@ export OPEN_MEM_MODEL=google/gemini-2.5-flash-lite
 
 Without any provider configured, open-mem still works — it falls back to a basic metadata extractor that captures tool names, file paths, and output snippets.
 
+## Why open-mem?
+
+- **Native vector search** — sqlite-vec embedded directly in SQLite, no external vector database required
+- **Knowledge graph** — automatic entity extraction with relationships, graph-augmented search via traversal
+- **5 AI providers + fallback chain** — Google, Anthropic, AWS Bedrock, OpenAI, OpenRouter with automatic failover
+- **Advanced search** — FTS5 full-text + vector similarity + Reciprocal Rank Fusion + graph traversal + reranking
+- **Revision lineage** — immutable history with audit trail; revisions never overwrite, they supersede
+- **User-level memory** — cross-project memories stored in a separate user-scoped database
+- **Web dashboard** — 6-page management UI with real-time SSE streaming and config control plane
+- **Multi-platform** — native adapters for OpenCode, Claude Code, and Cursor
+- **MIT license** — enterprise-friendly, no AGPL restrictions
+- **Well-tested** — 71 test files covering core logic, adapters, and integration scenarios
+
 ## Key Features
 
 - 🧠 **Automatic observation capture** from tool executions and user prompts
@@ -84,8 +97,11 @@ Without any provider configured, open-mem still works — it falls back to a bas
 - 🔒 **Privacy controls** with `<private>` tag support
 - 🛠️ **Nine custom tools**: memory.find, memory.create, memory.history, memory.get, memory.transfer.export, memory.transfer.import, memory.revise, memory.remove, memory.help
 - 🌐 **MCP server mode** — expose memory tools to any MCP-compatible AI client
+- 🔗 **Knowledge graph** — entity extraction with relationships, graph-augmented search
+- 🔄 **Multi-platform** — native adapters for OpenCode, Claude Code, and Cursor
 - 🌳 **Git worktree support** — shared memory across all worktrees
 - 📂 **AGENTS.md generation** — auto-generated folder-level context on session end
+- 📊 **Web dashboard** — 6-page management UI with real-time streaming
 - 📦 **Import/export** — portable JSON for backup and transfer between machines
 - ⚡ **Zero-config setup** — works out of the box
 - 📁 **All data stored locally** in your project directory
@@ -197,6 +213,29 @@ Configure via `OPEN_MEM_FOLDER_CONTEXT_MODE=single` or `OPEN_MEM_FOLDER_CONTEXT_
 
 The context injector includes a "Memory Economics" footer showing how much context compression saves: read cost vs. original discovery cost, with a savings percentage. This helps you understand the value of AI compression at a glance.
 
+## Web Dashboard
+
+open-mem includes a built-in web dashboard for memory management and observability. It provides six pages:
+
+| Page | Description |
+|------|-------------|
+| **Timeline** | Chronological view of all observations with type filtering |
+| **Sessions** | Browse past coding sessions and their observations |
+| **Search** | Full-text and semantic search across all memories |
+| **Stats** | Database statistics, observation counts, and memory economics |
+| **Operations** | Queue status, maintenance actions, folder context management |
+| **Settings** | Config control plane with live preview, mode presets, and audit log |
+
+### Enable the Dashboard
+
+```bash
+export OPEN_MEM_DASHBOARD=true
+```
+
+Access at `http://localhost:3737` (configurable via `OPEN_MEM_DASHBOARD_PORT`). The dashboard streams real-time updates via Server-Sent Events — new observations appear as they are captured.
+
+The [Config Control Plane](#config-control-plane) is accessible through the Settings page, allowing you to preview, apply, and roll back configuration changes without restarting.
+
 ## Custom Tools
 
 ### memory.find
@@ -320,9 +359,9 @@ Lifecycle behavior:
 - `notifications/initialized` is supported
 - strict mode requires initialize before `tools/list`/`tools/call`
 
-## Platform Adapter Workers (Claude Code / Cursor)
+## Platform Adapters (Claude Code / Cursor)
 
-open-mem now includes dedicated adapter workers that ingest JSON events over stdin:
+open-mem works beyond OpenCode. Dedicated adapter workers bring the same memory capabilities to Claude Code and Cursor, ingesting JSON events over stdin:
 
 ```bash
 # Claude Code adapter worker
@@ -423,6 +462,8 @@ open-mem works out of the box with zero configuration. All settings can be custo
 | `OPEN_MEM_MCP_COMPAT_MODE` | `strict` | MCP mode: `strict` or `legacy` |
 | `OPEN_MEM_MCP_PROTOCOL_VERSION` | `2024-11-05` | Preferred MCP protocol version |
 | `OPEN_MEM_MCP_SUPPORTED_PROTOCOLS` | `2024-11-05` | Comma-separated supported protocol versions |
+| `OPEN_MEM_DASHBOARD` | `false` | Set to `true` to enable the web dashboard |
+| `OPEN_MEM_DASHBOARD_PORT` | `3737` | Dashboard HTTP port |
 
 <details>
 <summary><strong>Programmatic Configuration Reference</strong></summary>
@@ -556,6 +597,19 @@ export OPEN_MEM_MAX_CONTEXT_TOKENS=2000
 - [Getting Started](docs/getting-started.md) — installation, configuration, and first steps
 - [Architecture](docs/architecture.md) — internal design, data flow, and source layout
 
+## Feature Highlights
+
+| Feature | open-mem | Typical alternatives |
+|---------|----------|---------------------|
+| Vector search | Native (sqlite-vec) | External service (Chroma) |
+| AI providers | 5 with fallback chain | 1–3 |
+| Search | FTS5 + Vector + RRF + Graph | FTS5 only |
+| Knowledge graph | Entities + relationships | No |
+| Revision history | Immutable lineage | No |
+| Dashboard | 6-page web UI with SSE | No |
+| License | MIT | AGPL / proprietary |
+| Data locality | Project-local `.open-mem/` | Global |
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, code style, and submission guidelines.

package/dist/adapters/http/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/adapters/http/server.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,IAAI,CAAC;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAS5B,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,KAAK,EAAmB,aAAa,EAAE,MAAM,aAAa,CAAC;AAElE,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IACtC,YAAY,EAAE,YAAY,CAAC;IAC3B,qBAAqB,CAAC,EAAE,MAAM,qBAAqB,CAAC;IACpD,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAoCD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CA0e5D"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/adapters/http/server.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,IAAI,CAAC;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAS5B,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAEhF,OAAO,KAAK,EAAmB,aAAa,EAAE,MAAM,aAAa,CAAC;AAElE,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IACtC,YAAY,EAAE,YAAY,CAAC;IAC3B,qBAAqB,CAAC,EAAE,MAAM,qBAAqB,CAAC;IACpD,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAoCD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAkf5D"}

package/dist/ai/prompts.d.ts

@@ -1,8 +1,9 @@
+import type { ModeConfig } from "../types";
 /**
  * Build a prompt that instructs the AI to compress raw tool output into a
  * structured observation (type, title, facts, narrative, concepts, files).
  */
-export declare function buildCompressionPrompt(toolName: string, toolOutput: string, sessionContext?: string): string;
+export declare function buildCompressionPrompt(toolName: string, toolOutput: string, sessionContext?: string, modeConfig?: ModeConfig): string;
 /**
  * Build a prompt that instructs the AI to produce a session summary from
  * a list of observations.
@@ -46,7 +47,7 @@ export interface EntityExtractionObservation {
  * Build a prompt that instructs the AI to extract entities and relationships
  * from an observation.
  */
-export declare function buildEntityExtractionPrompt(obs: EntityExtractionObservation): string;
+export declare function buildEntityExtractionPrompt(obs: EntityExtractionObservation, modeConfig?: ModeConfig): string;
 /**
  * Build a prompt that instructs the AI to reorder search result candidates
  * by relevance to the query.

package/dist/ai/prompts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../../src/ai/prompts.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,wBAAgB,sBAAsB,CACrC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,cAAc,CAAC,EAAE,MAAM,GACrB,MAAM,CAmDR;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACvC,YAAY,EAAE,aAAa,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB,CAAC,EACF,SAAS,EAAE,MAAM,GACf,MAAM,CAwCR;AAMD,gEAAgE;AAChE,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,yDAAyD;AACzD,MAAM,WAAW,sBAAsB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC5C,MAAM,EAAE,sBAAsB,EAC9B,UAAU,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAC1C,MAAM,CAqCR;AAUD,4DAA4D;AAC5D,MAAM,WAAW,2BAA2B;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,aAAa,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,2BAA2B,GAAG,MAAM,CA+BpF;AAMD;;;GAGG;AACH,wBAAgB,oBAAoB,CACnC,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,aAAa,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,GAC7D,MAAM,CAuBR"}
+{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../../src/ai/prompts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAM3C;;;GAGG;AACH,wBAAgB,sBAAsB,CACrC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,cAAc,CAAC,EAAE,MAAM,EACvB,UAAU,CAAC,EAAE,UAAU,GACrB,MAAM,CAoFR;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACvC,YAAY,EAAE,aAAa,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB,CAAC,EACF,SAAS,EAAE,MAAM,GACf,MAAM,CAwCR;AAMD,gEAAgE;AAChE,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,yDAAyD;AACzD,MAAM,WAAW,sBAAsB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC5C,MAAM,EAAE,sBAAsB,EAC9B,UAAU,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAC1C,MAAM,CAqCR;AAUD,4DAA4D;AAC5D,MAAM,WAAW,2BAA2B;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,aAAa,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAC1C,GAAG,EAAE,2BAA2B,EAChC,UAAU,CAAC,EAAE,UAAU,GACrB,MAAM,CAuCR;AAMD;;;GAGG;AACH,wBAAgB,oBAAoB,CACnC,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,aAAa,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,GAC7D,MAAM,CAuBR"}