Get SuperLocalMemory working in under 5 minutes — whether you're a new user or upgrading from V2.

npm install -g superlocalmemory
# or: pip install superlocalmemory

slm setup

The wizard asks you to pick a mode:

• A (Local Guardian) — Zero cloud. Your data never leaves your machine. Default.
• B (Smart Local) — Local LLM via Ollama for answer synthesis.
• C (Full Power) — Cloud LLM for maximum accuracy. Requires API key.

Most users should start with Mode A — you can switch anytime with slm mode b or slm mode c.

slm warmup

Downloads the nomic-embed-text-v1.5 model (~500MB). If you skip this, it downloads automatically on first use.

slm remember "Our API uses JWT tokens with 24-hour expiry. Refresh tokens last 30 days."

Output: Stored 1 facts.

slm recall "token expiry"

Output shows the stored memory with a relevance score:

 1. [0.82] Our API uses JWT tokens with 24-hour expiry. Refresh tokens last 30 days.

slm status

SuperLocalMemory V3
 Mode: A
 Provider: none
 Base dir: ~/.superlocalmemory
 Database: ~/.superlocalmemory/memory.db
 DB size: 0.12 MB

slm health

Math Layer Health:
 Total facts: 1
 Fisher-Rao indexed: 1/1
 Langevin positioned: 1/1
 Mode: A

slm connect # Auto-configure all detected IDEs
slm connect --list # See what's configured

Or manually add to your IDE's MCP config:

{
 "mcpServers": {
 "superlocalmemory": {
 "command": "slm",
 "args": ["mcp"]
 }
 }
}

Works with: Claude Code, Cursor, VS Code Copilot, Windsurf, Continue, Cody, ChatGPT Desktop, Gemini CLI, JetBrains, Zed, and more.

slm dashboard

Opens at http://localhost:8765. 17 tabs: memory browser, knowledge graph, recall lab, trust scores, math health, compliance, and more.

If you already have SuperLocalMemory V2 (2.8.6 or earlier):

npm install -g superlocalmemory

V3 installs alongside V2. Your V2 data is untouched until you migrate.

slm migrate

This will:

• Show your V2 stats (memory count, DB size)
• Ask for confirmation
• Back up your V2 database automatically
• Copy data to the V3 location (~/.superlocalmemory/)
• Convert V2 memories to V3 atomic facts
• Create a symlink so old tools still find the data

slm setup # Choose mode (A/B/C)
slm warmup # Pre-download embedding model

slm status # Check V3 is running
slm health # Check math layers are active
slm recall "something you stored in V2" # Verify old memories are accessible

slm migrate --rollback

This restores your V2 installation. No data is lost.

Full reference: CLI Reference

• Modes Explained — Understand A vs B vs C
• MCP Tools — All 24 tools available in your IDE
• IDE Setup — Per-IDE configuration guides
• Auto-Memory — How auto-capture and auto-recall work
• Architecture Overview — How the system works under the hood

Part of Qualixar | Created by Varun Pratap Bhardwaj