claude-mem README

The project's README from github.com/thedotmack/claude-mem. As one markdown file: README.md.


Grok Mem
Vercel OSS Program Greptile, code review partner SerpApi

Claude-Mem is now Grok Mem. The package is still claude-mem.

🇨🇳 中文 • 🇹🇼 繁體中文 • 🇯🇵 日本語 • 🇵🇹 Português • 🇧🇷 Português • 🇰🇷 한국어 • 🇪🇸 Español • 🇩🇪 Deutsch • 🇫🇷 Français • 🇮🇱 עברית • 🇸🇦 العربية • 🇷🇺 Русский • 🇵🇱 Polski • 🇨🇿 Čeština • 🇳🇱 Nederlands • 🇹🇷 Türkçe • 🇺🇦 Українська • 🇻🇳 Tiếng Việt • 🇵🇭 Tagalog • 🇮🇩 Indonesia • 🇹🇭 ไทย • 🇮🇳 हिन्दी • 🇧🇩 বাংলা • 🇵🇰 اردو • 🇷🇴 Română • 🇸🇪 Svenska • 🇮🇹 Italiano • 🇬🇷 Ελληνικά • 🇭🇺 Magyar • 🇫🇮 Suomi • 🇩🇰 Dansk • 🇳🇴 Norsk

Grok Mem is how Grok Bots remember. Sits next to Grok's own memory. Does not replace it.

Grok mem

License Version Node Mentioned in Awesome Claude Code

thedotmack/claude-mem | Trendshift


Claude-Mem Preview Star History Chart

Quick Start • How It Works • Search Tools • Documentation • Configuration • Troubleshooting • License

Grok Mem is how Grok Bots remember the work. Grok already remembers you. Grok Mem remembers what the bot did, what we decided, what to do next. Those notes come back in the next chat.

Quick Start

Install Grok Mem for Grok Bot. The package name is still claude-mem.

npx claude-mem install --ide grok-bot

Grok Bot has no host hooks, so we watch the chat log files. Default is CMEM Pro, the hosted memory. Local observer is opt-in: --provider host. Installing this plugin does not install Cursor.

Awareness push pilot (LFG + Orifice): needle observations (decision, bugfix, security_alert, sensitive) are appended as dated - YYYY-MM-DD [awareness] … lines into that bot's memory/log/YYYY-MM.md. Grok Bot already re-reads the log from disk. This does not write profile.md, user-memory, or project memory. Disable with CLAUDE_MEM_GROK_BOT_AWARENESS_ENABLED=false.

Install with a single command:

npx claude-mem install

The installer sets everything up first, then asks you to sign in to claude-mem in your browser (email magic link — no card required). Signing in provisions a memory key for your account and unlocks the claude-mem observer: memory that runs off-plan, free for your first 30 days, so you get up to 100% more usage from your plan. When the free trial ends, memory automatically falls back to your Anthropic plan unless you subscribe. After sign-in you pick your memory provider — the claude-mem observer, your own OpenRouter or Gemini key, or your Anthropic plan.

Prefer to skip the sign-in? Pass an explicit --provider flag, set CLAUDE_MEM_ONLINE_OPTIN=false, or run in CI/non-interactive shells — the installer completes without any account interaction.

Or install for OpenCode:

npx claude-mem install --ide opencode

Or install for Antigravity CLI (setup guide):

npx claude-mem install --ide antigravity

Or install from the plugin marketplace inside Claude Code:

/plugin marketplace add thedotmack/claude-mem

/plugin install claude-mem

Restart Claude Code. Context from previous sessions will automatically appear in new sessions.

Note: Claude-Mem is also published on npm, but npm install -g claude-mem installs the SDK/library only — it does not register the plugin hooks or set up the worker service. Always install via npx claude-mem install or the /plugin commands above.

🦞 OpenClaw Gateway

Install claude-mem as a persistent memory plugin on OpenClaw gateways with a single command:

curl -fsSL https://install.cmem.ai/openclaw.sh | bash

The installer handles dependencies, plugin setup, AI provider configuration, worker startup, and optional real-time observation feeds to Telegram, Discord, Slack, and more. See the OpenClaw Integration Guide for details.

Key Features:

Documentation

📚 View Full Documentation - Browse on official website

