Igor Lins e Silva
c08ec00f4d
- mempalace/instructions/init.md: only skip Step 4 when `mempalace --version` succeeds. `pip show` / `uv tool list` reporting an install is not enough -- if the package lives in an unactivated venv, Step 5 (`mempalace init ...`) fails with command-not-found. Treat that case as not-installed and re-install via Step 3 into a PATH-visible location. - .codex-plugin/README.md: switch the git-install recipe from `uv sync` to `uv tool install --editable .` so the bundled `plugin.json` (which invokes `mempalace-mcp` by bare name) can launch the MCP server. Plain `uv sync` only puts the script in `.venv/bin/`, which Codex won't find unless the venv is activated first.
81 lines
2.1 KiB
Markdown
81 lines
2.1 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 so the `mempalace-mcp` script lands on
|
|
your PATH (the bundled `plugin.json` invokes it by bare name):
|
|
|
|
```bash
|
|
uv tool install --editable . # or: pip install -e .
|
|
```
|
|
|
|
Plain `uv sync` is **not** enough here — it installs the scripts into
|
|
`.venv/bin/`, which Codex will not find unless you activate the venv
|
|
before launching Codex.
|
|
|
|
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
|