Skip to content

Getting Started

Installation

Install MemPalace from PyPI:

bash
pip install mempalace

Security Warning

The domain mempalace.tech is a brand-squatting site not affiliated with this project. It is known to run ad-redirects and potential malware. The official MemPalace distribution is only available via this GitHub repository and PyPI. Never install binaries or scripts from unofficial domains.

Requirements

  • Python 3.9+
  • chromadb>=0.5.0 (installed automatically)
  • pyyaml>=6.0 (installed automatically)

No API key required for the core local workflow. After installation, the main storage and retrieval path runs locally.

From Source

bash
git clone https://github.com/milla-jovovich/mempalace.git
cd mempalace
pip install -e ".[dev]"

Quick Start

Three steps: init, mine, search.

1. Initialize Your Palace

bash
mempalace init ~/projects/myapp

This scans your project directory and:

  • Detects people and projects from file content
  • Creates rooms from your folder structure
  • Sets up ~/.mempalace/ config directory

2. Mine Your Data

bash
# Mine project files (code, docs, notes)
mempalace mine ~/projects/myapp

# Mine conversation exports (Claude, ChatGPT, Slack)
mempalace mine ~/chats/ --mode convos

# Mine with auto-classification into memory types
mempalace mine ~/chats/ --mode convos --extract general

Two mining modes plus one extraction strategy:

  • projects — code and docs, auto-detected rooms
  • convos — conversation exports, chunked by exchange pair
  • general extraction — an --extract general option for conversation mining that classifies content into decisions, preferences, milestones, problems, and emotional context
bash
mempalace search "why did we switch to GraphQL"

That gives you a working local memory index.

What Happens Next

After the one-time setup, you don't run MemPalace commands manually. Your AI uses it for you through MCP integration or a Claude Code plugin.

Ask your AI anything:

"What did we decide about auth last month?"

It calls mempalace_search automatically, gets verbatim results, and answers you. You never type mempalace search again.

Next Steps

Released under the MIT License.