diff options
Diffstat (limited to 'apps/docs/integrations/clawdbot.mdx')
| -rw-r--r-- | apps/docs/integrations/clawdbot.mdx | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/apps/docs/integrations/clawdbot.mdx b/apps/docs/integrations/clawdbot.mdx new file mode 100644 index 00000000..d1c6f94b --- /dev/null +++ b/apps/docs/integrations/clawdbot.mdx @@ -0,0 +1,122 @@ +--- +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: + +<Tabs> + <Tab title="macOS / Linux (zsh)"> + ```bash + echo 'export SUPERMEMORY_CLAWDBOT_API_KEY="sm_..."' >> ~/.zshrc + source ~/.zshrc + ``` + </Tab> + <Tab title="macOS / Linux (bash)"> + ```bash + echo 'export SUPERMEMORY_CLAWDBOT_API_KEY="sm_..."' >> ~/.bashrc + source ~/.bashrc + ``` + </Tab> + <Tab title="Windows (PowerShell)"> + ```powershell + [System.Environment]::SetEnvironmentVariable("SUPERMEMORY_CLAWDBOT_API_KEY", "sm_...", "User") + ``` + Restart your terminal after running this. + </Tab> +</Tabs> + +## 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 <query> # 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 + +<CardGroup cols={2}> + <Card title="GitHub Repository" icon="github" href="https://github.com/supermemoryai/clawdbot-supermemory"> + Source code, issues, and detailed README. + </Card> + + <Card title="Claude Memory Tool" icon="brain" href="/integrations/claude-memory"> + Use Claude's native memory tool with Supermemory as backend. + </Card> +</CardGroup> |