mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-11-16 09:22:28 +00:00
docs: keep only the Agents page line on the Cursor, OpenCode and Muse Code pages
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
This commit is contained in:
parent
135881baaf
commit
24814bcca9
5 changed files with 13 additions and 21 deletions
|
|
@ -42,9 +42,7 @@ icon: "/images/claude-code-icon.svg"
|
|||
|
||||
## Authenticate
|
||||
|
||||
Start a Claude Code session and the plugin opens Supermemory's authorization page in your browser. Sign in, choose the access to grant, and approve. You have 5 minutes to approve. If the session starts before you finish, memory turns on from your next message. If the browser does not open, the session message prints a `login` command to run.
|
||||
|
||||
The plugin signs in with OAuth, so there is no API key to manage. You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
Start a Claude Code session and the plugin opens a browser login, then saves the key to `~/.supermemory-claude/credentials.json`.
|
||||
|
||||
Or create a Supermemory API key from the [API Keys](https://console.supermemory.ai/keys) page in the console and add it to your shell profile:
|
||||
|
||||
|
|
@ -142,7 +140,7 @@ Per-repo overrides in `.claude/.supermemory-claude/config.json`. Create the file
|
|||
| `namespace` | Override the project container. Takes precedence over `repoContainerTag` |
|
||||
| `repoContainerTag` | Override the project container (checked before `SUPERMEMORY_REPO_TAG`) |
|
||||
|
||||
Credential precedence is `SUPERMEMORY_CC_API_KEY`, project `apiKey`, then the browser login saved in `~/.supermemory-claude/credentials.json`.
|
||||
API key precedence is `SUPERMEMORY_CC_API_KEY`, project `apiKey`, then `~/.supermemory-claude/credentials.json`.
|
||||
|
||||
## Next steps
|
||||
|
||||
|
|
|
|||
|
|
@ -31,13 +31,7 @@ Restart Codex CLI after installing.
|
|||
|
||||
## Authenticate
|
||||
|
||||
**Browser auth is preferred.** Start Codex CLI and Supermemory's authorization page opens in your browser. Sign in, choose the access to grant, and approve. To sign in from a terminal instead:
|
||||
|
||||
```bash
|
||||
npx codex-supermemory@latest login
|
||||
```
|
||||
|
||||
The plugin signs in with OAuth. `npx codex-supermemory@latest status` shows how it is authenticated. `npx codex-supermemory@latest logout` revokes the login and pauses automatic browser login until you run `login` again. You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
**Browser auth is preferred.** Start Codex CLI — a browser window opens to authenticate with Supermemory.
|
||||
|
||||
Alternatively, set an API key from [API Keys](https://console.supermemory.ai/keys):
|
||||
|
||||
|
|
@ -62,8 +56,6 @@ Alternatively, set an API key from [API Keys](https://console.supermemory.ai/key
|
|||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
An API key from `SUPERMEMORY_CODEX_API_KEY` or `apiKey` in `~/.codex/supermemory.json` takes precedence over the browser login.
|
||||
|
||||
## How it works
|
||||
|
||||
Once installed, the plugin runs on every Codex session:
|
||||
|
|
|
|||
|
|
@ -31,7 +31,9 @@ Open a new chat in Cursor and run:
|
|||
/supermemory-setup
|
||||
```
|
||||
|
||||
Supermemory's authorization page opens in your browser. Sign in, choose the access to grant, and approve. The plugin signs in with OAuth. You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
A browser window opens. Sign in to Supermemory and you are done.
|
||||
|
||||
You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
|
||||
As a fallback, set an API key from [API Keys](https://console.supermemory.ai/keys):
|
||||
|
||||
|
|
@ -71,7 +73,7 @@ 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`. `logout` revokes the browser login and removes them. An API key from `SUPERMEMORY_API_KEY` or a config `apiKey` takes precedence over the browser login.
|
||||
Credentials are stored in `~/.supermemory-cursor/credentials.json`.
|
||||
</Accordion>
|
||||
|
||||
## How it works
|
||||
|
|
|
|||
|
|
@ -38,9 +38,11 @@ muse plugins approve supermemory
|
|||
|
||||
Muse runs hooks with a **cleared environment**, so an exported API key in your shell does not reach them. Auth is file-based.
|
||||
|
||||
The first session opens Supermemory's authorization page in your browser. Sign in, choose the access to grant, and approve. The plugin signs in with OAuth. You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
The first session opens a browser login and writes `~/.supermemory-muse/credentials.json`.
|
||||
|
||||
If `~/.supermemory-claude/credentials.json` holds an API key from the [Claude Code plugin](/integrations/claude-code), Muse Code reuses that key instead. A Claude Code browser login is not shared, so Muse Code asks you to sign in on its own.
|
||||
You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
|
||||
If you already logged in through the [Claude Code plugin](/integrations/claude-code), that key is reused from `~/.supermemory-claude/credentials.json`.
|
||||
|
||||
Or write the file yourself with a key from [API Keys](https://console.supermemory.ai/keys):
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ Browser login (recommended):
|
|||
bunx opencode-supermemory@latest login
|
||||
```
|
||||
|
||||
This opens Supermemory's authorization page. Sign in, choose the access to grant, and approve. The plugin signs in with OAuth. Running OpenCode sessions pick up a login or logout without a restart. You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
You can manage the plugin, change its access, or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
|
||||
|
||||
Check the connection any time:
|
||||
|
||||
|
|
@ -62,8 +62,6 @@ Or set an API key manually from the [API Keys](https://console.supermemory.ai/ke
|
|||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
`SUPERMEMORY_API_KEY` or `apiKey` in `~/.config/opencode/supermemory.jsonc` takes precedence over the browser login.
|
||||
|
||||
OpenCode V1 and OpenCode 2 read different keys from `~/.config/opencode/opencode.jsonc`. Use the config for the version you run:
|
||||
|
||||
<Tabs>
|
||||
|
|
@ -131,7 +129,7 @@ The installer adds these in-chat commands:
|
|||
|---------|-------------|
|
||||
| `/supermemory-index` | Explore and index your codebase structure into memory (`/supermemory-init` is an alias) |
|
||||
| `/supermemory-login` | Authenticate with Supermemory in the browser |
|
||||
| `/supermemory-logout` | Revoke the browser login and clear stored credentials |
|
||||
| `/supermemory-logout` | Clear stored credentials |
|
||||
| `/supermemory-status` | Show the Supermemory connection status |
|
||||
|
||||
## Tools
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue