SuperLocalMemory Logo
SuperLocalMemory

Installation Guide

Everything you need to get SuperLocalMemory running on your machine

CLI Installation

Install with a single command. Works on all three platforms.

macOS

Apple Silicon and Intel

Prerequisites

Node.js 18+
npm or pnpm
1

Install globally via npm

npm install -g superlocalmemory
2

Start the server

slm start
3

Verify it is running

slm status

Auto-Configuration

Running slm start automatically detects and configures Claude Desktop, Cursor, and Windsurf. No manual setup required for supported tools.

Troubleshooting

Permission denied during install

If you see EACCES errors, prefix the install command with sudo:

sudo npm install -g superlocalmemory

Port already in use

SuperLocalMemory uses port 27427 by default. If another process is using that port, stop the conflicting process or set a custom port with slm start --port 27428.

Windows

Windows 10 build 1803 or later

Prerequisites

Node.js 18+
Windows 10 build 1803+
1

Install globally via npm

npm install -g superlocalmemory
2

Verify the global bin is in your PATH

If slm is not recognized after install, add the npm global bin directory to your system PATH. Run this in PowerShell to find the directory:

npm config get prefix
3

Start the server

slm start
4

Verify it is running

slm status

Auto-Configuration

Running slm start automatically detects and configures Claude Desktop, Cursor, and Windsurf. No manual setup required for supported tools.

Troubleshooting

PowerShell execution policy error

If scripts are blocked, open PowerShell as Administrator and run:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Antivirus blocking the process

Some antivirus software may flag the Node.js server process. Add an exception for slm in your antivirus settings, or whitelist the npm global bin directory.

Port already in use

SuperLocalMemory uses port 27427 by default. If another process is using that port, stop the conflicting process or set a custom port with slm start --port 27428.

Linux

Ubuntu, Debian, Fedora, Arch, and more

Prerequisites

1

Install globally via npm

npm install -g superlocalmemory
2

Start the server

slm start
3

Verify it is running

slm status

Optional: Run as a Background Service

To keep SuperLocalMemory running in the background and start it on boot, create a systemd user service:

# Create the service file
mkdir -p ~/.config/systemd/user
cat << 'EOF' > ~/.config/systemd/user/slm.service
[Unit]
Description=SuperLocalMemory Server
After=network.target

[Service]
ExecStart=/usr/bin/env slm start
Restart=on-failure

[Install]
WantedBy=default.target
EOF

# Enable and start
systemctl --user enable slm
systemctl --user start slm

Auto-Configuration

Running slm start works with Claude Code and any MCP-compatible tool. Configuration files are detected and updated automatically.

Troubleshooting

Permission denied during install

Avoid using sudo with npm global installs when possible. Instead, configure npm to use a user-level directory:

mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
# Add to your ~/.bashrc or ~/.zshrc:
export PATH=~/.npm-global/bin:$PATH

Firewall or port blocked

SuperLocalMemory binds to 127.0.0.1:27427 (localhost only). If port 27427 is blocked by a firewall or in use, change the port with slm start --port 27428.

MCP Configuration

SuperLocalMemory connects to your AI tools through the Model Context Protocol (MCP) — an open standard that lets AI assistants use external tools and memory.

Automatic Setup

When you run slm start, SuperLocalMemory automatically detects installed AI tools and writes the correct MCP configuration for each one.

Supported tools (auto-detected):

  • Claude Desktop
  • Claude Code (CLI)
  • Cursor
  • Windsurf
  • ChatGPT Desktop
  • And 17+ more MCP-compatible tools

Manual Setup

If you use an unsupported tool, or prefer to configure MCP manually, follow the step-by-step instructions in the documentation.

Manual configuration involves adding a JSON block to your AI tool's MCP config file. The guide covers every supported tool with exact file paths and JSON snippets.

View Manual Setup Guide

Prefer a One-Click Install?

The desktop app bundles everything — no Node.js, no npm, no terminal. Download, install, done.