Documentation
Complete guides and reference documentation for SuperLocalMemory.
Getting Started
Installation
5-minute setup for Mac, Linux, and Windows. Automatic IDE configuration.
Quick Start
Your first memory in 2 minutes. Learn the basics with hands-on examples.
CLI Cheatsheet
Copy-paste command reference for all operations.
Dashboard
Interactive web UI for exploring memories visually.
Interactive Architecture Diagram
Explore the full 10-layer stack, MCP protocol, and v2.5 components — all in one interactive visualization.
View Architecture Diagram →Interactive Learning Diagram
See how the adaptive learning pipeline works — three learning layers, re-ranking, and the feedback loop that personalizes your results over time.
View Learning Diagram →Core Concepts
Universal Architecture
10-layer system design with MCP protocol and hybrid search.
MCP Integration
Model Context Protocol support for 17+ IDEs including ChatGPT.
Universal Skills
6 slash-commands that work across multiple AI tools.
Knowledge Graph
Auto-discovery of relationships with intelligent clustering.
Pattern Learning
How SuperLocalMemory learns your coding style.
Multi-Profile
Separate contexts for work, personal, and client projects.
Learning System
How adaptive learning works, three phases, privacy architecture.
Upgrading to v2.7
Migration guide, new dependencies, and what changes for existing users.
Framework Integrations
LangChain
Use SLM as a persistent chat history backend. Works with RunnableWithMessageHistory and LCEL chains.
pip install langchain-superlocalmemory LlamaIndex
Local-first chat store for ChatMemoryBuffer and SimpleChatEngine. All 7 BaseChatStore methods.
pip install llama-index-storage-chat-store-superlocalmemory Reference
CLI Reference
Complete command-line interface documentation.
Python API
Programmatic access for scripts and automation.
Configuration
Customization options and advanced settings.
Changelog
Version history and release notes.
Visual Documentation
v3.4.5 "Neural Glass" — 21-tab dashboard with light + dark theme.
Knowledge Graph
Sigma.js WebGL with community detection, search, node detail panel, and Ask My Memory chat.
Health Monitor
Real-time process health, RSS budget, worker heartbeat, consolidation status.
Entity Explorer
Browse 1,300+ entities with search, detail panel, recompilation, and PageRank scoring.
Mesh Peers
P2P agent communication network. See connected sessions, shared state, and file locks.
Ingestion Status
Manage Gmail, Calendar, and Transcript adapters. Enable, configure, and monitor from the UI.
+ 16 More Tabs
Dashboard, Memories, Recall Lab, Timeline, Clusters, Patterns, Learning, Behavioral, Events, Agents, Trust, Lifecycle, Compliance, Math Health, IDEs, Settings.
Community & Support
Installation
Install SuperLocalMemory via package manager or desktop application.
Or install via npm (for developers):
npm install -g superlocalmemory