@devflow-tools/memory-engine 0.17.5 → 0.17.6

package/README.md

@@ -1,65 +1,44 @@
 # @devflow-tools/memory-engine
 
-DevFlow 记忆引擎存储 session tool events、结构化 observations 和已审核记忆，并为宿主模型驱动的 MCP 提炼流程提供持久化与搜索能力。
+> 持久化 session events、结构化 observations 和审核记忆，并提供混合搜索与 embedding 实现。（v0.17.6）
 
-## Installation
+[![npm version](https://img.shields.io/npm/v/%40devflow-tools%2Fmemory-engine.svg)](https://www.npmjs.com/package/@devflow-tools/memory-engine)
+
+## 安装
 
 ```bash
 npm install @devflow-tools/memory-engine
 ```
 
-## Usage
+## 快速开始
 
 ```typescript
 import { MemoryGate } from '@devflow-tools/memory-engine';
 
-const memory = new MemoryGate('/path/to/project');
+const memory = new MemoryGate(process.cwd());
 await memory.forceWarmUp();
-
-// Hook producers record events for next-session MCP distillation.
-await memory.recordEvent({
-  id: 'event-1',
-  sessionId: 'session-1',
-  tool: 'Bash',
-  command: 'npm test',
-  exitCode: 1,
-  stderr: 'Tests: 1 failed',
-  durationMs: 3200,
-  createdAt: Date.now(),
-});
-
-// On the next session, the host calls the MCP tool memory_request_distill.
-// The host model summarizes the leased events and saves observations through
-// memory_save_distilled. No local model service is required.
+console.log(await memory.getProjectContext());
 ```
 
-## Features
-
-- **Session event storage** — 持久化 hook tool events，供下一会话按批次租约读取
-- **Host-model distillation** — `memory_request_distill` 返回待处理事件，宿主模型生成 observations
-- **Signal analysis** — 规则评分用于缓冲和分组，不生成 LLM 记忆
-- **候选审核** — 结构化记忆支持 approve/reject 生命周期
-- **分层管理** — 项目层（技术栈、约定）、用户层（偏好）、全局层（最佳实践）
-- **BM25 搜索** — 按内容和类型搜索已审核记忆
-
-## API
-
-- `new MemoryGate(projectRoot)` — 创建项目记忆入口
-- `.forceWarmUp()` — 初始化项目存储
-- `.getAll()` — 获取所有已审核记忆
-- `.getCandidates()` — 获取待审核的候选记忆
-- `.approveCandidate(id)` — 批准候选记忆
-- `.rejectCandidate(id)` — 拒绝候选记忆（标记为 rejected）
-- `.recordEvent(event)` — 将 hook event 写入 `session_events`
-- `.getPendingDistillData()` — 为 MCP `memory_request_distill` 租约并返回待处理事件
-- `.saveDistilledObservationsByBatch(batchId, observations)` — 保存宿主模型提炼结果
-- `.search(query, options?)` — 搜索记忆（支持 category/source 过滤）
-- `.listMemories(filter?)` — 按条件列出记忆
-- `.getUserPreferences()` — 获取用户偏好
-- `.updateUserPreference(key, value)` — 更新用户偏好
-- `.getProjectContext()` — 获取项目上下文（技术栈、约定）
-- `.searchGlobal(query)` — 搜索全局知识库
-- `.upsertGlobal(entries)` — 批量更新全局知识条目
+## 公共 API / 命令
+
+`MemoryEngine`、`MemoryGate`、`MemoryStore`、`HybridSearch`、`EmbeddingProvider`、`runMemoryMaintenance`、`consolidate` 和 memory capsule/semantic helpers。
+
+
+## 配置与运行时
+
+memory-engine 依赖 SDK 的 embedding contract，并提供具体 provider；宿主模型通过 MCP 提炼事件，不要求本地 LLM 服务。
+
+## 版本与兼容性
+
+- 当前包版本：`0.17.6`
+- Node.js：未在 package manifest 声明更高版本时，使用 Node.js 18+；原生 SQLite/Playwright 能力请按对应依赖安装
+- workspace 内部包应使用同一 DevFlow minor/patch 版本，避免类型和数据库 schema 不一致
+
+## 相关链接
+
+- [DevFlow 仓库](https://github.com/shilongfeicool/dev-flow)
+- [问题反馈](https://github.com/shilongfeicool/dev-flow/issues)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devflow-tools/memory-engine",
-  "version": "0.17.5",
+  "version": "0.17.6",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -17,8 +17,8 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@devflow-tools/sdk": "0.17.5",
-    "@devflow-tools/telemetry": "0.17.5",
+    "@devflow-tools/sdk": "0.17.6",
+    "@devflow-tools/telemetry": "0.17.6",
     "@xenova/transformers": "^2.17.0",
     "better-sqlite3": "^12.0.0",
     "sqlite-vec": "^0.1.9",
@@ -31,5 +31,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "817b0286c249eed9c2bd27d3974ee3b3d6ded4bb"
+  "gitHead": "669fea3aa72aa3fde14ed50d24c1fec4dfac088f"
 }