项目介绍
OpenMemory
OpenMemory 是您的个人记忆层，适用于LLM——私有、便携且开源。您的记忆数据存储在本地，使您能够完全控制自己的数据。使用个性化记忆构建AI应用程序，同时确保数据安全。
快速设置
预备条件
- Docker
- OpenAI API密钥
您可以运行以下命令快速启动OpenMemory：
curl -sL https://raw.githubusercontent.com/mem0ai/mem0/main/openmemory/run.sh | bash
您应该将 OPENAI_API_KEY 设置为全局环境变量：
export OPENAI_API_KEY=your_api_key
您也可以将 OPENAI_API_KEY 作为参数传递给脚本：
curl -sL https://raw.githubusercontent.com/mem0ai/mem0/main/openmemory/run.sh | OPENAI_API_KEY=your_api_key bash
预备条件
- Docker 和 Docker Compose
- Python 3.9+（用于后端开发）
- Node.js（用于前端开发）
- OpenAI API密钥（与LLM交互所需，运行
cp api/.env.example api/.env然后将 OPENAI_API_KEY 更改为您的密钥）
快速开始
1. 设置环境变量
在运行项目之前，您需要为API和UI配置环境变量。
您可以采用以下任一方式来完成此操作：
-
手动：
在以下目录中创建一个.env文件：/api/.env/ui/.env
-
使用
.env.example文件：
复制并重命名示例文件：cp api/.env.example api/.env cp ui/.env.example ui/.env -
使用 Makefile（如果支持）：
运行：make env -
示例
/api/.env
OPENAI_API_KEY=sk-xxx
USER=<user-id> # 您希望关联记忆的用户ID
-
示例
/ui/.env
NEXT_PUBLIC_API_URL=http://localhost:8765
NEXT_PUBLIC_USER_ID=<user-id> # 与api环境变量中的用户ID相同
2. 构建并运行项目
您可以使用以下两个命令运行项目：
make build # 构建mcp服务器和UI
make up # 运行openmemory mcp服务器和UI
运行这些命令后，您将拥有：
- OpenMemory MCP服务器运行在：http://localhost:8765（API文档可在 http://localhost:8765/docs 查看）
- OpenMemory UI运行在：http://localhost:3000
UI无法在 localhost:3000 上运行？
如果UI无法在 http://localhost:3000 正常启动，请尝试手动运行它：
cd ui
pnpm install
pnpm dev
MCP客户端设置
使用以下一步命令配置OpenMemory本地MCP到客户端。通用命令格式如下：
npx @openmemory/install local http://localhost:8765/mcp/<client-name>/sse/<user-id> --client <client-name>
将 <client-name> 替换为您想要的客户端名称，并将 <user-id> 替换为您环境变量中指定的值。
项目结构
api/- 后端API + MCP服务器ui/- 前端React应用程序
贡献
我们是一支对AI未来和开源软件充满热情的开发者团队。凭借在两个领域的多年经验，我们相信社区驱动开发的力量，并期待构建使AI更加普及和个性化的工具。
我们欢迎任何形式的贡献：
- 错误报告和功能请求
- 文档改进
- 代码贡献
- 测试和反馈
- 社区支持
如何贡献：
- 分叉仓库
- 创建您的功能分支 (
git checkout -b openmemory/feature/amazing-feature) - 提交更改 (
git commit -m '添加一些精彩的功能') - 推送到分支 (
git push origin openmemory/feature/amazing-feature) - 打开Pull Request
加入我们，共同建设AI记忆管理的未来！您的贡献有助于让OpenMemory对每个人来说都更好。