Skip to main content

LLM-Integrated Memory System with InsightJudge, HybridGraphSearch, and Branch-aware Storage

Project description

Greeum

PyPI version Python 3.10+ License: MIT

Persistent memory for AI agents — no more context loss between sessions.

Greeum is an open-source memory module that gives LLM agents long-term memory. Store memories on your own workstation, access them from anywhere, and never lose context again.

English · 한국어


Quick Start

# Install
pip install greeum

# Setup (interactive wizard)
greeum setup

# Test
greeum memory add "My first memory"
greeum memory search "first"

That's it. Greeum is ready to use with your MCP client.


Setup Modes

greeum setup provides three modes depending on your use case:

Local (default)

Store memories on this computer only.

greeum setup
# Select [1] Local

Server

Turn this computer into a Greeum server accessible from anywhere. Handles API key generation, Tailscale networking, and auto-start on boot.

greeum setup --server
[1/5] Data directory        ~/.greeum  ✓
[2/5] Embedding model       ready  ✓
[3/5] API server             port 8400, key generated  ✓
[4/5] Tailscale network     connected  ✓
[5/5] System service        auto-start enabled  ✓

Remote

Connect to an existing Greeum server — one command.

greeum setup --remote http://my-server:8400 --api-key grm_xxxxx

All MCP tools and CLI commands will use the remote server automatically.


MCP Integration

Once greeum setup is complete, connect your MCP client:

Claude Code

claude mcp add greeum -- greeum mcp serve -t stdio

Cursor

Add to MCP settings:

{
  "greeum": {
    "command": "greeum",
    "args": ["mcp", "serve", "-t", "stdio"]
  }
}

Codex

~/.codex/config.toml:

[mcp_servers.greeum]
command = "greeum"
args    = ["mcp", "serve", "-t", "stdio"]

Greeum MCP is supported on Linux, macOS, and WSL. On Windows, use WSL.


MCP Tools

Greeum provides these tools to your AI agent via MCP:

Tool Description
add_memory Store a memory with optional importance score
search_memory Semantic search across all memories
get_memory_stats View memory count, slots, and system health
usage_analytics Analyze usage patterns over time
system_doctor Run diagnostics and auto-repair
analyze Summarize recent activity and slot status

How agents use Greeum

  1. Search before starting work — retrieve relevant context
  2. Work on the task with full context
  3. Add a summary when done — preserve decisions and outcomes
{ "name": "search_memory", "arguments": { "query": "auth refactor", "limit": 5 } }
{ "name": "add_memory", "arguments": { "content": "Switched to JWT tokens for auth", "importance": 0.7 } }

CLI Reference

# Memory operations
greeum memory add "context to remember"
greeum memory add "important note" --importance 0.8
greeum memory search "keyword" --count 5

# Slot management
greeum slots status
greeum slots set A 123      # Pin memory #123 to slot A

# Server management
greeum config show           # View current configuration
greeum config mode local     # Switch to local mode
greeum config mode remote    # Switch to remote mode
greeum config test           # Test remote connection

# Maintenance
greeum doctor                # System diagnostics
greeum mcp warmup            # Pre-download embedding model

Architecture

┌─────────────────────────────────────────────┐
│               Your Workstation               │
│                                             │
│  greeum api serve (:8400)                   │
│  ├── Semantic Search (sentence-transformers)│
│  ├── STM Slots (A/B/C context anchors)     │
│  ├── Branch-aware LTM storage (SQLite)     │
│  └── API Key authentication                │
│                                             │
│  Accessible via Tailscale from anywhere     │
└─────────────────────────────────────────────┘
        ▲               ▲               ▲
        │               │               │
   Claude Code       Cursor          Codex
   (MCP/STDIO)     (MCP/STDIO)    (MCP/STDIO)

Documentation


License

MIT License — see LICENSE.

Greeum · Persistent memory for AI — built and maintained by the community.

Project details


Release history Release notifications | RSS feed

This version

5.2.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

greeum-5.2.1.tar.gz (472.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

greeum-5.2.1-py3-none-any.whl (522.1 kB view details)

Uploaded Python 3

File details

Details for the file greeum-5.2.1.tar.gz.

File metadata

  • Download URL: greeum-5.2.1.tar.gz
  • Upload date:
  • Size: 472.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for greeum-5.2.1.tar.gz
Algorithm Hash digest
SHA256 c851d43fa88ca173f3487701dcca013fda050f575da1d34b061615f42360a762
MD5 c4d4441725d835ed335c87775f7eeb13
BLAKE2b-256 a1f104b8e938a0ead662d70b76f1b950173739a94f399c00f9c2fe3c41fddfe7

See more details on using hashes here.

File details

Details for the file greeum-5.2.1-py3-none-any.whl.

File metadata

  • Download URL: greeum-5.2.1-py3-none-any.whl
  • Upload date:
  • Size: 522.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for greeum-5.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a129ca08758f76d6c589fe119fadbf081de6b11ea643eb4c49d8186643ae842b
MD5 3f547dfded900a9a979145c1670e466e
BLAKE2b-256 6488f7f3cad14577ec6f597250725672d297df0c281a7edc3a2e6e6daf377321

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page