Igor Lins e Silva
c35686c9e1
End-user installs now lead with `uv tool install mempalace`, with `pip install mempalace` kept as a fallback. Dev/contributor docs lead with `uv sync --extra dev` and `uv run` for tests/benchmarks/lint, with the equivalent pip recipe kept inline. The shipped `/mempalace:init` skill instructions (mempalace/instructions/init.md) try `uv tool install` first when uv is on PATH, then fall back through the pip variants. Adds a .python-version pin at 3.12 because the lockfile's onnxruntime==1.24.3 only ships wheels for Python >=3.11; without the pin, `uv sync` on a host where uv prefers 3.10 fails with no source distribution available, which would make the documented command a footgun. pyproject's `requires-python = ">=3.9"` is unchanged — pip users on 3.9/3.10 are unaffected. Files updated: README.md, CONTRIBUTING.md, CLAUDE.md, the gemini-cli guide and example, the .claude-plugin / .codex-plugin READMEs, the mempalace SKILL, the openclaw SKILL, tools/save.md, the three benchmarks docs, and the corresponding website mirrors.
2.9 KiB
Getting Started
Installation
We recommend uv — uv tool install puts
the mempalace CLI in an isolated environment on your PATH:
uv tool install mempalace
If you prefer pip, pip install mempalace still works.
::: danger 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
git clone https://github.com/MemPalace/mempalace.git
cd mempalace
uv sync --extra dev # or: pip install -e ".[dev]"
Quick Start
Three steps: init, mine, search.
1. Initialize Your Palace
mempalace init requires a project directory to scan. Pass a path,
or . to use the current directory.
mempalace init ~/projects/myapp
# or, from inside the project:
mempalace init .
This scans your project directory and:
- Detects people and projects from file content
- Creates rooms from your folder structure
- Ensures the
~/.mempalace/config directory exists
2. Mine Your Data
# 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 generaloption for conversation mining that classifies content into decisions, preferences, milestones, problems, and emotional context
3. Search
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
- Mining Your Data — deep dive into mining modes
- MCP Integration — connect to Claude, ChatGPT, Cursor, Gemini
- The Palace — understand wings, rooms, halls, and tunnels