-
-
Notifications
You must be signed in to change notification settings - Fork 34
Getting Started
Get SuperLocalMemory running in under 5 minutes.
-
Python 3.11+ (
python3 --version) - Node.js 18+ (only if installing via npm)
- Any supported IDE (Claude Code, Cursor, VS Code, Windsurf, etc.)
npm (recommended):
npm install -g superlocalmemoryPython CLI + SDK (primary activated-venv path):
python3 -m venv .venv
source .venv/bin/activate # Windows PowerShell: .venv\Scripts\Activate.ps1
python -m pip install superlocalmemorySee Installation for git clone, platform-specific notes, and troubleshooting.
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.
Store something:
slm remember "Our API uses JWT tokens with 24-hour expiry. Refresh tokens last 30 days." --jsonThe 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.
slm status # System info — mode, DB path, size
slm health # Math layer health — Fisher-Rao, Sheaf, Langevin statsAuto-configure all detected IDEs:
slm connect # Configure all detected IDEs
slm connect --list # See which IDEs are configuredOr add manually to your IDE's MCP config:
{
"mcpServers": {
"superlocalmemory": {
"command": "slm",
"args": ["mcp"]
}
}
}See IDE Setup for per-IDE instructions.
slm dashboard # Opens at http://localhost:876517 tabs: memory browser, knowledge graph, recall lab, trust scores, math health, compliance, and more. Runs locally — no data leaves your machine.
- 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
SuperLocalMemory V3 — Local-first memory with explicit data-path controls.
Part of Qualixar | Created by Varun Pratap Bhardwaj | GitHub
SuperLocalMemory V3
Getting Started
Reference
Architecture
Enterprise
V2 Documentation