Tal Muskal
3d00a93655
- Introduced README.md for plugin overview and installation instructions. - Added hooks configuration in hooks.json for auto-save and pre-compact functionality. - Implemented stop and pre-compact hooks in bash scripts for memory management. - Created marketplace.json and plugin.json for plugin metadata and versioning. - Developed skills and instructions for help, init, mine, search, and status functionalities. - Added CLI commands for executing hooks and displaying skill instructions. - Implemented hooks_cli.py for handling hook logic and JSON input/output. - Enhanced instruction files for user guidance on setup and usage. - Updated .gitignore to exclude additional files. - Created GitHub Actions workflow for syncing plugin version on push.
61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
# MemPalace Claude Code Plugin
|
|
|
|
A Claude Code plugin that gives your AI a persistent memory system. Mine projects and conversations into a searchable palace backed by ChromaDB, with 19 MCP tools, auto-save hooks, and 5 guided skills.
|
|
|
|
## Prerequisites
|
|
|
|
- Python 3.9+
|
|
|
|
## Installation
|
|
|
|
### Claude Code Marketplace
|
|
|
|
```bash
|
|
claude plugin add mempalace
|
|
```
|
|
|
|
### Git
|
|
|
|
```bash
|
|
claude plugin add --git https://github.com/milla-jovovich/mempalace
|
|
```
|
|
|
|
### Local Clone
|
|
|
|
```bash
|
|
claude plugin add /path/to/mempalace
|
|
```
|
|
|
|
## Post-Install Setup
|
|
|
|
After installing the plugin, run the init command to complete setup (pip install, MCP configuration, etc.):
|
|
|
|
```
|
|
/mempalace:init
|
|
```
|
|
|
|
## Available Slash Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `/mempalace:help` | Show available tools, skills, and architecture |
|
|
| `/mempalace:init` | Set up MemPalace -- install, configure MCP, onboard |
|
|
| `/mempalace:search` | Search your memories across the palace |
|
|
| `/mempalace:mine` | Mine projects and conversations into the palace |
|
|
| `/mempalace:status` | Show palace overview -- wings, rooms, drawer counts |
|
|
|
|
## Hooks
|
|
|
|
MemPalace registers two hooks that run automatically:
|
|
|
|
- **Stop** -- Saves conversation context when a session ends.
|
|
- **PreCompact** -- Preserves important memories before context compaction.
|
|
|
|
## MCP Server
|
|
|
|
The plugin automatically configures a local MCP server with 19 tools for storing, searching, and managing memories. No manual MCP setup is required -- `/mempalace:init` handles everything.
|
|
|
|
## Full Documentation
|
|
|
|
See the main [README](../README.md) for complete documentation, architecture details, and advanced usage.
|