Installation Guide | OpenMemory

Comprehensive installation guide for OpenMemory. Choose between Standalone Mode (local-first) or Backend Mode (server).

Installation Guide

OpenMemory can be installed in two ways depending on your needs:

  1. Standalone Mode: Run as a library in your app (Recommended).
  2. Backend Mode: Run as a standalone server.

Method 1: Standalone Mode (Recommended)

Best for local agents, CLI tools, and single-user applications.

JavaScript / TypeScript

npm install openmemory-js

Python

pip install openmemory-py

Method 2: Backend Mode (Server)

Best for multi-user apps, teams, and centralized memory.

Using Docker (Easiest)

git clone https://github.com/caviraoss/openmemory.git
cd openmemory
docker-compose up -d

From Source

git clone https://github.com/caviraoss/openmemory.git
cd openmemory/backend
npm install
npm run build
npm start

System Requirements

  • Node.js: 18+
  • Python: 3.10+ (for Python SDK)
  • RAM: 4GB minimum
  • Storage: SQLite (default) or PostgreSQL (production)
© 2025 OpenMemory · MIT License