mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-09-07 08:26:15 +00:00
docs: add Cursor and Grok Bot plugin pages (#1635)
Ship dedicated integration docs and point the plugin catalog at them. Grok Bot stays to install, auth, and skills — no Cursor-only config or repo tags.
This commit is contained in:
MaheshtheDev
parent
4ad5f0beb1
commit
17eab43cd4
8 changed files with 280 additions and 5 deletions
|
|
@ -388,6 +388,8 @@
|
|||
"pages": [
|
||||
"integrations/openclaw",
|
||||
"integrations/claude-code",
|
||||
"integrations/cursor",
|
||||
"integrations/grok-bot",
|
||||
"integrations/opencode",
|
||||
"integrations/codex",
|
||||
"integrations/hermes"
|
||||
|
|
|
|||
1
apps/docs/images/cursor-logo.svg
Normal file
1
apps/docs/images/cursor-logo.svg
Normal file
|
|
@ -0,0 +1 @@
|
|||
<svg fill="none" height="512" viewBox="0 0 512 512" width="512" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><clipPath id="a"><path d="m96 73h320.735v365.65h-320.735z"/></clipPath><path d="m512.001 325.499c0 7.124 0 14.24-.041 21.364-.035 5.999-.103 11.998-.268 17.99-.356 13.068-1.124 26.245-3.448 39.169-2.359 13.109-6.205 25.306-12.266 37.222-5.958 11.703-13.746 22.419-23.029 31.709-9.29 9.291-20 17.072-31.71 23.03-11.909 6.061-24.113 9.907-37.222 12.266-12.923 2.324-26.101 3.092-39.169 3.448-5.999.165-11.991.233-17.99.268-7.123.048-14.24.041-21.364.041h-139c-7.124 0-14.24 0-21.364-.041-5.999-.035-11.998-.103-17.99-.268-13.068-.356-26.245-1.124-39.169-3.448-13.109-2.359-25.306-6.205-37.2219-12.266-11.7034-5.958-22.4195-13.746-31.7095-23.03-9.29-9.29-17.0717-19.999-23.0296-31.709-6.06082-11.909-9.90709-24.113-12.26559-37.222-2.32422-12.924-3.092104-26.101-3.448621-39.169-.164547-5.999-.2331075-11.991-.267388-17.99-.02742444-7.124-.02742444-14.24-.02742444-21.364v-139c0-7.124 0-14.24.04113664-21.364.0342805-5.999.1028418-11.998.2673878-17.99.356517-13.068 1.124399-26.245 3.448619-39.169 2.3585-13.1091 6.20477-25.3061 12.26558-37.222 5.9579-11.7034 13.7465-22.4195 23.0296-31.7095 9.2901-9.29 19.9993-17.0717 31.7095-23.0296 11.9091-6.06082 24.1129-9.90709 37.2222-12.26559 12.923-2.32422 26.101-3.092101 39.168-3.448618 6-.164547 11.992-.2331075 17.991-.2673881 7.117-.03428046 14.233-.03428046 21.357-.03428046h139c7.124 0 14.24 0 21.364.04113656 5.999.0342806 11.998.102842 17.99.267388 13.068.356517 26.245 1.124402 39.169 3.448622 13.109 2.3585 25.306 6.20477 37.222 12.26553 11.703 5.958 22.419 13.7465 31.709 23.0297 9.29 9.29 17.072 19.9992 23.03 31.7094 6.061 11.9091 9.907 24.113 12.266 37.2222 2.324 12.923 3.092 26.101 3.448 39.169.165 5.999.233 11.991.268 17.99.048 7.123.041 14.24.041 21.364v139z" fill="#14120b"/><path d="m186.501 3.99902h139c7.125 0 14.231-.00004 21.341.04102 5.985.0342 11.952.10221 17.903.26562h.001c13.003.35475 25.943 1.11709 38.569 3.3877 12.775 2.29828 24.592 6.03144 36.118 11.89354v-.001c10.973 5.5867 21.052 12.8384 29.848 21.4571l.847.8379c8.993 8.993 16.525 19.3593 22.292 30.6933l3.565-1.8135-3.565 1.8145c5.678 11.1575 9.36 22.6024 11.674 34.9208l.219 1.195c2.129 11.837 2.932 23.95 3.316 36.132l.072 2.438c.164 5.958.232 11.919.266 17.904v.004c.048 7.107.041 14.207.041 21.337v129.344l-.007-.007v9.656c0 7.125 0 14.231-.041 21.341-.034 5.985-.102 11.952-.266 17.903v.001c-.354 13.003-1.117 25.944-3.387 38.569-2.227 12.376-5.8 23.853-11.351 35.037l-.543 1.08c-5.767 11.327-13.306 21.701-22.293 30.695-8.993 8.993-19.361 16.526-30.695 22.293-11.518 5.861-23.342 9.595-36.116 11.894-11.837 2.128-23.95 2.931-36.132 3.315l-2.438.072c-5.958.164-11.919.232-17.904.266h-.004c-7.107.048-14.207.041-21.337.041h-139c-7.125 0-14.231 0-21.341-.041-5.985-.034-11.952-.102-17.903-.266h-.001c-13.003-.355-25.944-1.117-38.57-3.387-12.7742-2.299-24.5914-6.032-36.1165-11.894h.001c-10.974-5.587-21.0534-12.837-29.8496-21.456l-.8467-.838c-8.7118-8.712-16.0531-18.713-21.7461-29.634l-.5459-1.06-.544-1.081c-5.3709-10.816-8.8904-21.919-11.12983-33.84l-.21973-1.196c-2.27061-12.625-3.03294-25.566-3.38769-38.569v-.001c-.16342-5.958-.23143-11.918-.26563-17.903-.02736-7.112-.02734-14.219-.02734-21.341v-139c0-7.125-.00005-14.231.04101-21.341.0342-5.985.10222-11.952.26563-17.903v-.001c.35475-13.003 1.11699-25.944 3.38769-38.57 2.29829-12.7743 6.03159-24.5916 11.89359-36.1166l-.001-.001c5.7665-11.3269 13.3073-21.6999 22.2939-30.6934 8.9933-8.9932 19.36-16.5261 30.6944-22.2929h.0009c11.5174-5.8615 23.3407-9.59617 36.1149-11.89455 11.837-2.12878 23.951-2.93017 36.133-3.31446l2.438-.07226c5.958-.16342 11.919-.23142 17.904-.26563l-.001-.00097c7.104-.03422 14.211-.03321 21.335-.03321z" stroke="#edecec" stroke-opacity=".2" stroke-width="8"/><g clip-path="url(#a)"><path d="m410.344 159.545-146.38-84.5111c-4.7-2.7145-10.5-2.7145-15.2 0l-146.373 84.5111c-3.9515 2.282-6.391 6.501-6.391 11.071v170.418c0 4.569 2.4395 8.789 6.391 11.07l146.379 84.512c4.701 2.714 10.501 2.714 15.201 0l146.38-84.512c3.951-2.281 6.391-6.501 6.391-11.07v-170.418c0-4.57-2.44-8.789-6.391-11.071zm-9.195 17.902-141.308 244.751c-.955 1.65-3.477.976-3.477-.934v-160.261c0-3.203-1.711-6.164-4.487-7.772l-138.786-80.127c-1.65-.956-.976-3.478.934-3.478h282.616c4.013 0 6.522 4.35 4.515 7.828h-.007z" fill="#edecec"/></g></svg>
|
||||
|
After Width: | Height: | Size: 4.3 KiB |
BIN
apps/docs/images/grok-logo.png
Normal file
BIN
apps/docs/images/grok-logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
|
|
@ -145,7 +145,7 @@ Per-repo overrides in `.claude/.supermemory-claude/config.json`. Run `/supermemo
|
|||
Source code, issues, and detailed README.
|
||||
</Card>
|
||||
|
||||
<Card title="OpenClaw Plugin" icon="messages-square" href="/integrations/openclaw">
|
||||
Multi-platform memory for Telegram, WhatsApp, Discord, and more.
|
||||
<Card title="Cursor Plugin" icon="/images/cursor-logo.svg" href="/integrations/cursor">
|
||||
Memory for your Cursor chats.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
|
|
|||
|
|
@ -170,7 +170,7 @@ tail -f ~/.codex-supermemory.log
|
|||
Source code, issues, and detailed README.
|
||||
</Card>
|
||||
|
||||
<Card title="Claude Code Plugin" icon="code" href="/integrations/claude-code">
|
||||
Memory plugin for Claude Code.
|
||||
<Card title="Cursor Plugin" icon="/images/cursor-logo.svg" href="/integrations/cursor">
|
||||
Memory for your Cursor chats.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
|
|
|||
208
apps/docs/integrations/cursor.mdx
Normal file
208
apps/docs/integrations/cursor.mdx
Normal file
|
|
@ -0,0 +1,208 @@
|
|||
---
|
||||
title: "Cursor"
|
||||
sidebarTitle: "Cursor"
|
||||
description: "cursor-supermemory: persistent memory across your Cursor chats"
|
||||
icon: "/images/cursor-logo.svg"
|
||||
---
|
||||
|
||||
Your agent remembers the decisions, bugs, and conventions from earlier chats instead of starting cold every time.
|
||||
|
||||
## Install
|
||||
|
||||
<Note>
|
||||
Requires [Node.js](https://nodejs.org) on your `PATH`. Installing Cursor does not put one there.
|
||||
</Note>
|
||||
|
||||
Run this in Cursor:
|
||||
|
||||
```
|
||||
/add-plugin cursor-supermemory
|
||||
```
|
||||
|
||||
Or install it from the [Cursor Marketplace](https://cursor.com/marketplace/supermemory): open **Customize**, find **Supermemory**, select **Install**, and choose **project** or **user** scope.
|
||||
|
||||
Restart Cursor or run **Developer: Reload Window** afterwards.
|
||||
|
||||
## Authenticate
|
||||
|
||||
Open a new chat in Cursor and run:
|
||||
|
||||
```
|
||||
/supermemory-setup
|
||||
```
|
||||
|
||||
A browser window opens. Sign in to Supermemory and you are done.
|
||||
|
||||
As a fallback, set an API key from [API Keys](https://console.supermemory.ai/keys):
|
||||
|
||||
<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>
|
||||
|
||||
Restart Cursor after installing the plugin or changing credentials.
|
||||
|
||||
Check the connection any time with `/supermemory-status`.
|
||||
|
||||
<Accordion title="Prefer the terminal?" icon="terminal">
|
||||
The slash commands just run the plugin's CLI for you. To drive it yourself:
|
||||
|
||||
```bash
|
||||
node "${CURSOR_PLUGIN_ROOT}/dist/cli.js" login
|
||||
node "${CURSOR_PLUGIN_ROOT}/dist/cli.js" status
|
||||
node "${CURSOR_PLUGIN_ROOT}/dist/cli.js" logout
|
||||
```
|
||||
|
||||
`CURSOR_PLUGIN_ROOT` is set for plugin hooks. If it is empty in your shell, run `node dist/cli.js <command>` from the installed plugin directory.
|
||||
|
||||
Credentials are stored in `~/.supermemory-cursor/credentials.json`.
|
||||
</Accordion>
|
||||
|
||||
## How It Works
|
||||
|
||||
| Layer | What it does |
|
||||
|-------|--------------|
|
||||
| Session profile | Loads your persistent profile when a Cursor conversation starts |
|
||||
| Automatic recall | Searches on substantive prompts, deduplicates results, and injects them after the first supported tool result |
|
||||
| Incremental capture | Saves each completed turn, and retries unsaved transcript deltas at session end |
|
||||
| MCP tools | Explicit memory control from any Cursor AI session |
|
||||
| Context gatherer | Fans out targeted searches before substantial work |
|
||||
| Always-on rule | Makes the agent recall relevant history proactively |
|
||||
|
||||
### Skills and Commands
|
||||
|
||||
| Name | Type | Description |
|
||||
|------|------|-------------|
|
||||
| `memory-init` | Skill | Explore the codebase and initialize project memory |
|
||||
| `memory-save` | Skill | Save an insight, decision, or solution worth keeping |
|
||||
| `memory-search` | Skill | Search memory for past work, bugs, and decisions |
|
||||
| `supermemory-context-gatherer` | Agent | Gather deep background before substantial work |
|
||||
| `supermemory-setup` | Command | Connect Supermemory to Cursor |
|
||||
| `supermemory-status` | Command | Check authentication and live connectivity |
|
||||
| `supermemory-config` | Command | Create or edit the project config file |
|
||||
| `supermemory-logout` | Command | Disconnect Supermemory from Cursor |
|
||||
|
||||
## MCP Tools
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `supermemory_get_config` | Show current config, resolved container tags, and config file paths |
|
||||
| `supermemory_set_config` | Update config at project or global scope |
|
||||
| `supermemory_containers` | Show what `user` and `project` container tags resolve to |
|
||||
| `supermemory_search` | Search memories by query |
|
||||
| `supermemory_add` | Save new information to memory |
|
||||
| `supermemory_list` | List stored memories |
|
||||
| `supermemory_forget` | Delete a memory by id or content |
|
||||
| `supermemory_profile` | Get your user profile summary |
|
||||
|
||||
Every tool that takes a `container` argument accepts:
|
||||
|
||||
- `"user"` (default): personal memories for the current repository
|
||||
- `"project"`: project knowledge for the current repository
|
||||
- `"both"`: both scopes plus compatible legacy memories
|
||||
- any custom string: used as a raw container tag
|
||||
|
||||
`user` and `project` write to the same repository container. The `sm_scope` metadata field is what keeps personal and session memories separate from explicit project knowledge when an agent asks for one scope.
|
||||
|
||||
## Container Tags
|
||||
|
||||
Cursor shares one repository tag with the [Claude Code](/integrations/claude-code), [OpenAI Codex](/integrations/codex), and [OpenCode](/integrations/opencode) plugins, so agents working on the same repo read and write the same memory:
|
||||
|
||||
```text
|
||||
repo_<project_name>__<project_id>
|
||||
```
|
||||
|
||||
The project ID is a stable hash of the normalized Git remote. Repositories without a remote fall back to their resolved local path. Two repos with the same directory name never collide, and different agents on the same repository share memory.
|
||||
|
||||
The plugin still reads the former `cursor_user_*` and `cursor_project_*` tags, along with legacy tags from the other agents. New writes only use the unified repository tag. Set `repoContainerTag` only when you need an explicit shared override.
|
||||
|
||||
## Configuration
|
||||
|
||||
<Tip>
|
||||
**Prefer to keep everything on your machine?** This plugin works with [self-hosted Supermemory](/self-hosting/overview): run `npx supermemory local`, then set `SUPERMEMORY_API_URL="http://localhost:6767"` (or `baseUrl` in your config file) and use the API key printed on first boot.
|
||||
</Tip>
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `SUPERMEMORY_API_KEY` | API key (overrides all other sources) |
|
||||
| `SUPERMEMORY_API_URL` | Override the Supermemory API base URL |
|
||||
| `SUPERMEMORY_REPO_TAG` | Override the unified repository container tag |
|
||||
| `SUPERMEMORY_USER_TAG` | Legacy Cursor personal container to continue reading |
|
||||
| `SUPERMEMORY_PROJECT_TAG` | Legacy Cursor project container to continue reading |
|
||||
| `CURSOR_USER_EMAIL` | Used only to find legacy Cursor personal memories |
|
||||
|
||||
### Global config
|
||||
|
||||
`~/.config/cursor/supermemory.json` holds user-wide defaults and applies to all projects.
|
||||
|
||||
```json
|
||||
{
|
||||
"repoContainerTag": "repo_my_project__0123456789abcdef",
|
||||
"similarityThreshold": 0.55,
|
||||
"maxMemories": 10,
|
||||
"injectProfile": true,
|
||||
"signalExtraction": false,
|
||||
"signalKeywords": ["remember", "architecture", "decision", "bug", "fix"],
|
||||
"signalTurnsBefore": 3
|
||||
}
|
||||
```
|
||||
|
||||
### Project config
|
||||
|
||||
`.cursor/.supermemory/config.json` holds per-workspace overrides and wins over global config. Add it to `.gitignore` if it contains an API key.
|
||||
|
||||
```json
|
||||
{
|
||||
"apiKey": "sm_...",
|
||||
"repoContainerTag": "repo_my_project__0123456789abcdef",
|
||||
"similarityThreshold": 0.55,
|
||||
"maxMemories": 10,
|
||||
"injectProfile": true
|
||||
}
|
||||
```
|
||||
|
||||
| Option | Default | Description |
|
||||
|--------|---------|-------------|
|
||||
| `apiKey` | — | Project-specific API key |
|
||||
| `baseUrl` | Supermemory API | Override the Supermemory API base URL |
|
||||
| `repoContainerTag` | derived from normalized Git remote or project path | Override the unified repository container |
|
||||
| `userContainerTag` | — | Legacy Cursor personal container to continue reading |
|
||||
| `projectContainerTag` | — | Legacy Cursor project container to continue reading |
|
||||
| `similarityThreshold` | `0.55` | Minimum similarity for prompt recall. Values below `0.55` are floored. |
|
||||
| `maxMemories` | `10` | Max profile facts injected at session start |
|
||||
| `injectProfile` | `true` | Whether to inject the user profile at session start |
|
||||
| `signalExtraction` | `false` | Capture only turns containing durable-signal keywords |
|
||||
| `signalKeywords` | `remember`, `architecture`, `decision`, `bug`, `fix` | Keywords that trigger signal-based capture |
|
||||
| `signalTurnsBefore` | `3` | Number of nearby turns retained around a signal |
|
||||
|
||||
You can also set these from the agent with `supermemory_set_config`, or edit the file by hand.
|
||||
|
||||
## Log Out
|
||||
|
||||
Run `/supermemory-logout` in Cursor.
|
||||
|
||||
This removes the stored credentials. Your memories in Supermemory are preserved.
|
||||
|
||||
## Next Steps
|
||||
|
||||
<Card title="GitHub Repository" icon="/images/github-icon.svg" href="https://github.com/supermemoryai/cursor-supermemory">
|
||||
Source code, issues, and detailed README.
|
||||
</Card>
|
||||
64
apps/docs/integrations/grok-bot.mdx
Normal file
64
apps/docs/integrations/grok-bot.mdx
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
title: "Grok Bot"
|
||||
sidebarTitle: "Grok Bot"
|
||||
description: "Supermemory for Grok Bot: persistent memory for your Grok Bots"
|
||||
icon: "/images/grok-logo.png"
|
||||
---
|
||||
|
||||
Grok Bots are cloud agents. A new task can mean a new machine and a blank context. Supermemory is the memory they keep between those tasks — findings, decisions, and preferences — so the next Bot does not start cold.
|
||||
|
||||
## How it helps
|
||||
|
||||
Without memory, a Bot redoes investigation you already paid for. With Supermemory:
|
||||
|
||||
- Later Bots know what earlier ones already figured out
|
||||
- You can save a decision or finding once and have it stick
|
||||
- You can ask what it already remembers instead of starting over
|
||||
|
||||
Install once, sign in, and it is available to your Grok Bots.
|
||||
|
||||
## Install
|
||||
|
||||
Open the [Supermemory for Grok Bot plugin page](https://x.ai/bot/plugin/58578698) and select **Add to Grok Bot**.
|
||||
|
||||
Restart Grok Bot afterwards so the plugin loads.
|
||||
|
||||
## Authenticate
|
||||
|
||||
Just ask Grok Bot:
|
||||
|
||||
```
|
||||
Sign me in to Supermemory
|
||||
```
|
||||
|
||||
It shows a connect card. Follow it to link your Supermemory account.
|
||||
|
||||
To check later, ask `Is Supermemory connected?`
|
||||
|
||||
## Skills
|
||||
|
||||
Grok Bot picks these up from what you ask. There are no slash commands.
|
||||
|
||||
| Skill | Ask for it like this |
|
||||
|-------|----------------------|
|
||||
| `memory-init` | "Learn this codebase and remember it" |
|
||||
| `memory-save` | "Remember that we use Vitest for unit tests" |
|
||||
| `memory-search` | "What do you remember about our database schema?" |
|
||||
|
||||
## Log Out
|
||||
|
||||
Ask Grok Bot to `Disconnect Supermemory`.
|
||||
|
||||
This removes the stored credentials. Your memories in Supermemory are preserved.
|
||||
|
||||
## Next Steps
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="GitHub Repository" icon="/images/github-icon.svg" href="https://github.com/supermemoryai/cursor-supermemory">
|
||||
Source code, issues, and detailed README.
|
||||
</Card>
|
||||
|
||||
<Card title="Cursor Plugin" icon="/images/cursor-logo.svg" href="/integrations/cursor">
|
||||
The same plugin, installed through Cursor.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
|
@ -86,7 +86,7 @@ export const PLUGIN_CATALOG: Record<string, PluginInfo> = {
|
|||
name: "Cursor",
|
||||
tagline: "Persistent memory, session hooks, and MCP tools inside Cursor",
|
||||
icon: "/images/plugins/cursor.png",
|
||||
docsUrl: "https://github.com/supermemoryai/cursor-supermemory#readme",
|
||||
docsUrl: "https://supermemory.ai/docs/integrations/cursor",
|
||||
githubUrl: "https://github.com/supermemoryai/cursor-supermemory",
|
||||
installSteps: [
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue