Getting Started

Getting Started

Get SuperLocalMemory running in under 5 minutes.

Prerequisites

• Python 3.11+ (python3 --version)
• Node.js 18+ (only if installing via npm)
• Any supported IDE (Claude Code, Cursor, VS Code, Windsurf, etc.)

Install

npm (recommended):

npm install -g superlocalmemory

Python CLI + SDK (primary activated-venv path):

python3 -m venv .venv
source .venv/bin/activate  # Windows PowerShell: .venv\Scripts\Activate.ps1
python -m pip install superlocalmemory

See Installation for git clone, platform-specific notes, and troubleshooting.

Setup

slm setup     # Choose mode A/B/C, configure provider
slm warmup    # Pre-download embedding model (~500MB, optional)

Modes:

• A — Core memory operations use the local data root without a cloud model provider. Optional integrations have separate network behavior. (default)
• B — Local LLM via Ollama. Still fully private.
• C — Cloud LLM for provider-assisted enrichment; configured content is sent to that provider.

Switch anytime: slm mode a, slm mode b, slm mode c.

Your First Memory

Store something:

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

The default receipt reports an opaque operation_id, fact IDs, and materialization_state: queryable. Enrichment continues durably in the background. Add --sync when the next step requires complete.

Recall it later:

slm recall "JWT token expiry"

You should see the stored memory returned with a relevance score.

Verify Installation

slm status    # System info — mode, DB path, size
slm health    # Math layer health — Fisher-Rao, Sheaf, Langevin stats

Connect Your IDE

Auto-configure all detected IDEs:

slm connect        # Configure all detected IDEs
slm connect --list # See which IDEs are configured

Or add manually to your IDE's MCP config:

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

See IDE Setup for per-IDE instructions.

Web Dashboard

slm dashboard    # Opens at http://localhost:8765

Dashboard workspaces include Dashboard, Brain, Knowledge Graph, Memories, Health, Operations, Entity Explorer, Skill Evolution, Mesh Peers, Settings, and Optimize (workspace/tab counts are illustrative — verify the installed build; do not treat a count as a contract). Runs locally — no data leaves your machine.

Next Steps

• Quick Start Tutorial — Step-by-step for new users and V2 upgraders
• Installation — Full guide with platform notes and troubleshooting
• Modes Explained — Understand the three operating modes
• CLI Reference — Full command reference
• IDE Setup — Configure additional IDEs
• Auto-Memory — How auto-capture works
• Migration from V2 — Upgrade guide for existing V2 users

---

Part of Qualixar | Created by Varun Pratap Bhardwaj