Skip to main content

Install

The installer detects your OS and architecture, downloads the right binary, verifies it, and (when run interactively) prompts you for an LLM API key. Supported platforms: macOS (Apple Silicon & Intel), Linux (x64 & arm64).

Run

First boot sets everything up — the embedded Supermemory graph engine, local embeddings, and your credentials:
Save that API key — it’s your bearer token for every request.
In production, Supermemory runs proprietary models tuned for long-horizon data understanding. Self-hosted, you bring any model: if no provider key is set, first boot launches an interactive setup wizard — pick a provider (OpenAI, Anthropic, Gemini, Groq, or any OpenAI-compatible endpoint like Ollama), paste your key, and it’s saved encrypted for every future launch. After the LLM key, you can optionally pick an embedding model (press Enter to keep local Xenova/bge-base-en-v1.5). See all providers, embeddings, and fully-offline local models.
Docker / non-interactive: set an LLM key via env and, if you don’t want local embeddings, set SUPERMEMORY_EMBEDDING_PROVIDER / MODEL / DIMENSIONS. There is no wizard without a TTY.

Add your first memory

Search it

That’s it. Everything in the Memory API — documents, memories, user profiles, spaces, filtering — works identically against your local server.

Where things live

By default, all state lives in a single directory you can back up or move:
PathContents
./.supermemory/ (or $SUPERMEMORY_DATA_DIR)The Supermemory graph engine’s data, auth secret, embedding model cache
~/.supermemory/envAPI keys saved by the installer, loaded on every launch

Next steps

Configuration

LLM providers, local models, performance tuning

Embeddings

Local default, OpenAI / Gemini / Ollama, multilingual

Memory API

The full API — it all works against your local server