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.
76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
# MemPalace - Codex CLI Plugin
|
|
|
|
Give your AI a persistent memory -- mine projects and conversations into a searchable palace backed by ChromaDB, with 19 MCP tools, auto-save hooks, and guided skills.
|
|
|
|
## Prerequisites
|
|
|
|
- Python 3.9+
|
|
- Codex CLI installed and configured
|
|
- `uv tool install mempalace` (recommended) or `pip install mempalace`
|
|
|
|
## Installation
|
|
|
|
### Local Install
|
|
|
|
1. Copy or symlink the `.codex-plugin` directory into your project root:
|
|
|
|
```bash
|
|
cp -r .codex-plugin /path/to/your/project/.codex-plugin
|
|
```
|
|
|
|
2. Verify the plugin is detected:
|
|
|
|
```bash
|
|
codex --plugins
|
|
```
|
|
|
|
3. Initialize your palace:
|
|
|
|
```bash
|
|
codex /init
|
|
```
|
|
|
|
### Git Install
|
|
|
|
1. Clone the MemPalace repository:
|
|
|
|
```bash
|
|
git clone https://github.com/MemPalace/mempalace.git
|
|
cd mempalace
|
|
```
|
|
|
|
2. Install the Python package (uv recommended):
|
|
|
|
```bash
|
|
uv sync # or: pip install -e .
|
|
```
|
|
|
|
3. The `.codex-plugin` directory is already in the repo root. Codex CLI will detect it automatically when you run Codex from inside the repository.
|
|
|
|
4. Initialize your palace:
|
|
|
|
```bash
|
|
codex /init
|
|
```
|
|
|
|
## Available Skills
|
|
|
|
| Skill | Description |
|
|
|-------|-------------|
|
|
| `/help` | Show available commands and usage tips |
|
|
| `/init` | Initialize a new memory palace |
|
|
| `/search` | Semantic search across all mined memories |
|
|
| `/mine` | Mine a project or conversation into your palace |
|
|
| `/status` | Show palace status, room counts, and health |
|
|
|
|
## Hooks
|
|
|
|
The plugin includes auto-save hooks that run on session stop (every 15 messages) and before context compaction, automatically preserving conversation context into your palace.
|
|
|
|
Set the `MEMPAL_DIR` environment variable to a directory path to automatically run `mempalace mine` on that directory during each save trigger.
|
|
|
|
## Support
|
|
|
|
- Repository: https://github.com/MemPalace/mempalace
|
|
- Issues: https://github.com/MemPalace/mempalace/issues
|