docs: sync plugin sign-in with OAuth login

Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
This commit is contained in:
MaheshtheDev 2026-10-29 15:35:14 +00:00
parent 0f2b24b0f2
commit 1efef3542f
5 changed files with 22 additions and 8 deletions

View file

@ -42,7 +42,9 @@ icon: "/images/claude-code-icon.svg"
## Authenticate
Start a Claude Code session and the plugin opens a browser login, then saves the key to `~/.supermemory-claude/credentials.json`.
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 and saves its tokens to `~/.supermemory-claude/credentials.json`. Tokens refresh automatically. The plugin shows up on the [Agents page](https://console.supermemory.ai/agents) in the console, where you can change its access or disconnect it.
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:
@ -140,7 +142,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`) |
API key precedence is `SUPERMEMORY_CC_API_KEY`, project `apiKey`, then `~/.supermemory-claude/credentials.json`.
Credential precedence is `SUPERMEMORY_CC_API_KEY`, project `apiKey`, then the browser login saved in `~/.supermemory-claude/credentials.json`.
## Next steps

View file

@ -31,7 +31,13 @@ Restart Codex CLI after installing.
## Authenticate
**Browser auth is preferred.** Start Codex CLI — a browser window opens to authenticate with Supermemory.
**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, saves its tokens to `~/.codex/supermemory/credentials.json`, and refreshes them automatically. `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 also change the plugin's access or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
Alternatively, set an API key from [API Keys](https://console.supermemory.ai/keys):
@ -56,6 +62,8 @@ 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:

View file

@ -31,7 +31,7 @@ Open a new chat in Cursor and run:
/supermemory-setup
```
A browser window opens. Sign in to Supermemory and you are done.
Supermemory's authorization page opens in your browser. Sign in, choose the access to grant, and approve. The plugin signs in with OAuth and refreshes its tokens automatically. You can 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 +71,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`.
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.
</Accordion>
## How it works

View file

@ -38,9 +38,9 @@ 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 a browser login and writes `~/.supermemory-muse/credentials.json`.
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, writes its tokens to `~/.supermemory-muse/credentials.json`, and refreshes them automatically.
If you already logged in through the [Claude Code plugin](/integrations/claude-code), that key is reused from `~/.supermemory-claude/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.
Or write the file yourself with a key from [API Keys](https://console.supermemory.ai/keys):

View file

@ -31,6 +31,8 @@ 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, saves its tokens to `~/.supermemory-opencode/credentials.json`, and refreshes them automatically. Running OpenCode sessions pick up a login or logout without a restart. You can change the plugin's access or disconnect it from the [Agents page](https://console.supermemory.ai/agents) in the console.
Check the connection any time:
```bash
@ -60,6 +62,8 @@ 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>
@ -127,7 +131,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` | Clear stored credentials |
| `/supermemory-logout` | Revoke the browser login and clear stored credentials |
| `/supermemory-status` | Show the Supermemory connection status |
## Tools