basher83
97d565e3cd
* feat: add mem-search skill with progressive disclosure architecture Add comprehensive mem-search skill for accessing claude-mem's persistent cross-session memory database. Implements progressive disclosure workflow and token-efficient search patterns. Features: - 12 search operations (observations, sessions, prompts, by-type, by-concept, by-file, timelines, etc.) - Progressive disclosure principles to minimize token usage - Anti-patterns documentation to guide LLM behavior - HTTP API integration for all search functionality - Common workflows with composition examples Structure: - SKILL.md: Entry point with temporal trigger patterns - principles/: Progressive disclosure + anti-patterns - operations/: 12 search operation files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: add CHANGELOG entry for mem-search skill Document mem-search skill addition in Unreleased section with: - 100% effectiveness compliance metrics - Comparison to previous search skill implementation - Progressive disclosure architecture details - Reference to audit report documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: add mem-search skill audit report Add comprehensive audit report validating mem-search skill against Anthropic's official skill-creator documentation. Report includes: - Effectiveness metrics comparison (search vs mem-search) - Critical issues analysis for production readiness - Compliance validation across 6 key dimensions - Reference implementation guidance Result: mem-search achieves 100% compliance vs search's 67% 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * feat: Add comprehensive search architecture analysis document - Document current state of dual search architectures (HTTP API and MCP) - Analyze HTTP endpoints and MCP search server architectures - Identify DRY violations across search implementations - Evaluate the use of curl as the optimal approach for search - Provide architectural recommendations for immediate and long-term improvements - Outline action plan for cleanup, feature parity, DRY refactoring * refactor: Remove deprecated search skill documentation and operations * refactor: Reorganize documentation into public and context directories Changes: - Created docs/public/ for Mintlify documentation (.mdx files) - Created docs/context/ for internal planning and implementation docs - Moved all .mdx files and assets to docs/public/ - Moved all internal .md files to docs/context/ - Added CLAUDE.md to both directories explaining their purpose - Updated docs.json paths to work with new structure Benefits: - Clear separation between user-facing and internal documentation - Easier to maintain Mintlify docs in dedicated directory - Internal context files organized separately 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Enhance session management and continuity in hooks - Updated new-hook.ts to clarify session_id threading and idempotent session creation. - Modified prompts.ts to require claudeSessionId for continuation prompts, ensuring session context is maintained. - Improved SessionStore.ts documentation on createSDKSession to emphasize idempotent behavior and session connection. - Refined SDKAgent.ts to detail continuation prompt logic and its reliance on session.claudeSessionId for unified session handling. --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Alex Newman <thedotmack@gmail.com>
114 lines
3.2 KiB
Plaintext
114 lines
3.2 KiB
Plaintext
---
|
|
title: "Installation"
|
|
description: "Install Claude-Mem plugin for persistent memory across sessions"
|
|
---
|
|
|
|
# Installation Guide
|
|
|
|
## Quick Start
|
|
|
|
Install Claude-Mem directly from the plugin marketplace:
|
|
|
|
```bash
|
|
/plugin marketplace add thedotmack/claude-mem
|
|
/plugin install claude-mem
|
|
```
|
|
|
|
That's it! The plugin will automatically:
|
|
- Download prebuilt binaries (no compilation needed)
|
|
- Install all dependencies (including PM2 and SQLite binaries)
|
|
- Configure hooks for session lifecycle management
|
|
- Set up the MCP search server
|
|
- Auto-start the worker service on first session
|
|
|
|
Start a new Claude Code session and you'll see context from previous sessions automatically loaded.
|
|
|
|
## System Requirements
|
|
|
|
- **Node.js**: 18.0.0 or higher
|
|
- **Claude Code**: Latest version with plugin support
|
|
- **PM2**: Process manager (bundled with plugin - no global install required)
|
|
- **SQLite 3**: For persistent storage (bundled)
|
|
|
|
## Advanced Installation
|
|
|
|
For development or testing, you can clone and build from source:
|
|
|
|
### Clone and Build
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://github.com/thedotmack/claude-mem.git
|
|
cd claude-mem
|
|
|
|
# Install dependencies
|
|
npm install
|
|
|
|
# Build hooks and worker service
|
|
npm run build
|
|
|
|
# Worker service will auto-start on first Claude Code session
|
|
# Or manually start with:
|
|
npm run worker:start
|
|
|
|
# Verify worker is running
|
|
npm run worker:status
|
|
```
|
|
|
|
### Post-Installation Verification
|
|
|
|
#### 1. Automatic Dependency Installation
|
|
|
|
Dependencies are installed automatically during plugin installation. The SessionStart hook also ensures dependencies are up-to-date on each session start (this is fast and idempotent). Works cross-platform on Windows, macOS, and Linux.
|
|
|
|
#### 2. Verify Plugin Installation
|
|
|
|
Check that hooks are configured in Claude Code:
|
|
```bash
|
|
cat plugin/hooks/hooks.json
|
|
```
|
|
|
|
#### 3. Data Directory Location
|
|
|
|
v4.0.0+ stores data in `${CLAUDE_PLUGIN_ROOT}/data/`:
|
|
- Database: `${CLAUDE_PLUGIN_ROOT}/data/claude-mem.db`
|
|
- Worker port file: `${CLAUDE_PLUGIN_ROOT}/data/worker.port`
|
|
- Logs: `${CLAUDE_PLUGIN_ROOT}/data/logs/`
|
|
|
|
For development/testing, you can override:
|
|
```bash
|
|
export CLAUDE_MEM_DATA_DIR=/custom/path
|
|
```
|
|
|
|
#### 4. Check Worker Logs
|
|
|
|
```bash
|
|
npm run worker:logs
|
|
```
|
|
|
|
#### 5. Test Context Retrieval
|
|
|
|
```bash
|
|
npm run test:context
|
|
```
|
|
|
|
## Upgrading from v3.x
|
|
|
|
**BREAKING CHANGES - Please Read:**
|
|
|
|
v4.0.0 introduces breaking changes:
|
|
|
|
- **Data Location Changed**: Database moved from `~/.claude-mem/` to `${CLAUDE_PLUGIN_ROOT}/data/` (inside plugin directory)
|
|
- **Fresh Start Required**: No automatic migration from v3.x. You must start with a clean database
|
|
- **Worker Auto-Starts**: Worker service now starts automatically - no manual `npm run worker:start` needed
|
|
- **MCP Search Server**: 7 new search tools with full-text search and citations
|
|
- **Enhanced Architecture**: Improved plugin integration and data organization
|
|
|
|
See [CHANGELOG](https://github.com/thedotmack/claude-mem/blob/main/CHANGELOG.md) for complete details.
|
|
|
|
## Next Steps
|
|
|
|
- [Getting Started Guide](usage/getting-started) - Learn how Claude-Mem works automatically
|
|
- [MCP Search Tools](usage/search-tools) - Query your project history
|
|
- [Configuration](configuration) - Customize Claude-Mem behavior
|