Getting Started

Best Practices

Architecture

Configuration & Development

How It Works

Core Components:

  1. 5 Lifecycle Hooks - SessionStart, UserPromptSubmit, PostToolUse, Stop, SessionEnd (6 hook scripts)
  2. Smart Install - Cached dependency checker (pre-hook script, not a lifecycle hook)
  3. Worker Service - Local HTTP API with web viewer UI and search endpoints, managed by Bun
  4. SQLite Database - Stores sessions, observations, summaries
  5. mem-search Skill - Natural language queries with progressive disclosure
  6. Chroma Vector Database - Hybrid semantic + keyword search for intelligent context retrieval

See Architecture Overview for details.

MCP Search Tools

Claude-Mem provides intelligent memory search through 4 MCP tools following a token-efficient 3-layer workflow pattern:

The 3-Layer Workflow:

  1. search - Get compact index with IDs (~50-100 tokens/result)
  2. timeline - Get chronological context around interesting results
  3. get_observations - Fetch full details ONLY for filtered IDs (~500-1,000 tokens/result)

How It Works:

Available MCP Tools:

  1. search - Search memory index with full-text queries, filters by type/date/project
  2. timeline - Get chronological context around a specific observation or query
  3. get_observations - Fetch full observation details by IDs (always batch multiple IDs)

Example Usage:

// Step 1: Search for index
search(query="authentication bug", type="bugfix", limit=10)

// Step 2: Review index, identify relevant IDs (e.g., #123, #456)

// Step 3: Fetch full details
get_observations(ids=[123, 456])

See Search Tools Guide for detailed examples.

Release Branches

Stable releases ship from main and are published to npm. core-dev and community-edge are source-run branches for early reliability fixes and community integrations. See Release Branches for the branch flow and non-stable run instructions.

System Requirements

Windows Setup Notes

If you see an error like:

npm : The term 'npm' is not recognized as the name of a cmdlet

Make sure Node.js and npm are installed and added to your PATH. Download the latest Node.js installer from https://nodejs.org and restart your terminal after installation.

Configuration

Settings are managed in ~/.claude-mem/settings.json (auto-created with defaults on first run). Configure AI model, worker port, data directory, log level, and context injection settings.

See the Configuration Guide for all available settings and examples.

Mode & Language Configuration

Claude-Mem supports multiple workflow modes and languages via the CLAUDE_MEM_MODE setting.

This option controls both:

How to Configure

Edit your settings file at ~/.claude-mem/settings.json:

{
  "CLAUDE_MEM_MODE": "code--zh"
}

Modes are defined in plugin/modes/. To see all available modes locally:

ls ~/.claude/plugins/marketplaces/thedotmack/plugin/modes/

Available Modes

Mode Description
code Default English mode
code--zh Simplified Chinese mode
code--ja Japanese mode

Language-specific modes follow the pattern code--[lang] where [lang] is the ISO 639-1 language code (e.g., zh for Chinese, ja for Japanese, es for Spanish).

Note: code--zh (Simplified Chinese) is already built-in — no additional installation or plugin update is required.

After Changing Mode

Restart Claude Code to apply the new mode configuration.

Development

See the Development Guide for build instructions, testing, and contribution workflow.

Troubleshooting

If experiencing issues, describe the problem to Claude and the troubleshoot skill will automatically diagnose and provide fixes.

See the Troubleshooting Guide for common issues and solutions.

Bug Reports

Create comprehensive bug reports with the automated generator:

cd ~/.claude/plugins/marketplaces/thedotmack
npm run bug-report

Contributing

Contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes with tests
  4. Update documentation
  5. Submit a Pull Request

Claude-Mem ships from three branches: main (stable), core-dev, and community-edge. Only main is published to npm; the others are run from source. See Release Branches for the strategy and local run instructions.

See Development Guide for contribution workflow.

License

Claude-Mem is licensed under the Apache License 2.0.

We chose Apache-2.0 because durable agentic memory should be easy to embed in developer tools, local agents, MCP servers, enterprise systems, robotics stacks, and production agent harnesses.

See the LICENSE file for full details. See docs/license.md and docs/ip-boundary.md for licensing scope and the open/commercial boundary.

