OpenMemory

环境要求

• Node.js 与 npm（用于安装 longmemory 库或 CLI）
• Docker（可选，用于以服务方式运行 API/MCP）
• Docker Compose（可选，需项目内 docker-compose.yml 与 .env）
• 本地持久化存储（服务方式挂载到 /data）

安装与启动步骤

1. 1安装记忆库依赖

   在项目目录执行 npm 安装，作为库嵌入你的应用使用，无需启动任何服务或外部数据库。

   npm install longmemory

   复制

2. 2在代码中写入与检索

   用 createMemory 创建记忆实例，ingest 写入片段，recall 以 strict 模式检索并打印结果。

   import { createMemory } from 'longmemory';
   
   const memory = await createMemory();
   await memory.ingest({
       user_id: 'alice',
       text: 'I prefer TypeScript for backend services',
   });
   
   const result = await memory.recall({
       text: 'What language does Alice prefer?',
       mode: 'strict',
   });
   
   console.log(result);
   await memory.close();

   复制

3. 3全局安装 CLI

   如果不想写代码，可全局安装命令行工具，随后在终端直接调用 longmemory 命令。

   npm install --global longmemory

   复制

4. 4初始化 CLI

   首次使用先运行 init，完成本地记忆环境的初始化配置。

   longmemory init

   复制

5. 5命令行检索记忆

   用 recall 以 associative 模式查询记忆内容，可按需切换其他检索模式。

   longmemory recall "current project priorities" --mode associative

   复制

6. 6用 Docker 跑服务

   一条命令启动 API 与 Streamable HTTP MCP，映射 7331 端口并挂载数据卷持久化。

   docker run --rm 
     -p 7331:7331 
     -v longmemory-data:/data 
     -e LONGMEMORY_API_KEY=change-me 
     ghcr.io/caviraoss/longmemory:latest

   复制

7. 7Docker Compose 启动

   先复制环境变量模板，再后台启动服务；加 --profile ui 可同时启动仪表盘。

   cp .env.example .env
   docker compose up --build -d longmemory
   docker compose --profile ui up --build -d

   复制

关键配置

如何确认成功

服务方式启动后，访问 http://127.0.0.1:7331/health 返回健康响应即成功；仪表盘见 http://127.0.0.1:3000。

常见问题

注意事项

• README 中项目自述名为 LongMemory，npm 包名与命令均为 longmemory，与仓库名 OpenMemory 不同，请以命令为准。
• 服务方式务必修改默认密钥 change-me，并在平台边缘终止 TLS。
• 容器数据卷挂载到 /data，宿主机请确保持久化存储可用，避免记忆丢失。
• README 另提供 Heroku、Railway、Render、DigitalOcean、Windows 脚本等部署方式，可按需查阅对应配置文件。