From e7642ffc86ce7229878628743e133defb930685d Mon Sep 17 00:00:00 2001 From: Dhravya Shah Date: Fri, 30 Jan 2026 17:32:02 -0700 Subject: fix: docs --- apps/docs/docs.json | 32 +++++--- apps/docs/images/openclaw-logo.jpg | Bin 0 -> 25699 bytes apps/docs/images/opencode-logo.png | Bin 0 -> 18088 bytes apps/docs/integrations/claude-code.mdx | 6 +- apps/docs/integrations/clawdbot.mdx | 122 ---------------------------- apps/docs/integrations/openclaw.mdx | 126 +++++++++++++++++++++++++++++ apps/docs/integrations/opencode.mdx | 143 +++++++++++++++++++++++++++++++++ 7 files changed, 296 insertions(+), 133 deletions(-) create mode 100644 apps/docs/images/openclaw-logo.jpg create mode 100644 apps/docs/images/opencode-logo.png delete mode 100644 apps/docs/integrations/clawdbot.mdx create mode 100644 apps/docs/integrations/openclaw.mdx create mode 100644 apps/docs/integrations/opencode.mdx (limited to 'apps') diff --git a/apps/docs/docs.json b/apps/docs/docs.json index c558c184..a97f9448 100644 --- a/apps/docs/docs.json +++ b/apps/docs/docs.json @@ -170,7 +170,7 @@ "icon": "plug", "anchors": [ { - "anchor": "Integrations", + "anchor": "API Integrations", "pages": [ "integrations/supermemory-sdk", "integrations/ai-sdk", @@ -179,18 +179,25 @@ "integrations/claude-memory", "integrations/pipecat", "integrations/n8n", - "integrations/zapier", - { - "group": "Plugins", - "pages": [ - "integrations/clawdbot", - "integrations/claude-code" - ] - } + "integrations/zapier" ] } ], - "tab": "Integrations" + "tab": "API Integrations" + }, + { + "icon": "puzzle", + "anchors": [ + { + "anchor": "Plugins", + "pages": [ + "integrations/openclaw", + "integrations/claude-code", + "integrations/opencode" + ] + } + ], + "tab": "Plugins" }, { "icon": "book-open", @@ -280,6 +287,11 @@ ] }, "redirects": [ + { + "destination": "/integrations/openclaw", + "permanent": true, + "source": "/integrations/clawdbot" + }, { "destination": "/intro", "permanent": false, diff --git a/apps/docs/images/openclaw-logo.jpg b/apps/docs/images/openclaw-logo.jpg new file mode 100644 index 00000000..0394c6f4 Binary files /dev/null and b/apps/docs/images/openclaw-logo.jpg differ diff --git a/apps/docs/images/opencode-logo.png b/apps/docs/images/opencode-logo.png new file mode 100644 index 00000000..d1ef7137 Binary files /dev/null and b/apps/docs/images/opencode-logo.png differ diff --git a/apps/docs/integrations/claude-code.mdx b/apps/docs/integrations/claude-code.mdx index 4a130f77..7e12099d 100644 --- a/apps/docs/integrations/claude-code.mdx +++ b/apps/docs/integrations/claude-code.mdx @@ -13,6 +13,10 @@ icon: "/images/claude-code-icon.svg" /> + +This integration requires the **Supermemory Pro plan**. [Upgrade here](https://console.supermemory.ai/billing). + + [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. ## Get Your API Key @@ -107,7 +111,7 @@ Create `~/.supermemory-claude/settings.json`: Source code, issues, and detailed README. - + Multi-platform memory for Telegram, WhatsApp, Discord, and more. diff --git a/apps/docs/integrations/clawdbot.mdx b/apps/docs/integrations/clawdbot.mdx deleted file mode 100644 index d1c6f94b..00000000 --- a/apps/docs/integrations/clawdbot.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "ClawdBot" -sidebarTitle: "ClawdBot" -description: "ClawdBot Supermemory Plugin — works across Telegram, WhatsApp, Discord, Slack, and more" -icon: "shrimp" ---- - -[ClawdBot](https://github.com/supermemoryai/clawdbot-supermemory) is a multi-platform AI messaging gateway that connects to WhatsApp, Telegram, Discord, Slack, iMessage, and other messaging channels. The Supermemory plugin gives ClawdBot memory across every channel. - -## 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: - - - - ```bash - echo 'export SUPERMEMORY_CLAWDBOT_API_KEY="sm_..."' >> ~/.zshrc - source ~/.zshrc - ``` - - - ```bash - echo 'export SUPERMEMORY_CLAWDBOT_API_KEY="sm_..."' >> ~/.bashrc - source ~/.bashrc - ``` - - - ```powershell - [System.Environment]::SetEnvironmentVariable("SUPERMEMORY_CLAWDBOT_API_KEY", "sm_...", "User") - ``` - Restart your terminal after running this. - - - -## Install the Plugin - -```bash -clawdbot plugins install @supermemory/clawdbot-supermemory -``` - -Restart ClawdBot after installing. - -## How It Works - -Once installed, the plugin runs automatically with zero interaction: - -- **Auto-Recall** — Before every AI turn, Supermemory is queried for relevant memories and the user's profile. These are injected as context so the AI sees preferences, facts, and semantically similar past conversations. -- **Auto-Capture** — After every AI turn, the conversation exchange is sent to Supermemory for extraction and long-term storage. Supermemory handles deduplication and profile building. - -## Features - -### AI Tools - -The AI can use these tools autonomously during conversations: - -| Tool | Description | -|------|-------------| -| `supermemory_store` | Save information to long-term memory. | -| `supermemory_search` | Search memories by query with similarity scores. | -| `supermemory_forget` | Delete a memory by query or ID. | -| `supermemory_profile` | View the user profile — persistent facts and recent context. | - -### Slash Commands - -Users can interact with memory directly in chat: - -| Command | Description | -|---------|-------------| -| `/remember [text]` | Manually save something to memory. | -| `/recall [query]` | Search memories and see results with similarity scores. | - -### CLI Commands - -```bash -clawdbot supermemory search # Search memories from the terminal -clawdbot supermemory profile # View user profile -clawdbot supermemory wipe # Delete all memories (requires confirmation) -``` - -## Manual Configuration - -Optional — only needed if you prefer to set the API key directly in the config file instead of the environment variable. - -Add the plugin to your `clawdbot.json`: - -```json5 -{ - "plugins": { - "entries": { - "clawdbot-supermemory": { - "enabled": true, - "config": { - "apiKey": "sm_..." - } - } - } - } -} -``` - -### Advanced Options - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| `autoRecall` | `boolean` | `true` | Inject relevant memories before every AI turn. | -| `autoCapture` | `boolean` | `true` | Store conversation content after every turn. | -| `maxRecallResults` | `number` | `10` | Max memories injected into context per turn. | -| `profileFrequency` | `number` | `50` | Inject full user profile every N turns. | -| `captureMode` | `string` | `"all"` | `"all"` filters noise. `"everything"` captures all messages. | -| `debug` | `boolean` | `false` | Verbose debug logs. | - -## Next Steps - - - - Source code, issues, and detailed README. - - - - Use Claude's native memory tool with Supermemory as backend. - - diff --git a/apps/docs/integrations/openclaw.mdx b/apps/docs/integrations/openclaw.mdx new file mode 100644 index 00000000..9f0101c0 --- /dev/null +++ b/apps/docs/integrations/openclaw.mdx @@ -0,0 +1,126 @@ +--- +title: "OpenClaw" +sidebarTitle: "OpenClaw" +description: "OpenClaw Supermemory Plugin — works across Telegram, WhatsApp, Discord, Slack, and more" +icon: "/images/openclaw-logo.jpg" +--- + + +This integration requires the **Supermemory Pro plan**. [Upgrade here](https://console.supermemory.ai/billing). + + +[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. + +## 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: + + + + ```bash + echo 'export SUPERMEMORY_OPENCLAW_API_KEY="sm_..."' >> ~/.zshrc + source ~/.zshrc + ``` + + + ```bash + echo 'export SUPERMEMORY_OPENCLAW_API_KEY="sm_..."' >> ~/.bashrc + source ~/.bashrc + ``` + + + ```powershell + [System.Environment]::SetEnvironmentVariable("SUPERMEMORY_OPENCLAW_API_KEY", "sm_...", "User") + ``` + Restart your terminal after running this. + + + +## Install the Plugin + +```bash +openclaw plugins install @supermemory/openclaw-supermemory +``` + +Restart OpenClaw after installing. + +## How It Works + +Once installed, the plugin runs automatically with zero interaction: + +- **Auto-Recall** — Before every AI turn, Supermemory is queried for relevant memories and the user's profile. These are injected as context so the AI sees preferences, facts, and semantically similar past conversations. +- **Auto-Capture** — After every AI turn, the conversation exchange is sent to Supermemory for extraction and long-term storage. Supermemory handles deduplication and profile building. + +## Features + +### AI Tools + +The AI can use these tools autonomously during conversations: + +| Tool | Description | +|------|-------------| +| `supermemory_store` | Save information to long-term memory. | +| `supermemory_search` | Search memories by query with similarity scores. | +| `supermemory_forget` | Delete a memory by query or ID. | +| `supermemory_profile` | View the user profile — persistent facts and recent context. | + +### Slash Commands + +Users can interact with memory directly in chat: + +| Command | Description | +|---------|-------------| +| `/remember [text]` | Manually save something to memory. | +| `/recall [query]` | Search memories and see results with similarity scores. | + +### CLI Commands + +```bash +openclaw supermemory search # Search memories from the terminal +openclaw supermemory profile # View user profile +openclaw supermemory wipe # Delete all memories (requires confirmation) +``` + +## Manual Configuration + +Optional — only needed if you prefer to set the API key directly in the config file instead of the environment variable. + +Add the plugin to your `openclaw.json`: + +```json5 +{ + "plugins": { + "entries": { + "openclaw-supermemory": { + "enabled": true, + "config": { + "apiKey": "sm_..." + } + } + } + } +} +``` + +### Advanced Options + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| `autoRecall` | `boolean` | `true` | Inject relevant memories before every AI turn. | +| `autoCapture` | `boolean` | `true` | Store conversation content after every turn. | +| `maxRecallResults` | `number` | `10` | Max memories injected into context per turn. | +| `profileFrequency` | `number` | `50` | Inject full user profile every N turns. | +| `captureMode` | `string` | `"all"` | `"all"` filters noise. `"everything"` captures all messages. | +| `debug` | `boolean` | `false` | Verbose debug logs. | + +## Next Steps + + + + Source code, issues, and detailed README. + + + + Use Claude's native memory tool with Supermemory as backend. + + diff --git a/apps/docs/integrations/opencode.mdx b/apps/docs/integrations/opencode.mdx new file mode 100644 index 00000000..d1a11b67 --- /dev/null +++ b/apps/docs/integrations/opencode.mdx @@ -0,0 +1,143 @@ +--- +title: "OpenCode" +sidebarTitle: "OpenCode" +description: "OpenCode Supermemory Plugin — persistent memory across coding sessions" +icon: "/images/opencode-logo.png" +--- + + +This integration requires the **Supermemory Pro plan**. [Upgrade here](https://console.supermemory.ai/billing). + + +[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. + +## 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: + + + + ```bash + echo 'export SUPERMEMORY_API_KEY="sm_..."' >> ~/.zshrc + source ~/.zshrc + ``` + + + ```bash + echo 'export SUPERMEMORY_API_KEY="sm_..."' >> ~/.bashrc + source ~/.bashrc + ``` + + + ```powershell + [System.Environment]::SetEnvironmentVariable("SUPERMEMORY_API_KEY", "sm_...", "User") + ``` + Restart your terminal after running this. + + + +## Install the Plugin + +```bash +bunx opencode-supermemory@latest install +``` + +For LLM agents (non-interactive): + +```bash +bunx opencode-supermemory@latest install --no-tui +``` + +Ensure your `~/.config/opencode/opencode.jsonc` contains: + +```json +{ + "plugin": ["opencode-supermemory"] +} +``` + +## How It Works + +Once installed, the plugin runs automatically: + +- **Context Injection** — On session start, relevant memories are fetched and injected into the agent's context. This includes user preferences, project knowledge, and past interactions. +- **Keyword Detection** — Phrases like "remember" or "save this" trigger automatic storage. +- **Smart Compaction** — At 80% context capacity, sessions are summarized and saved as memories. +- **Privacy Protection** — Content within `` tags never persists. + +### Memory Scopes + +| Scope | Description | +|-------|-------------| +| `user` | Memories that persist across all projects | +| `project` | Memories isolated to the current project (default) | + +### Memory Types + +| Type | Description | +|------|-------------| +| `project-config` | Project configuration and setup details | +| `architecture` | Codebase structure and design patterns | +| `error-solution` | Problems encountered and their fixes | +| `preference` | User preferences and coding style | +| `learned-pattern` | Patterns discovered during sessions | +| `conversation` | Important conversation context | + +## Commands + +### /supermemory-init + +Explore and index your codebase structure into memory: + +``` +/supermemory-init +``` + +## Tools + +The agent has access to a `supermemory` tool with these modes: + +| Mode | Parameters | Function | +|------|------------|----------| +| `add` | content, type?, scope? | Store information | +| `search` | query, scope? | Find relevant memories | +| `profile` | query? | View user preferences | +| `list` | scope?, limit? | Display stored items | +| `forget` | memoryId, scope? | Remove memory | + +## Configuration + +Create `~/.config/opencode/supermemory.jsonc`: + +```jsonc +{ + "apiKey": "sm_...", // Or use SUPERMEMORY_API_KEY env var + "similarityThreshold": 0.6, // Minimum match score (0-1) + "maxMemories": 5, // Memories per injection + "maxProjectMemories": 10, // Project memory listings + "maxProfileItems": 5, // Profile facts injected + "injectProfile": true, // Include user preferences in context + "containerTagPrefix": "opencode", // Tag prefix for scoping + "compactionThreshold": 0.80 // Context usage ratio for summarization +} +``` + +## Logging + +View plugin activity: + +```bash +tail -f ~/.opencode-supermemory.log +``` + +## Next Steps + + + + Source code, issues, and detailed README. + + + + Memory plugin for Claude Code. + + -- cgit v1.2.3