Docs/Getting Started

Installation

Prerequisites

  • Node.js 18.0.0 or higher
  • That's it! No Redis or API keys required

Quick Start (Zero Configuration)

Bash
1# Run immediately with npx
2npx r3
3
4# Or install globally
5npm install -g r3
6r3

r3 automatically starts an embedded Redis server - no setup needed!

Package Installation

npm

Bash
1npm install r3

Yarn

Bash
1yarn add r3

pnpm

Bash
1pnpm add r3

Optional Configuration

Enable Cloud Sync (Optional)

Bash
1# Get a free API key from mem0.ai
2MEM0_API_KEY="your-mem0-api-key"
3
4# Use external Redis (optional - embedded by default)
5REDIS_URL="redis://localhost:6379"

Claude Desktop Integration

Add to ~/.claude/claude_desktop_config.json:

JSON
1{
2 "mcpServers": {
3 "recall": {
4 "command": "npx",
5 "args": ["r3"],
6 "env": {
7 "MEM0_API_KEY": "your-api-key",
8 "REDIS_URL": "redis://localhost:6379"
9 }
10 }
11 }
12}

Running as a Service

macOS (launchd)

Create ~/Library/LaunchAgents/com.recall.plist:

XML
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
3 "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
4<plist version="1.0">
5<dict>
6 <key>Label</key>
7 <string>com.recall</string>
8 <key>ProgramArguments</key>
9 <array>
10 <string>/usr/local/bin/node</string>
11 <string>/usr/local/bin/recall</string>
12 </array>
13 <key>EnvironmentVariables</key>
14 <dict>
15 <key>MEM0_API_KEY</key>
16 <string>your-key</string>
17 <key>REDIS_URL</key>
18 <string>redis://localhost:6379</string>
19 </dict>
20 <key>RunAtLoad</key>
21 <true/>
22 <key>KeepAlive</key>
23 <true/>
24</dict>
25</plist>

Load the service:

Bash
1launchctl load ~/Library/LaunchAgents/com.recall.plist

Linux (systemd)

Create /etc/systemd/system/recall.service:

INI
1[Unit]
2Description=Recall Memory Service
3After=network.target redis.service
4
5[Service]
6Type=simple
7User=youruser
8ExecStart=/usr/bin/node /usr/local/bin/recall
9Restart=always
10Environment="MEM0_API_KEY=your-key"
11Environment="REDIS_URL=redis://localhost:6379"
12
13[Install]
14WantedBy=multi-user.target

Enable and start:

Bash
1sudo systemctl enable recall
2sudo systemctl start recall

Verification

Test your installation:

Bash
1# Using the CLI
2recall-cli
3
4# Or test programmatically
5node -e "
6const { Recall } = require('@n3wth/recall');
7const memory = new Recall();
8memory.health().then(console.log);
9"