Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<p align="center">
<a href="https://supermemory.ai/docs">Docs</a> ·
<a href="https://supermemory.ai/docs/quickstart">Quickstart</a> ·
<a href="https://supermemory.ai/docs/self-hosting/overview">Self-host</a> ·
<a href="https://console.supermemory.ai">Dashboard</a> ·
<a href="https://supermemory.link/discord">Discord</a>
</p>
Expand Down Expand Up @@ -77,6 +78,21 @@ No vector DB config. No embedding pipelines. No chunking strategies.

**[→ Jump to developer quickstart](#build-with-supermemory-api)**

</td>
</tr>
<tr>
<td colspan="2" valign="top">

<h3>🖥️ I want to run it myself</h3>

State-of-the-art memory, on your machine. **One binary. Zero config.** Bring any model — or run fully offline with Ollama.

```bash
curl -fsSL https://supermemory.ai/install | bash
```

**[→ Jump to Supermemory local](#supermemory-local--run-it-yourself)**

</td>
</tr>
</table>
Expand Down Expand Up @@ -301,6 +317,38 @@ Full API reference → [supermemory.ai/docs](https://supermemory.ai/docs)

---

## Supermemory local — run it yourself

State-of-the-art memory, on your machine. One binary. Zero config.

```bash
curl -fsSL https://supermemory.ai/install | bash
# or
npx supermemory local
```

```bash
supermemory-server
```

First boot sets up the embedded Supermemory graph engine, local embeddings, and your credentials, then prints an API key. The full Memory API — documents, memories, user profiles, hybrid search — runs against `http://localhost:6767`.

```typescript
const client = new Supermemory({
apiKey: "sm_...",
baseURL: "http://localhost:6767", // that's the only change
});
```

- **Bring any model** — OpenAI, Anthropic, Gemini, Groq, or any OpenAI-compatible endpoint. An interactive wizard walks you through it on first boot.
- **Fully offline if you want** — point it at Ollama (`gpt-oss:20b` works great) and nothing leaves your machine.
- **Your data, one directory** — everything lives in `./.supermemory`, easy to back up or move.
- **Same API as the platform** — prototype locally, ship on the hosted platform by changing `baseURL`.

Read the [self-hosting docs](https://supermemory.ai/docs/self-hosting/overview) — quickstart, configuration, and [local vs. Enterprise](https://supermemory.ai/docs/self-hosting/local-vs-enterprise).

---

## Benchmarks

Supermemory is state of the art across all major AI memory benchmarks:
Expand Down Expand Up @@ -354,6 +402,7 @@ Your app / AI tool

- 📖 [Documentation](https://supermemory.ai/docs)
- 🚀 [Quickstart](https://supermemory.ai/docs/quickstart)
- 🖥️ [Self-hosting (Supermemory local)](https://supermemory.ai/docs/self-hosting/overview)
- 🧪 [MemoryBench](https://supermemory.ai/docs/memorybench/overview)
- 🔌 [Integrations](https://supermemory.ai/docs/integrations)
- 💬 [Discord](https://supermemory.link/discord)
Expand Down
243 changes: 0 additions & 243 deletions apps/docs/deployment/self-hosting.mdx

This file was deleted.

9 changes: 9 additions & 0 deletions apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,15 @@
"group": "Getting Started",
"pages": ["intro", "quickstart", "vibe-coding"]
},
{
"group": "Self-Hosting",
"pages": [
"self-hosting/overview",
"self-hosting/quickstart",
"self-hosting/configuration",
"self-hosting/local-vs-enterprise"
]
},
{
"group": "Concepts",
"pages": [
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/integrations/claude-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ This integration requires the **Supermemory Pro plan**. [Upgrade here](https://c

[Claude-Supermemory](https://github.com/supermemoryai/claude-supermemory) is a Claude Code plugin that gives your AI persistent memory across sessions. Your agent remembers what you worked on — across sessions, across projects.

<Tip>
**Prefer to keep everything on your machine?** This plugin works with [self-hosted Supermemory](/self-hosting/overview) — run `npx supermemory local`, then `export SUPERMEMORY_API_URL="http://localhost:6767"` and use the API key printed on first boot.
</Tip>

## Get Your API Key

Create a Supermemory API key from the [API Keys](https://console.supermemory.ai/keys) page, then add it to your shell profile so it persists across sessions:
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/integrations/codex.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ icon: "terminal"
- **Implicit** (hooks) — automatically recalls context before each prompt and captures conversations after each session.
- **Explicit** (skills) — lets you or the agent save, search, and manage memories on demand.

<Tip>
**Prefer to keep everything on your machine?** This plugin works with [self-hosted Supermemory](/self-hosting/overview) — run `npx supermemory local`, then `export SUPERMEMORY_API_URL="http://localhost:6767"` (or set `baseUrl` in `~/.codex/supermemory.json`) and use the API key printed on first boot.
</Tip>

## Get Your API Key

Create a Supermemory API key from the [API Keys](https://console.supermemory.ai/keys) page, then export it in your shell profile:
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/integrations/openclaw.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ This integration requires the **Supermemory Pro plan**. [Upgrade here](https://c

[OpenClaw](https://github.com/supermemoryai/openclaw-supermemory) is a multi-platform AI messaging gateway that connects to WhatsApp, Telegram, Discord, Slack, iMessage, and other messaging channels. The Supermemory plugin gives OpenClaw memory across every channel.

<Tip>
**Prefer to keep everything on your machine?** This plugin works with [self-hosted Supermemory](/self-hosting/overview) — run `npx supermemory local`, then `export SUPERMEMORY_BASE_URL="http://localhost:6767"` (or set `baseUrl` in the plugin config) and use the API key printed on first boot.
</Tip>

## Install the Plugin

Get started by installing the plugin with a single command.
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/integrations/opencode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ This integration requires the **Supermemory Pro plan**. [Upgrade here](https://c

[OpenCode-Supermemory](https://github.com/supermemoryai/opencode-supermemory) is an OpenCode plugin that gives your AI persistent memory across sessions. Your agent remembers what you worked on — across sessions, across projects.

<Tip>
**Prefer to keep everything on your machine?** This plugin works with [self-hosted Supermemory](/self-hosting/overview) — run `npx supermemory local`, then `export SUPERMEMORY_API_URL="http://localhost:6767"` and use the API key printed on first boot.
</Tip>

## Get Your API Key

Create a Supermemory API key from the [API Keys](https://console.supermemory.ai/keys) page, then add it to your shell profile so it persists across sessions:
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/integrations/supermemory-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ icon: "/images/supermemory.svg"
</Card>
</CardGroup>

<Tip>
Both SDKs also work against [self-hosted Supermemory](/self-hosting/overview) — pass `baseURL: "http://localhost:6767"` (TypeScript) or `base_url="http://localhost:6767"` (Python) when creating the client.
</Tip>

<Tabs>
<Tab title="TypeScript">
## Installation
Expand Down
Loading
Loading