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.3

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.3.tar.gz (473.1 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.3-py3-none-any.whl (522.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: greeum-5.2.3.tar.gz
  • Upload date:
  • Size: 473.1 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.3.tar.gz
Algorithm Hash digest
SHA256 79f547cc266179c3329ed2683ba239c92c76a340c7eb92c7c5079a6d47e3a746
MD5 4b0fd82b930a77a9b1de26db8cc32370
BLAKE2b-256 667eada11f26e116ee721a6deef476643aca79ab300da5ba41fd7f5ee39f7b54

See more details on using hashes here.

File details

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

File metadata

  • Download URL: greeum-5.2.3-py3-none-any.whl
  • Upload date:
  • Size: 522.8 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 724468b790d9717f1c16f3346c47b58927bbe6f09c6567e90adc31e5d8abf742
MD5 640b41b36197ac7a9c07a2c125296edc
BLAKE2b-256 1bbfb54f32715fb6c2f75264712c4e9a397af44b5a1254be2e9f87ffd930f640

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