Skip to main content

Universal memory module for LLMs with enhanced MCP integration

Project description

Greeum

PyPI version Python 3.10+ License: MIT

AI conversations that remember everything. No more repeating context every time.

⚡ Quick Start

# Install
pip install greeum

# Add your first memory
greeum memory add "Started working on the new dashboard project"

# Set memory anchors for quick access
greeum anchors set A 123  # Pin important memory to slot A

# Search with anchor-based localization
greeum memory search "dashboard project" --slot A --radius 2

That's it. Your AI now remembers.

✨ What It Does

🧠 Remembers context - AI recalls previous conversations and decisions ⚡ 280x faster search - Checkpoint-based memory retrieval 🔄 Works with any AI - GPT, Claude, or your custom model 🛡️ Your data stays yours - Local storage, no cloud required

🔧 Installation

Basic Setup

pip install greeum

With All Features

pip install greeum[all]  # includes vector search, embeddings

For Claude Code Users

# Install and start MCP server
pip install greeum
greeum mcp serve

📝 Usage

Adding Memories

# Add important context
greeum memory add "Client prefers minimal UI design"

# Add with expiration
greeum stm add "Working on login page today" --ttl 24h

Memory Anchors (v2.2.5+)

# View current anchor status
greeum anchors status

# Set anchors for quick access
greeum anchors set A 123     # Pin memory #123 to slot A
greeum anchors set B 456     # Pin memory #456 to slot B

# Search near anchored memories
greeum memory search "UI design" --slot A --radius 3

# Pin/unpin anchors
greeum anchors pin A         # Prevent auto-movement
greeum anchors unpin A       # Allow auto-movement

# Clear all anchors
greeum anchors clear

Searching

# Find relevant memories
greeum memory search "UI design preferences" --count 5

# Anchor-based localized search (faster)
greeum memory search "login" --slot B --radius 2 --fallback

# Global search (traditional)
greeum memory search "login" --count 10

Python API

from greeum import BlockManager, DatabaseManager

# Initialize
db_manager = DatabaseManager()
memory = BlockManager(db_manager)

# Add block to long-term memory
block = memory.add_block(
    context="User wants dark mode toggle",
    keywords=["dark", "mode", "toggle"],
    tags=["ui", "preference"],
    embedding=[],  # Auto-generated if empty
    importance=0.7
)

# Search memories
results = memory.search_memories("dark mode", limit=3)

🤖 Claude Integration

pip install greeum

Add to Claude Desktop config:

{
  "mcpServers": {
    "greeum": {
      "command": "greeum",
      "args": ["mcp", "serve"]
    }
  }
}

Restart Claude Desktop. Done.

Config file location:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/claude-desktop/claude_desktop_config.json

Available Tools

  • add_memory - Store important context
  • search_memory - Find relevant memories
  • get_memory_stats - View memory statistics

Need help?Complete setup guide | Troubleshooting

📚 Documentation

🏗️ Architecture

Your Input → Working Memory → Cache → Checkpoints → Long-term Storage
             0.04ms          0.08ms   0.7ms        Permanent

Four-layer memory system optimized for speed and relevance.

📋 Version Updates

v2.1.1 (2025-08)

  • Enhanced search with temporal boost for recent information prioritization
  • Optimized codebase with 955 lines of code reduction and improved test architecture
  • Resolved import dependencies and improved memory management
  • Added intelligent date keyword detection for search result ranking
  • Improved test stability with BaseGreeumTestCase standardization
  • Performance optimizations with minimal overhead (+1.0%)

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Submit a pull request

See CONTRIBUTING.md for details.

📄 License

MIT License - see LICENSE file.


Greeum - Memory for AI that actually works. Made with ❤️ by the open source community.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

greeum-2.2.7.tar.gz (239.4 kB view details)

Uploaded Source

Built Distribution

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

greeum-2.2.7-py3-none-any.whl (204.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: greeum-2.2.7.tar.gz
  • Upload date:
  • Size: 239.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for greeum-2.2.7.tar.gz
Algorithm Hash digest
SHA256 cf622ead877da58ff75b653233aee22d0d2e3da43e1c263fb70788f274c57d85
MD5 14472ee3f47263e54357f1990fbe8741
BLAKE2b-256 fdb99662350bba84d6c481865e4f231371fb2b089070ea869248bf60c0f06a98

See more details on using hashes here.

File details

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

File metadata

  • Download URL: greeum-2.2.7-py3-none-any.whl
  • Upload date:
  • Size: 204.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for greeum-2.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 db3cdd8e3b277ce8da18dd6f2c6e3bbfb7feb2214aa84ce5120b8d267dcdd67d
MD5 eeb67c623a9ec3643384e82b9bf7ae20
BLAKE2b-256 47b77f47caf6a72be29c97795ee36956cce3dec7f57ace40ab751d87ba03ef54

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