supermemory: Instructions file for Claude Code

AGENTS.md

Context for AI coding agents (Claude Code, Cursor, Codex, OpenCode, Copilot and others) working with supermemory.

supermemory is a memory engine for AI agents: a memory graph that updates and forgets facts, user profiles, and retrieval over your documents, through one API. Documentation · Docs index for agents · Console and API keys

Two jobs, two sections:

• Adding supermemory to another project? Read Use supermemory in an app.
• Changing code in this repository? Read Work in this repository.

Use supermemory in an app

Start here

• Check the docs index or the docs MCP (below) before writing any endpoint.
• npx supermemory setup --prompt prints the integration prompt for the current project. Plain npx supermemory setup launches a separate coding agent, so use --prompt when you are already an agent.
• npx supermemory help --json lists every CLI command in a machine-readable form.
• The official skill teaches the current (v5) API surface:

npx skills add https://github.com/supermemoryai/skills --skill supermemory

Install and first calls

Set SUPERMEMORY_API_KEY (create a key in the console), then install SDK version 5 or later:

npm i supermemory           # TypeScript / JavaScript
pip install -U supermemory  # Python (3.10 or later)

Every memory call (add, search, profile, list, documents) takes a namespace first: one user, workspace or tenant.

import { Supermemory } from "supermemory";

const supermemory = new Supermemory({ apiKey: process.env.SUPERMEMORY_API_KEY });

await supermemory.add("user_123", {
  content: "User prefers TypeScript",
  dreaming: "instant", // processed right away (one extra operation per document); the default "dynamic" batches extraction
});

const { results } = await supermemory.search("user_123", { query: "language preference" });
const { profile } = await supermemory.profile("user_123");