Note on Ragtime: The ragtime/ directory is licensed under the Apache License 2.0. See ragtime/LICENSE for details.

Support

Built with Claude Agent SDK | Works with Claude Code | Made with TypeScript

What About CMEM?

CMEM is a token created by a 3rd party but officially embraced by the creator of Claude-Mem (Alex Newman, @thedotmack). The token acts as a community catalyst for growth and a vehicle for bringing CMEM to the developers and knowledge workers that need it most.

Official BASE CA: 0x76b1967eec0ccaeb001bbbb2b40dc4badba31ba3

claude-mem (thedotmack/claude-mem)

Searching Database…

101.6K ·GitHub
Claude-mem
Что это такое?Claude-Mem даёт агентам для программирования постоянную память между сессиями: он фиксирует всё, что делает ваш агент, сжимает это с помощью ИИ и возвращает нужный контекст в будущие сессии.
Это отдельное приложение или плагин для моего агента?Это система плагинов и воркеров, которая подключается к жизненному циклу вашего агента (начало сессии, отправка промпта, использование инструментов, завершение сессии) и в фоне запускает локальный воркер-сервис с SQLite и векторной базой данных Chroma.
Что мне нужно запустить на компьютере, чтобы это работало?Нужны Node.js 20+ и Claude Code (или другой поддерживаемый агент) с поддержкой плагинов; Bun и uv устанавливаются автоматически, если их нет, а SQLite 3 уже встроен.
Стоит ли что-то бесплатный облачный сервис памяти?После входа в аккаунт облачная память «claude-mem observer» становится доступна бесплатно первые 30 дней; после окончания пробного периода она переключается на использование вашего тарифного плана Anthropic, если вы не оформите подписку.
Какие агенты для программирования оно поддерживает?Оно работает с Claude Code, OpenClaw, Codex, Gemini, Hermes, Copilot, OpenCode и другими агентами, а для OpenCode, Antigravity CLI и шлюзов OpenClaw есть отдельные способы установки.
Работает ли это на Windows, а не только на Mac/Linux?Да, оно кроссплатформенное; в README даже есть заметки по настройке для Windows о добавлении Node.js/npm в PATH.
Нужен ли постоянно запущенный демон для синхронизации памяти?Демон не нужен: при использовании Cloud Sync воркер-процесс синхронизирует память с облаком в момент записи.
Можно ли хранить данные памяти полностью локально, без облачного сервиса?Да: локальный режим наблюдателя включается по выбору флагом --provider host, а вместо облачного сервиса CMEM Pro можно использовать свой ключ OpenRouter или Gemini либо свой тарифный план Anthropic.
Как на самом деле устроен поиск по памяти?Claude-Mem предоставляет 4 инструмента MCP (search, timeline, getObservations и рабочий процесс index) по трёхуровневой схеме, экономящей токены: search возвращает компактный индекс (~50–100 токенов на результат), timeline даёт хронологический контекст, а getObservations загружает полные данные только для отобранных ID, экономя примерно в 10 раз токены по сравнению с загрузкой всего подряд.
Можно ли исключить из сохранения конфиденциальные данные?Да, функция Privacy Control позволяет помечать тегами конфиденциальное содержимое, чтобы оно не сохранялось в памяти.
Что за токен CMEM, упомянутый в README?CMEM — токен сообщества, который поддерживает создатель проекта, но не выпускал его; он служит катализатором роста сообщества и не связан с самим открытым программным обеспечением.
Есть ли интерфейс, чтобы посмотреть, что запомнил агент?Да: веб-просмотрщик (Web Viewer) показывает поток памяти в реальном времени по адресу воркера, который выводится при запуске, а также есть навык (skill) для Claude Desktop для поиска по памяти из разговоров на десктопе.
What are similar projects?LongMemory, jevmem, ruflo, mem0, EverOS, brigade, nautilus-compass, supermemory
Which topics is it in?claude-agent-sdk, chromadb, memory-engine, ai-memory, mcp-client, long-term-memory, claude-code-plugin, vector-database, embeddings, claude-skills, agent-memory, model-context-protocol
Creator
thedotmack
Size
595.2 MB
Stars
101.6K
Updated
CommitOct 17Releasev14.0.1Oct 17
Age
1y
Commits · 90 Days