LongMemory

环境要求

• Node.js 与 npm 环境（安装 longmemory 库和全局 CLI）
• Docker 与 Docker Compose（按容器方式部署 API/MCP 服务时）
• Docker 部署需把持久化存储卷挂载到 /data
• 服务方式运行时需准备 LONGMEMORY_API_KEY

安装与启动步骤

1. 1安装库

   在项目目录安装 longmemory 库，内存模式下不需要任何外部服务或数据库。

   npm install longmemory

   复制

2. 2试跑最小示例

   用 createMemory 写入一条用户偏好，再以 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

   全局安装后执行 init 完成本地初始化，之后可直接用命令行存取记忆。

   npm install --global longmemory
   longmemory init

   复制

4. 4命令行检索

   用 associative 关联模式检索“项目优先级”相关记忆，验证 CLI 可用。

   longmemory recall "current project priorities" --mode associative

   复制

5. 5Docker 启动服务

   映射 7331 端口并挂载 longmemory-data 卷，务必把 change-me 换成自己的密钥。

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

   复制

6. 6Compose 启动

   先复制环境变量样例文件，再后台构建并启动 longmemory 服务，适合长期运行。

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

   复制

7. 7带面板启动

   启用 ui profile 会额外拉起 Dashboard（3000 端口），与 API/MCP 一起运行。

   docker compose --profile ui up --build -d

   复制

关键配置

如何确认成功

访问 http://127.0.0.1:7331/health 返回正常；启用 ui profile 后 http://127.0.0.1:3000 可打开 Dashboard。

常见问题

注意事项

• Docker 部署必须把 LONGMEMORY_API_KEY 从 change-me 换成强密钥，并把存储挂载到 /data。
• 对外提供 API 时应在平台边缘终止 TLS，避免明文暴露密钥与记忆数据。
• Heroku、Railway、Render、DigitalOcean 等平台使用仓库中对应的配置文件部署。
• README 只给出上述命令，其余参数请以仓库实际配置为准，不要自行臆造。