Skip to content

Commit cbcd3ad

Browse files
committed
docs: update OpenClaw integration docs v2
docs: OpenClaw integration v2 documentation Restructure OpenClaw docs for Openclaw v2
1 parent 236216a commit cbcd3ad

File tree

1 file changed

+84
-59
lines changed

1 file changed

+84
-59
lines changed

apps/docs/integrations/openclaw.mdx

Lines changed: 84 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -11,51 +11,53 @@ This integration requires the **Supermemory Pro plan**. [Upgrade here](https://c
1111

1212
[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.
1313

14-
## Get Your API Key
15-
16-
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:
17-
18-
<Tabs>
19-
<Tab title="macOS / Linux (zsh)">
20-
```bash
21-
echo 'export SUPERMEMORY_OPENCLAW_API_KEY="sm_..."' >> ~/.zshrc
22-
source ~/.zshrc
23-
```
24-
</Tab>
25-
<Tab title="macOS / Linux (bash)">
26-
```bash
27-
echo 'export SUPERMEMORY_OPENCLAW_API_KEY="sm_..."' >> ~/.bashrc
28-
source ~/.bashrc
29-
```
30-
</Tab>
31-
<Tab title="Windows (PowerShell)">
32-
```powershell
33-
[System.Environment]::SetEnvironmentVariable("SUPERMEMORY_OPENCLAW_API_KEY", "sm_...", "User")
34-
```
35-
Restart your terminal after running this.
36-
</Tab>
37-
</Tabs>
38-
3914
## Install the Plugin
4015

16+
Get started by installing the plugin with a single command.
17+
4118
```bash
4219
openclaw plugins install @supermemory/openclaw-supermemory
4320
```
4421

4522
Restart OpenClaw after installing.
4623

24+
## Setup
25+
26+
Run the setup command and enter your API key when prompted.
27+
28+
```bash
29+
openclaw supermemory setup
30+
```
31+
32+
Enter your API key from [console.supermemory.ai](https://console.supermemory.ai). That's it.
33+
34+
<AccordionGroup>
35+
<Accordion title="Advanced Setup">
36+
Configure all options interactively with the advanced setup command:
37+
38+
```bash
39+
openclaw supermemory setup-advanced
40+
```
41+
42+
This lets you configure: container tag, auto-recall, auto-capture, capture mode, custom container tags, and more.
43+
44+
See [Configuration Options](#configuration-options) for all available settings.
45+
</Accordion>
46+
</AccordionGroup>
47+
4748
## How It Works
4849

49-
Once installed, the plugin runs automatically with zero interaction:
50+
Once installed, the plugin runs automatically with zero interaction.
5051

5152
- **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.
5253
- **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.
54+
- **Custom Container Tags** — When enabled via advanced setup, define custom memory containers (e.g., `work`, `personal`, `bookmarks`). The AI automatically picks the right container based on your instructions.
5355

5456
## Features
5557

5658
### AI Tools
5759

58-
The AI can use these tools autonomously during conversations:
60+
The AI can use these tools autonomously during conversations.
5961

6062
| Tool | Description |
6163
|------|-------------|
@@ -66,7 +68,7 @@ The AI can use these tools autonomously during conversations:
6668

6769
### Slash Commands
6870

69-
Users can interact with memory directly in chat:
71+
Users can interact with memory directly in chat.
7072

7173
| Command | Description |
7274
|---------|-------------|
@@ -75,43 +77,66 @@ Users can interact with memory directly in chat:
7577

7678
### CLI Commands
7779

80+
Manage your memory from the terminal.
81+
7882
```bash
79-
openclaw supermemory search <query> # Search memories from the terminal
80-
openclaw supermemory profile # View user profile
81-
openclaw supermemory wipe # Delete all memories (requires confirmation)
83+
openclaw supermemory setup # Configure API key
84+
openclaw supermemory setup-advanced # Configure all options
85+
openclaw supermemory status # View current configuration
86+
openclaw supermemory search <query> # Search memories
87+
openclaw supermemory profile # View user profile
88+
openclaw supermemory wipe # Delete all memories (requires confirmation)
8289
```
8390

84-
## Manual Configuration
85-
86-
Optional — only needed if you prefer to set the API key directly in the config file instead of the environment variable.
87-
88-
Add the plugin to your `openclaw.json`:
89-
90-
```json5
91-
{
92-
"plugins": {
93-
"entries": {
94-
"openclaw-supermemory": {
95-
"enabled": true,
96-
"config": {
97-
"apiKey": "sm_..."
91+
<AccordionGroup>
92+
<Accordion title="Manual Configuration">
93+
### Configuration Options
94+
95+
| Key | Type | Default | Description |
96+
|-----|------|---------|-------------|
97+
| `apiKey` | `string` || Supermemory API key. |
98+
| `containerTag` | `string` | `openclaw_{hostname}` | Root memory namespace. |
99+
| `autoRecall` | `boolean` | `true` | Inject relevant memories before every AI turn. |
100+
| `autoCapture` | `boolean` | `true` | Store conversation content after every turn. |
101+
| `maxRecallResults` | `number` | `10` | Max memories injected into context per turn. |
102+
| `profileFrequency` | `number` | `50` | Inject full user profile every N turns. |
103+
| `captureMode` | `string` | `"all"` | `"all"` filters noise. `"everything"` captures all messages. |
104+
| `debug` | `boolean` | `false` | Verbose debug logs. |
105+
| `enableCustomContainerTags` | `boolean` | `false` | Enable custom container routing. |
106+
| `customContainers` | `array` | `[]` | Custom containers with `tag` and `description`. |
107+
| `customContainerInstructions` | `string` | `""` | Instructions for AI on container routing. |
108+
109+
### Full Example
110+
111+
```json
112+
{
113+
"plugins": {
114+
"entries": {
115+
"openclaw-supermemory": {
116+
"enabled": true,
117+
"config": {
118+
"apiKey": "${SUPERMEMORY_OPENCLAW_API_KEY}",
119+
"containerTag": "my_memory",
120+
"autoRecall": true,
121+
"autoCapture": true,
122+
"maxRecallResults": 10,
123+
"profileFrequency": 50,
124+
"captureMode": "all",
125+
"debug": false,
126+
"enableCustomContainerTags": true,
127+
"customContainers": [
128+
{ "tag": "work", "description": "Work-related memories" },
129+
{ "tag": "personal", "description": "Personal notes" }
130+
],
131+
"customContainerInstructions": "Store work tasks in 'work', personal stuff in 'personal'"
132+
}
133+
}
98134
}
99135
}
100136
}
101-
}
102-
}
103-
```
104-
105-
### Advanced Options
106-
107-
| Key | Type | Default | Description |
108-
|-----|------|---------|-------------|
109-
| `autoRecall` | `boolean` | `true` | Inject relevant memories before every AI turn. |
110-
| `autoCapture` | `boolean` | `true` | Store conversation content after every turn. |
111-
| `maxRecallResults` | `number` | `10` | Max memories injected into context per turn. |
112-
| `profileFrequency` | `number` | `50` | Inject full user profile every N turns. |
113-
| `captureMode` | `string` | `"all"` | `"all"` filters noise. `"everything"` captures all messages. |
114-
| `debug` | `boolean` | `false` | Verbose debug logs. |
137+
```
138+
</Accordion>
139+
</AccordionGroup>
115140

116141
## Next Steps
117142

0 commit comments

Comments
 (0)