Setup Guide

Quick setup for OpenMemory

Step 1: Install and Start

git clone https://github.com/naimkatiman/OpenMemory.git
cd OpenMemory
npm install
cp .env.example .env
npm run dev

Server starts at http://localhost:8787 with Swagger docs at /docs.

For central + project isolation setup, see hybrid-setup.md.

Edit the following files and replace placeholders:

Placeholder	Replace With	Example
`[AI_NAME]`	Your AI assistant name	`Atlas`
`[YOUR_NAME]`	Your name	`Alex`
`[RELATIONSHIP_STYLE]`	How the AI should communicate	`Direct, concise, no fluff`

Files to update:

npm run cli -- save --update preferences:language:TypeScript --summary "first save"
npm run cli -- review --limit 5
npm run cli -- switch assistant

curl http://localhost:8787/health
curl http://localhost:8787/v1/memory
curl http://localhost:8787/v1/diary/recent

Build first: npm run build

Add to your MCP config:

{
  "mcpServers": {
    "memorycore": {
      "command": "node",
      "args": ["dist/src/mcp.js"],
      "cwd": "/path/to/OpenMemory"
    }
  }
}

Hybrid MCP examples (central / project-a / project-b) are documented in hybrid-setup.md.

Ensure these directories exist:

Version: OpenMemory v1.0