diff options
Diffstat (limited to 'apps/docs/integrations')
| -rw-r--r-- | apps/docs/integrations/claude-code.mdx | 6 | ||||
| -rw-r--r-- | apps/docs/integrations/openclaw.mdx (renamed from apps/docs/integrations/clawdbot.mdx) | 36 | ||||
| -rw-r--r-- | apps/docs/integrations/opencode.mdx | 143 |
3 files changed, 168 insertions, 17 deletions
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" /> </div> +<Warning> +This integration requires the **Supermemory Pro plan**. [Upgrade here](https://console.supermemory.ai/billing). +</Warning> + [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. </Card> - <Card title="ClawdBot Plugin" icon="shrimp" href="/integrations/clawdbot"> + <Card title="OpenClaw Plugin" icon="messages-square" href="/integrations/openclaw"> Multi-platform memory for Telegram, WhatsApp, Discord, and more. </Card> </CardGroup> diff --git a/apps/docs/integrations/clawdbot.mdx b/apps/docs/integrations/openclaw.mdx index d1c6f94b..9f0101c0 100644 --- a/apps/docs/integrations/clawdbot.mdx +++ b/apps/docs/integrations/openclaw.mdx @@ -1,11 +1,15 @@ --- -title: "ClawdBot" -sidebarTitle: "ClawdBot" -description: "ClawdBot Supermemory Plugin — works across Telegram, WhatsApp, Discord, Slack, and more" -icon: "shrimp" +title: "OpenClaw" +sidebarTitle: "OpenClaw" +description: "OpenClaw Supermemory Plugin — works across Telegram, WhatsApp, Discord, Slack, and more" +icon: "/images/openclaw-logo.jpg" --- -[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. +<Warning> +This integration requires the **Supermemory Pro plan**. [Upgrade here](https://console.supermemory.ai/billing). +</Warning> + +[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 @@ -14,19 +18,19 @@ Create a Supermemory API key from the [API Keys](https://console.supermemory.ai/ <Tabs> <Tab title="macOS / Linux (zsh)"> ```bash - echo 'export SUPERMEMORY_CLAWDBOT_API_KEY="sm_..."' >> ~/.zshrc + echo 'export SUPERMEMORY_OPENCLAW_API_KEY="sm_..."' >> ~/.zshrc source ~/.zshrc ``` </Tab> <Tab title="macOS / Linux (bash)"> ```bash - echo 'export SUPERMEMORY_CLAWDBOT_API_KEY="sm_..."' >> ~/.bashrc + echo 'export SUPERMEMORY_OPENCLAW_API_KEY="sm_..."' >> ~/.bashrc source ~/.bashrc ``` </Tab> <Tab title="Windows (PowerShell)"> ```powershell - [System.Environment]::SetEnvironmentVariable("SUPERMEMORY_CLAWDBOT_API_KEY", "sm_...", "User") + [System.Environment]::SetEnvironmentVariable("SUPERMEMORY_OPENCLAW_API_KEY", "sm_...", "User") ``` Restart your terminal after running this. </Tab> @@ -35,10 +39,10 @@ Create a Supermemory API key from the [API Keys](https://console.supermemory.ai/ ## Install the Plugin ```bash -clawdbot plugins install @supermemory/clawdbot-supermemory +openclaw plugins install @supermemory/openclaw-supermemory ``` -Restart ClawdBot after installing. +Restart OpenClaw after installing. ## How It Works @@ -72,22 +76,22 @@ Users can interact with memory directly in chat: ### CLI Commands ```bash -clawdbot supermemory search <query> # Search memories from the terminal -clawdbot supermemory profile # View user profile -clawdbot supermemory wipe # Delete all memories (requires confirmation) +openclaw supermemory search <query> # 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 `clawdbot.json`: +Add the plugin to your `openclaw.json`: ```json5 { "plugins": { "entries": { - "clawdbot-supermemory": { + "openclaw-supermemory": { "enabled": true, "config": { "apiKey": "sm_..." @@ -112,7 +116,7 @@ Add the plugin to your `clawdbot.json`: ## Next Steps <CardGroup cols={2}> - <Card title="GitHub Repository" icon="github" href="https://github.com/supermemoryai/clawdbot-supermemory"> + <Card title="GitHub Repository" icon="github" href="https://github.com/supermemoryai/openclaw-supermemory"> Source code, issues, and detailed README. </Card> 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" +--- + +<Warning> +This integration requires the **Supermemory Pro plan**. [Upgrade here](https://console.supermemory.ai/billing). +</Warning> + +[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: + +<Tabs> + <Tab title="macOS / Linux (zsh)"> + ```bash + echo 'export SUPERMEMORY_API_KEY="sm_..."' >> ~/.zshrc + source ~/.zshrc + ``` + </Tab> + <Tab title="macOS / Linux (bash)"> + ```bash + echo 'export SUPERMEMORY_API_KEY="sm_..."' >> ~/.bashrc + source ~/.bashrc + ``` + </Tab> + <Tab title="Windows (PowerShell)"> + ```powershell + [System.Environment]::SetEnvironmentVariable("SUPERMEMORY_API_KEY", "sm_...", "User") + ``` + Restart your terminal after running this. + </Tab> +</Tabs> + +## 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 `<private>` 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 + +<CardGroup cols={2}> + <Card title="GitHub Repository" icon="github" href="https://github.com/supermemoryai/opencode-supermemory"> + Source code, issues, and detailed README. + </Card> + + <Card title="Claude Code Plugin" icon="code" href="/integrations/claude-code"> + Memory plugin for Claude Code. + </Card> +</CardGroup> |