Alex Newman
c6708b3684
Comprehensive documentation update with current features: - Updated "What's New" section to highlight v6.4.x features - Added privacy tags and context configuration to key features - Fixed default model (claude-haiku-4-5) - Clarified lifecycle hook count (5 events, 6 scripts) - Removed outdated MCP server references - Updated version numbers across all docs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
109 lines
5.7 KiB
Plaintext
109 lines
5.7 KiB
Plaintext
---
|
|
title: "Introduction"
|
|
description: "Persistent memory compression system for Claude Code"
|
|
---
|
|
|
|
# Claude-Mem
|
|
|
|
**Persistent memory compression system for Claude Code**
|
|
|
|
Claude-Mem seamlessly preserves context across sessions by automatically capturing tool usage observations, generating semantic summaries, and making them available to future sessions. This enables Claude to maintain continuity of knowledge about projects even after sessions end or reconnect.
|
|
|
|
## Quick Start
|
|
|
|
Start a new Claude Code session in the terminal and enter the following commands:
|
|
|
|
```bash
|
|
/plugin marketplace add thedotmack/claude-mem
|
|
/plugin install claude-mem
|
|
```
|
|
|
|
Restart Claude Code. Context from previous sessions will automatically appear in new sessions.
|
|
|
|
## Key Features
|
|
|
|
- 🧠 **Persistent Memory** - Context survives across sessions
|
|
- 🔍 **mem-search Skill** - Query your project history with natural language (~2,250 token savings)
|
|
- 🌐 **Web Viewer UI** - Real-time memory stream visualization at http://localhost:37777
|
|
- 🔒 **Privacy Control** - Use `<private>` tags to exclude sensitive content from storage
|
|
- ⚙️ **Context Configuration** - Fine-grained control over what context gets injected
|
|
- 🤖 **Automatic Operation** - No manual intervention required
|
|
- 📊 **FTS5 Search** - Fast full-text search across observations
|
|
- 🔗 **Citations** - Reference past decisions with `claude-mem://` URIs
|
|
|
|
## How It Works
|
|
|
|
```
|
|
┌─────────────────────────────────────────────────────────────┐
|
|
│ Session Start → Inject context from last 10 sessions │
|
|
└─────────────────────────────────────────────────────────────┘
|
|
↓
|
|
┌─────────────────────────────────────────────────────────────┐
|
|
│ User Prompts → Create session, save user prompts │
|
|
└─────────────────────────────────────────────────────────────┘
|
|
↓
|
|
┌─────────────────────────────────────────────────────────────┐
|
|
│ Tool Executions → Capture observations (Read, Write, etc.) │
|
|
└─────────────────────────────────────────────────────────────┘
|
|
↓
|
|
┌─────────────────────────────────────────────────────────────┐
|
|
│ Worker Processes → Extract learnings via Claude Agent SDK │
|
|
└─────────────────────────────────────────────────────────────┘
|
|
↓
|
|
┌─────────────────────────────────────────────────────────────┐
|
|
│ Session Ends → Generate summary, ready for next session │
|
|
└─────────────────────────────────────────────────────────────┘
|
|
```
|
|
|
|
**Core Components:**
|
|
1. **5 Lifecycle Hooks** - SessionStart, UserPromptSubmit, PostToolUse, Stop, SessionEnd (6 hook scripts)
|
|
2. **Smart Install** - Cached dependency checker (pre-hook script)
|
|
3. **Worker Service** - HTTP API on port 37777 managed by PM2
|
|
4. **SQLite Database** - Stores sessions, observations, summaries with FTS5 search
|
|
5. **mem-search Skill** - Query historical context with natural language
|
|
6. **Web Viewer UI** - Real-time visualization with SSE and infinite scroll
|
|
|
|
See [Architecture Overview](architecture/overview) for details.
|
|
|
|
## System Requirements
|
|
|
|
- **Node.js**: 18.0.0 or higher
|
|
- **Claude Code**: Latest version with plugin support
|
|
- **PM2**: Process manager (bundled - no global install required)
|
|
- **SQLite 3**: For persistent storage (bundled)
|
|
|
|
## What's New
|
|
|
|
**v6.4.9 - Context Configuration Settings:**
|
|
- 11 new settings for fine-grained control over context injection
|
|
- Configure token economics display, observation filtering by type/concept
|
|
|
|
**v6.4.0 - Dual-Tag Privacy System:**
|
|
- `<private>` tags for user-controlled privacy - wrap sensitive content to exclude from storage
|
|
- Edge processing ensures private content never reaches database
|
|
|
|
**v6.3.0 - Version Channel:**
|
|
- Switch between stable and beta versions from the web viewer UI
|
|
|
|
**Previous Highlights:**
|
|
- **v6.0.0**: Major session management & transcript processing improvements
|
|
- **v5.5.0**: mem-search skill enhancement with 100% effectiveness rate
|
|
- **v5.4.0**: Skill-based search architecture (~2,250 tokens saved per session)
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Installation" icon="download" href="/installation">
|
|
Quick start & advanced installation
|
|
</Card>
|
|
<Card title="Getting Started" icon="rocket" href="/usage/getting-started">
|
|
Learn how Claude-Mem works automatically
|
|
</Card>
|
|
<Card title="Architecture" icon="sitemap" href="/architecture/overview">
|
|
System components & data flow
|
|
</Card>
|
|
<Card title="Search Tools" icon="magnifying-glass" href="/usage/search-tools">
|
|
Query your project history
|
|
</Card>
|
|
</CardGroup>
|