Install the package.
Approve setup explicitly.

The npm package owns its Python environment. The Python package is best installed with pipx or uv. Setup can update documented client configuration only after consent.

18+

Node.js requirement for npm

3.12–3.14

Supported Python range

Install

Use the npm package or an isolated Python application environment.

terminal — install

# Recommended interactive installer (Node.js 18+, npm 9+) $ npm install -g superlocalmemory
# Or install the Python CLI in an isolated environment $ pipx install superlocalmemory $ uv tool install superlocalmemory

The npm route requires Node.js 18+ and npm 9+. Python routes require Python 3.12–3.14. Model downloads and optional backends are separate from the core package install.

Setup

Choose your operating mode in one interactive prompt.

terminal — setup

$ slm setup # Choose your mode: # A) Local core path — no LLM provider required # B) Local Ollama — local LLM inference # C) Cloud LLM — OpenAI / Anthropic > Mode A selected. Initializing local database... ✓ Setup complete. Check slm --version for your installed package version.

Mode A does not require a model-provider API key for the core path after required dependencies and models are present. On Apple Silicon, setup also installs the on-device answer check by default — opt out with slm setup --no-laya. See the Modes page for the complete network boundary.

Your first memory

Store, recall, and check status — that's the full loop.

terminal — first memory

# Store your first memory $ slm remember "Alice works at Google as Staff Engineer" ✓ Stored → fact #1 · memory_confidence 0.97 · Mode A
# Recall it later $ slm recall "What does Alice do?" ↳ Staff Engineer at Google · relevance_score: 0.82 · memory_confidence: 0.97 calibration_status: uncalibrated · answer_confidence: null
# Check system status $ slm status ✓ Mode A · 1 fact indexed · cache: opt-in

Run slm --help for the installed command surface. Data-returning commands document --json where supported.

Connect

Connect your agent.

Any harness that speaks MCP (slm mcp, or http://127.0.0.1:8765/mcp/) or can run a command can use SLM. Packaged plugins add skills, agents and hooks.

Host	Connect
Claude Code	`claude plugin marketplace add qualixar/superlocalmemory` then `claude plugin install superlocalmemory@qualixar`
Codex	`slm connect codex`, then `slm codex install`
GitHub Copilot (VS Code)	`slm connect vscode-copilot --here`
Cursor, Windsurf, Zed, JetBrains, Gemini CLI, Claude Desktop, OpenCode, Continue	`slm connect <name>`
Hermes	`hermes plugins install 'https://github.com/qualixar/superlocalmemory.git#hermes-plugin'`
Antigravity	`agy plugin install "$(npm root -g)/superlocalmemory/antigravity-plugin"`
Grok Bot	Add the `qualixar` plugin marketplace in the host’s Plugins screen, then `superlocalmemory`
ChatGPT, Claude on the web, Muse, Composio	Optional Web access from the dashboard: sign in per app, read-only or read-and-save

Installing for a user? Agents can follow SETUP_FOR_AGENTS.md. Every host is covered on Plugins. Supported: Apple Silicon macOS, 64-bit Windows and 64-bit Linux; Intel Macs and 32-bit Windows have no prebuilt install.

Modes

Pick your mode.

Choose a mode during slm setup. Later, switch with slm mode a, slm mode b, or slm mode c.

Local Core MODE A

No LLM needed.

No language model at all: a small embedding model on your computer, nomic-embed-text, finds your memories. Initial model acquisition and optional integrations may use the network.

Best for: privacy-first teams, CI/CD pipelines,
any setup without GPU or API access.

$ slm mode a

→ See Mode A docs

Local Ollama MODE B

Local LLM inference.

Ollama-powered local-model path. Network and privacy behavior depend on where the Ollama endpoint runs and how models are acquired.

Use when: the configured Ollama endpoint and model meet your locality, quality, and resource requirements.
Measure RAM and latency on the selected model.

$ slm mode b

→ See Mode B docs

Cloud LLM MODE C

Provider-assisted path.

Configured provider-assisted processing. Content can transit to the provider; review its logging, retention, and transfer terms.

Use when: you accept the configured provider's data path and have measured the benefit on your workload.
Requires supported provider credentials.

$ slm mode c

→ See Mode C docs

Verification

Confirm everything is running.

Three commands to verify your install is healthy.

terminal — verification

$ slm health ✓ daemon: running · db: healthy · cache: on
$ slm status --json {"success": true, "mode": "A", "facts": 1, "cache_hits": 0}
$ slm --version superlocalmemory <installed-version>

Troubleshooting