mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-09-30 01:51:28 +00:00
add eve docs and refresh integrations (#1671)
This commit is contained in:
Prasanna
GitHub
parent
2415a5c796
commit
8652a0e5ea
11 changed files with 238 additions and 8 deletions
|
|
@ -233,6 +233,7 @@
|
|||
"pages": [
|
||||
"integrations/supermemory-sdk",
|
||||
"integrations/ai-sdk",
|
||||
"integrations/eve",
|
||||
"integrations/openai",
|
||||
"integrations/langgraph",
|
||||
"integrations/openai-agents-sdk",
|
||||
|
|
@ -387,12 +388,12 @@
|
|||
"icon": "puzzle",
|
||||
"pages": [
|
||||
"integrations/openclaw",
|
||||
"integrations/hermes",
|
||||
"integrations/claude-code",
|
||||
"integrations/cursor",
|
||||
"integrations/grok-bot",
|
||||
"integrations/opencode",
|
||||
"integrations/codex",
|
||||
"integrations/hermes"
|
||||
"integrations/opencode",
|
||||
"integrations/cursor",
|
||||
"integrations/grok-bot"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
|
|
|||
27
apps/docs/images/codex.svg
Normal file
27
apps/docs/images/codex.svg
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
<!--
|
||||
Source: https://raw.githubusercontent.com/lobehub/lobe-icons/a94750e3f5f8fc33757b839d85030e742284e43a/packages/static-svg/icons/codex-color.svg
|
||||
Verified against the Codex app icon supplied with the installed OpenAI app.
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 LobeHub
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
-->
|
||||
<svg height="1em" style="flex:none;line-height:1" viewBox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><title>Codex</title><path d="M19.503 0H4.496A4.496 4.496 0 000 4.496v15.007A4.496 4.496 0 004.496 24h15.007A4.496 4.496 0 0024 19.503V4.496A4.496 4.496 0 0019.503 0z" fill="#fff"></path><path d="M9.064 3.344a4.578 4.578 0 012.285-.312c1 .115 1.891.54 2.673 1.275.01.01.024.017.037.021a.09.09 0 00.043 0 4.55 4.55 0 013.046.275l.047.022.116.057a4.581 4.581 0 012.188 2.399c.209.51.313 1.041.315 1.595a4.24 4.24 0 01-.134 1.223.123.123 0 00.03.115c.594.607.988 1.33 1.183 2.17.289 1.425-.007 2.71-.887 3.854l-.136.166a4.548 4.548 0 01-2.201 1.388.123.123 0 00-.081.076c-.191.551-.383 1.023-.74 1.494-.9 1.187-2.222 1.846-3.711 1.838-1.187-.006-2.239-.44-3.157-1.302a.107.107 0 00-.105-.024c-.388.125-.78.143-1.204.138a4.441 4.441 0 01-1.945-.466 4.544 4.544 0 01-1.61-1.335c-.152-.202-.303-.392-.414-.617a5.81 5.81 0 01-.37-.961 4.582 4.582 0 01-.014-2.298.124.124 0 00.006-.056.085.085 0 00-.027-.048 4.467 4.467 0 01-1.034-1.651 3.896 3.896 0 01-.251-1.192 5.189 5.189 0 01.141-1.6c.337-1.112.982-1.985 1.933-2.618.212-.141.413-.251.601-.33.215-.089.43-.164.646-.227a.098.098 0 00.065-.066 4.51 4.51 0 01.829-1.615 4.535 4.535 0 011.837-1.388zm3.482 10.565a.637.637 0 000 1.272h3.636a.637.637 0 100-1.272h-3.636zM8.462 9.23a.637.637 0 00-1.106.631l1.272 2.224-1.266 2.136a.636.636 0 101.095.649l1.454-2.455a.636.636 0 00.005-.64L8.462 9.23z" fill="url(#lobe-icons-codex-_R_0_)"></path><defs><linearGradient gradientUnits="userSpaceOnUse" id="lobe-icons-codex-_R_0_" x1="12" x2="12" y1="3" y2="21"><stop stop-color="#B1A7FF"></stop><stop offset=".5" stop-color="#7A9DFF"></stop><stop offset="1" stop-color="#3941FF"></stop></linearGradient></defs></svg>
|
||||
BIN
apps/docs/images/eve-memory-poster.png
Normal file
BIN
apps/docs/images/eve-memory-poster.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 120 KiB |
6
apps/docs/images/eve.svg
Normal file
6
apps/docs/images/eve.svg
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
<!-- Source: the Eve wordmark at https://eve.dev/ -->
|
||||
<svg width="169" height="53" viewBox="0 0 169 53" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<title>Eve</title>
|
||||
<path d="M169 8.47h-51.39L81.73 53H70.36L113 0H169zM169 44.51v8.47h-45.87V44.5zM45.87 52.98H0V44.5h45.87zM38.66 30.55H0v-8.47h38.66z" fill="black"/>
|
||||
<path d="M169 30.55h-38.66v-8.47H169zM75.52 8.47H0V0h75.52z" fill="black"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 403 B |
18
apps/docs/images/opencode-logo-dark.svg
Normal file
18
apps/docs/images/opencode-logo-dark.svg
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
<svg width="300" height="300" viewBox="0 0 300 300" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<g transform="translate(30, 0)">
|
||||
<g clip-path="url(#clip0_1401_86283)">
|
||||
<mask id="mask0_1401_86283" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="240" height="300">
|
||||
<path d="M240 0H0V300H240V0Z" fill="white"/>
|
||||
</mask>
|
||||
<g mask="url(#mask0_1401_86283)">
|
||||
<path d="M180 240H60V120H180V240Z" fill="#4B4646"/>
|
||||
<path d="M180 60H60V240H180V60ZM240 300H0V0H240V300Z" fill="#F1ECEC"/>
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1401_86283">
|
||||
<rect width="240" height="300" fill="white"/>
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 631 B |
18
apps/docs/images/opencode-logo.svg
Normal file
18
apps/docs/images/opencode-logo.svg
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
<svg width="300" height="300" viewBox="0 0 300 300" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<g transform="translate(30, 0)">
|
||||
<g clip-path="url(#clip0_1401_86274)">
|
||||
<mask id="mask0_1401_86274" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="240" height="300">
|
||||
<path d="M240 0H0V300H240V0Z" fill="white"/>
|
||||
</mask>
|
||||
<g mask="url(#mask0_1401_86274)">
|
||||
<path d="M180 240H60V120H180V240Z" fill="#CFCECD"/>
|
||||
<path d="M180 60H60V240H180V60ZM240 300H0V0H240V300Z" fill="#211E1E"/>
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1401_86274">
|
||||
<rect width="240" height="300" fill="white"/>
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 631 B |
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: "OpenAI Codex"
|
||||
sidebarTitle: "OpenAI Codex"
|
||||
title: "Codex"
|
||||
sidebarTitle: "Codex"
|
||||
description: "codex-supermemory — persistent memory for OpenAI Codex CLI"
|
||||
icon: "terminal"
|
||||
icon: "/images/codex.svg"
|
||||
---
|
||||
|
||||
[codex-supermemory](https://github.com/supermemoryai/codex-supermemory) wires Supermemory into the [OpenAI Codex CLI](https://github.com/openai/codex) via hooks and skills. Your agent gets **two layers of memory**:
|
||||
|
|
|
|||
149
apps/docs/integrations/eve.mdx
Normal file
149
apps/docs/integrations/eve.mdx
Normal file
|
|
@ -0,0 +1,149 @@
|
|||
---
|
||||
title: "Eve"
|
||||
sidebarTitle: "Eve"
|
||||
description: "Give your Eve agent memory across conversations with Supermemory."
|
||||
icon: "/images/eve.svg"
|
||||
---
|
||||
|
||||
Your next conversation can start where the last one left off. Supermemory gives your [Eve](https://eve.dev) agent the context to continue a project: what was decided, what changed, and the source material behind it.
|
||||
|
||||
You don't need to build a separate **parsing**, **embedding**, **indexing**, or **memory-retrieval** pipeline. Supermemory handles that infrastructure. Eve's memory scope and namespace let you keep context separated by user or workspace.
|
||||
|
||||
## Add Supermemory
|
||||
|
||||
Start with an existing Eve project, Node.js 24 or newer, and an Eve version compatible with `eve@^0.47.3`.
|
||||
|
||||
<Steps>
|
||||
<Step title="Add the provider">
|
||||
Run this from your Eve project:
|
||||
|
||||
```bash
|
||||
eve add memory/supermemory
|
||||
```
|
||||
|
||||
Eve installs `@supermemory/eve` and creates `agent/memory/supermemory.ts`, the file that connects your agent to Supermemory.
|
||||
</Step>
|
||||
|
||||
<Step title="Connect your Supermemory account">
|
||||
Create an [API key in the Supermemory console](https://console.supermemory.ai/keys) and add it to your project's environment:
|
||||
|
||||
```bash .env.local
|
||||
SUPERMEMORY_API_KEY="your-supermemory-api-key"
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Start your agent">
|
||||
Start or restart Eve to load the provider and API key:
|
||||
|
||||
```bash
|
||||
eve dev
|
||||
```
|
||||
|
||||
Automatic recall and conversation capture are enabled by default. The memory tools are available to your agent alongside its existing tools.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
You can also [install the provider manually](#manual-installation).
|
||||
|
||||
## How memory works
|
||||
|
||||
Two conversations about the same launch show the three parts working together: **session history**, **indexed sources**, and **memories**.
|
||||
|
||||
<video
|
||||
className="eve-memory-video"
|
||||
controls
|
||||
playsInline
|
||||
preload="metadata"
|
||||
poster="/images/eve-memory-poster.png"
|
||||
aria-label="How Eve saves context and retrieves it in a new session"
|
||||
>
|
||||
<source src="/videos/eve-memory.mp4" type="video/mp4" />
|
||||
<a href="/videos/eve-memory.mp4">Watch the memory explainer</a>.
|
||||
</video>
|
||||
|
||||
After a successful turn, the provider saves the user and assistant messages as **session history**. Supermemory processes that conversation into durable **memories**, such as the launch date or the decision to keep the first release web-only. Capture is automatic; processing happens asynchronously.
|
||||
|
||||
Files take a separate path. When Eve works with an attachment, URL, or text, [SuperRAG](/concepts/super-rag) parses or transcribes it into an **indexed source** the agent can read. Eve can then save a useful conclusion as a memory, retaining the source document's ID. In the example, the budget stays connected to the launch brief.
|
||||
|
||||
Before a later turn, the provider loads the [user profile](/concepts/user-profiles) and searches for relevant saved context. Eve can read an earlier session or follow a source-backed memory to the original document when it needs more detail. The new conversation can then use both the earlier decision and the evidence behind it. Recall also runs after context compaction.
|
||||
|
||||
## Memory tools
|
||||
|
||||
The provider gives Eve seven tools alongside automatic recall and capture. The generated file is named `supermemory.ts`, so Eve prefixes their names with `supermemory__`.
|
||||
|
||||
<Accordion title="Tool reference">
|
||||
|
||||
| Tool | Purpose |
|
||||
| --- | --- |
|
||||
| `search` | Find relevant memories and session history in the current memory scope. |
|
||||
| `read_session` | Read a stored conversation found through search. |
|
||||
| `read_document` | Read sections of a processed source, fetching more as needed. |
|
||||
| `remember` | Save a standalone fact, preference, decision, or correction; optionally retain its `sourceDocumentId`. |
|
||||
| `extract` | Parse, transcribe, and index an Eve attachment, URL, or text with SuperRAG. |
|
||||
| `forget` | Remove one memory by ID. |
|
||||
| `forget_matching` | Preview memories within a requested boundary, then remove selected IDs. |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Forgetting saved memories">
|
||||
Eve can find a specific memory with `search` and remove it with `forget`. For a broader request, `forget_matching` supports a dry run that returns candidate memories. Its tool instructions tell Eve to show that preview, ask you to confirm, and remove the exact IDs you approved.
|
||||
|
||||
Forgetting removes derived memories. The original session history and source documents remain stored.
|
||||
</Accordion>
|
||||
|
||||
## Choose whose memory Eve uses
|
||||
|
||||
The generated memory file uses Eve's `byPrincipal` scope. In an authenticated application, memory follows the caller's identity. During `eve dev`, it uses the shared `local-dev` scope. Outside local development, anonymous and runtime principals have memory disabled.
|
||||
|
||||
For a team or multi-tenant application, derive the scope from verified user and tenant identity. Eve resolves that scope before the provider runs, so the agent's tools cannot choose another user's memory. See [Eve's multi-tenant memory guide](https://eve.dev/docs/patterns/multi-tenant-memory).
|
||||
|
||||
Eve also supplies a default namespace for the memory slot. You only need to set `namespace` yourself when you want a custom memory domain. Keep it stable: changing it selects a different memory space. [Eve's namespace documentation](https://eve.dev/docs/memory#namespace) explains the defaults and how to share a domain intentionally.
|
||||
|
||||
## Configure the provider
|
||||
|
||||
Edit the options passed to `supermemory(...)` in `agent/memory/supermemory.ts`. The generated file only needs your API key; the defaults enable automatic search and capture.
|
||||
|
||||
You can adjust those behaviors independently. Set `autoSearch.enabled` to `false` to disable automatic search while keeping profile recall. Set `capture.enabled` to `false` to stop saving completed turns automatically. Both settings leave the explicit memory tools available.
|
||||
|
||||
<Accordion title="Provider options and defaults">
|
||||
| Option | Default | Purpose |
|
||||
| --- | --- | --- |
|
||||
| `apiKey` | Required | Supermemory API key, or a function returning the key synchronously or asynchronously. |
|
||||
| `containerTagPrefix` | `"eve_agent"` | Prefix for storage tags derived from Eve's scope. Keep it stable to access the same data. |
|
||||
| `autoSearch.enabled` | `true` | Search for context relevant to the current request during recall. |
|
||||
| `profileContext.timeZone` | `"UTC"` | IANA time zone used to format profile context. |
|
||||
| `capture.enabled` | `true` | Save completed turns automatically. |
|
||||
| `capture.taskType` | `"memory"` | Generate memories from conversations. Use `"superrag"` to index them for document retrieval only. |
|
||||
| `capture.dreaming` | `"dynamic"` | Memory generation mode: `"dynamic"` or `"instant"`. |
|
||||
| `capture.entityContext` | Built-in capture policy | Instructions for what durable information to learn from conversations. |
|
||||
| `capture.metadata` | `{}` | Additional metadata attached to captured conversation documents. |
|
||||
|
||||
Namespace, description, and scope are Eve memory-slot settings. Configure them on `defineMemory(...)`, outside the provider options.
|
||||
</Accordion>
|
||||
|
||||
## Manual installation
|
||||
|
||||
If you prefer to create the memory file yourself, install the package in your Eve project:
|
||||
|
||||
```bash
|
||||
npm install @supermemory/eve
|
||||
```
|
||||
|
||||
Then create the same memory slot that `eve add` generates:
|
||||
|
||||
```typescript agent/memory/supermemory.ts
|
||||
import supermemory from "@supermemory/eve";
|
||||
import { defineMemory } from "eve/memory";
|
||||
import { byPrincipal } from "eve/memory/scope";
|
||||
|
||||
export default defineMemory({
|
||||
description: "Recall and manage durable context for the current user.",
|
||||
provider: supermemory({
|
||||
apiKey: process.env.SUPERMEMORY_API_KEY!,
|
||||
}),
|
||||
scope: byPrincipal,
|
||||
});
|
||||
```
|
||||
|
||||
Set `SUPERMEMORY_API_KEY` in `.env.local` and start your agent as described in [Add Supermemory](#add-supermemory).
|
||||
|
||||
For implementation details, see the [provider repository](https://github.com/supermemoryai/eve-supermemory) and [Eve's Supermemory integration](https://eve.dev/integrations/supermemory).
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: "OpenCode"
|
||||
sidebarTitle: "OpenCode"
|
||||
description: "OpenCode Supermemory Plugin — persistent memory across coding sessions"
|
||||
icon: "/images/opencode-logo.png"
|
||||
icon: "/images/opencode-logo.svg"
|
||||
---
|
||||
|
||||
[OpenCode-Supermemory](https://github.com/supermemoryai/opencode-supermemory) is an OpenCode plugin that gives your AI persistent memory across sessions. Your agent remembers what you worked on — across sessions, across projects.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,16 @@
|
|||
.dark img[src*="openai.svg"],
|
||||
.dark img[src*="pipecat.svg"],
|
||||
.dark img[src*="eve.svg"],
|
||||
.dark img[src*="supermemory.svg"] {
|
||||
filter: invert(1);
|
||||
}
|
||||
|
||||
.dark img[src*="opencode-logo.svg"] {
|
||||
content: url("/images/opencode-logo-dark.svg");
|
||||
}
|
||||
|
||||
.eve-memory-video {
|
||||
display: block;
|
||||
width: 100%;
|
||||
border-radius: 0;
|
||||
}
|
||||
|
|
|
|||
BIN
apps/docs/videos/eve-memory.mp4
Normal file
BIN
apps/docs/videos/eve-memory.mp4
Normal file
Binary file not shown.
Loading…
Add table
Reference in a new issue