claude-mem 3.3.7 → 3.3.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +183 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,77 +2,214 @@
|
|
|
2
2
|
|
|
3
3
|
**Truth + Context = Clarity**
|
|
4
4
|
|
|
5
|
-
A
|
|
6
|
-
|
|
7
|
-
##
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
5
|
+
A revolutionary memory system that transforms your Claude Code conversations into a persistent, intelligent knowledge base. Never lose valuable insights, code patterns, or debugging solutions again. Your AI assistant finally has a memory that spans across all your projects and sessions.
|
|
6
|
+
|
|
7
|
+
## 🚀 Why Claude-Mem?
|
|
8
|
+
|
|
9
|
+
### The Problem We Solve
|
|
10
|
+
- **Lost Context**: Starting every Claude Code session from scratch
|
|
11
|
+
- **Repeated Explanations**: Re-describing your codebase and architecture repeatedly
|
|
12
|
+
- **Fragmented Knowledge**: Valuable insights scattered across hundreds of conversations
|
|
13
|
+
- **Context Switching**: Losing progress when switching between projects or devices
|
|
14
|
+
- **Knowledge Decay**: Brilliant solutions forgotten and re-discovered multiple times
|
|
15
|
+
|
|
16
|
+
### The Claude-Mem Solution
|
|
17
|
+
Transform your Claude Code experience from forgetful to persistent, from isolated sessions to connected knowledge, from starting over to building upon previous insights.
|
|
18
|
+
|
|
19
|
+
## ✨ Key Features
|
|
20
|
+
|
|
21
|
+
### 🧠 **Intelligent Memory Compression**
|
|
22
|
+
- Automatically extracts key learnings from your Claude Code conversations
|
|
23
|
+
- Identifies patterns, architectural decisions, and breakthrough moments
|
|
24
|
+
- Compresses hours of conversation into searchable, actionable knowledge
|
|
25
|
+
- Uses advanced AI analysis to understand context and significance
|
|
26
|
+
|
|
27
|
+
### 🔄 **Seamless Integration**
|
|
28
|
+
- **One-command setup**: `claude-mem install` and you're ready
|
|
29
|
+
- **Zero friction**: Works invisibly in the background
|
|
30
|
+
- **Automatic triggers**: Memory compression on `/compact` and `/clear`
|
|
31
|
+
- **Instant context loading**: New sessions start with relevant memories
|
|
32
|
+
|
|
33
|
+
### 🎯 **Smart Context Loading**
|
|
34
|
+
- Loads relevant memories when starting new sessions
|
|
35
|
+
- Project-aware context selection
|
|
36
|
+
- Semantic search finds related knowledge across all sessions
|
|
37
|
+
- Prevents re-explaining the same concepts repeatedly
|
|
38
|
+
|
|
39
|
+
### 📚 **Comprehensive Knowledge Base**
|
|
40
|
+
- Stores technical implementations, bug fixes, and solutions
|
|
41
|
+
- Captures design patterns and architectural decisions
|
|
42
|
+
- Remembers tool configurations and setup procedures
|
|
43
|
+
- Archives complete conversation transcripts for detailed reference
|
|
44
|
+
|
|
45
|
+
### 🔍 **Powerful Search & Retrieval**
|
|
46
|
+
- Vector-based semantic search finds related concepts
|
|
47
|
+
- Keyword search for specific terms and technologies
|
|
48
|
+
- Project filtering to focus on relevant memories
|
|
49
|
+
- Time-based filtering to find recent insights
|
|
50
|
+
|
|
51
|
+
## 🛠 Installation & Setup
|
|
52
|
+
|
|
53
|
+
### Quick Install
|
|
18
54
|
```bash
|
|
19
55
|
# Install globally
|
|
20
56
|
npm install -g claude-mem
|
|
21
57
|
|
|
22
|
-
#
|
|
58
|
+
# Set up Claude Code integration
|
|
59
|
+
claude-mem install
|
|
60
|
+
|
|
61
|
+
# Restart Claude Code to activate
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Alternative Installation
|
|
65
|
+
```bash
|
|
66
|
+
# Use without installing globally
|
|
23
67
|
npx claude-mem install
|
|
24
68
|
```
|
|
25
69
|
|
|
26
|
-
|
|
70
|
+
### Verification
|
|
71
|
+
```bash
|
|
72
|
+
# Check installation status
|
|
73
|
+
claude-mem status
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## 💻 How It Works
|
|
27
77
|
|
|
28
|
-
|
|
78
|
+
### The Memory Lifecycle
|
|
79
|
+
|
|
80
|
+
1. **🎬 Session Start**: Claude-mem loads relevant context from your knowledge base
|
|
81
|
+
2. **💬 Active Session**: You work normally in Claude Code - no changes needed
|
|
82
|
+
3. **🗜️ Memory Compression**: Use `/compact` or `/clear` to trigger intelligent compression
|
|
83
|
+
4. **🧠 Knowledge Extraction**: AI analysis extracts key learnings and patterns
|
|
84
|
+
5. **💾 Persistent Storage**: Memories stored in searchable vector database
|
|
85
|
+
6. **🔄 Context Ready**: Next session starts with relevant memories loaded
|
|
86
|
+
|
|
87
|
+
### Technical Architecture
|
|
88
|
+
|
|
89
|
+
- **Vector Database**: ChromaDB for semantic search and storage
|
|
90
|
+
- **MCP Integration**: Model Context Protocol for Claude Code communication
|
|
91
|
+
- **AI Analysis**: Advanced prompt engineering for knowledge extraction
|
|
92
|
+
- **Local Storage**: All data stored locally in `~/.claude-mem/`
|
|
93
|
+
|
|
94
|
+
## 📋 Commands Reference
|
|
95
|
+
|
|
96
|
+
### Core Commands
|
|
29
97
|
```bash
|
|
30
|
-
claude-mem install
|
|
98
|
+
claude-mem install # Set up Claude Code integration
|
|
99
|
+
claude-mem status # Check system status and configuration
|
|
100
|
+
claude-mem load-context # View and search stored memories
|
|
101
|
+
claude-mem logs # View system logs and debug information
|
|
102
|
+
claude-mem uninstall # Remove Claude Code hooks
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Advanced Usage
|
|
106
|
+
```bash
|
|
107
|
+
claude-mem compress <file> # Manually compress a transcript file
|
|
108
|
+
claude-mem restore # Restore from backups
|
|
109
|
+
claude-mem trash-view # View deleted files (Smart Trash feature)
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## 📁 Storage Structure
|
|
113
|
+
|
|
114
|
+
Your claude-mem data is organized in `~/.claude-mem/`:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
~/.claude-mem/
|
|
118
|
+
├── index/ # ChromaDB vector database
|
|
119
|
+
├── archives/ # Original conversation transcripts
|
|
120
|
+
├── hooks/ # Claude Code integration scripts
|
|
121
|
+
├── trash/ # Smart Trash (deleted files)
|
|
122
|
+
└── logs/ # System logs and debug information
|
|
31
123
|
```
|
|
32
124
|
|
|
33
|
-
|
|
125
|
+
## 🌟 Real-World Benefits
|
|
126
|
+
|
|
127
|
+
### For Individual Developers
|
|
128
|
+
- **Faster Problem Solving**: Find solutions you've used before instantly
|
|
129
|
+
- **Knowledge Accumulation**: Build expertise that persists across projects
|
|
130
|
+
- **Context Continuity**: Pick up where you left off, even weeks later
|
|
131
|
+
- **Pattern Recognition**: See how you've solved similar problems before
|
|
132
|
+
|
|
133
|
+
### For Teams (Coming Soon)
|
|
134
|
+
- **Shared Knowledge**: Team-wide memory accessible to all members
|
|
135
|
+
- **Onboarding Acceleration**: New team members access collective knowledge
|
|
136
|
+
- **Best Practices**: Capture and share proven solutions
|
|
137
|
+
- **Institutional Memory**: Prevent knowledge loss when team members leave
|
|
138
|
+
|
|
139
|
+
## 🚀 Coming Soon: Cloud Sync
|
|
34
140
|
|
|
35
|
-
|
|
141
|
+
### Individual Plan ($9.95/month)
|
|
142
|
+
- **Multi-device sync**: Access your memories on any device
|
|
143
|
+
- **Cloud backup**: Never lose your knowledge base
|
|
144
|
+
- **Enhanced search**: Advanced filtering and semantic search
|
|
145
|
+
- **API access**: Integrate with your own tools and workflows
|
|
36
146
|
|
|
37
|
-
|
|
147
|
+
### Team Plan ($29.95/month, 3+ seats)
|
|
148
|
+
- **Shared memories**: Team-wide knowledge base
|
|
149
|
+
- **Role-based access**: Control what memories are shared
|
|
150
|
+
- **Admin dashboard**: Manage team members and usage
|
|
151
|
+
- **Priority support**: Direct access to our engineering team
|
|
38
152
|
|
|
39
|
-
|
|
153
|
+
[**Join the waitlist**](https://claude-mem.ai) for early access to cloud features.
|
|
40
154
|
|
|
41
|
-
|
|
42
|
-
- `claude-mem status` - Check system status
|
|
43
|
-
- `claude-mem compress <transcript>` - Manually compress a transcript
|
|
44
|
-
- `claude-mem load-context` - View stored memories
|
|
45
|
-
- `claude-mem logs` - View system logs
|
|
46
|
-
- `claude-mem uninstall` - Remove Claude Code hooks
|
|
155
|
+
## 🛡️ Privacy & Security
|
|
47
156
|
|
|
48
|
-
|
|
157
|
+
- **Local-first**: All data stored locally by default
|
|
158
|
+
- **No tracking**: We don't collect or transmit your conversations
|
|
159
|
+
- **Your data**: You own and control your knowledge base
|
|
160
|
+
- **Open architecture**: ChromaDB and MCP are open standards
|
|
49
161
|
|
|
50
|
-
|
|
51
|
-
2. Entities (components, patterns, fixes, etc.) are extracted and stored
|
|
52
|
-
3. When you start a new Claude Code session, relevant context is automatically loaded
|
|
53
|
-
4. Your knowledge base grows smarter with each session
|
|
162
|
+
## 🆘 Troubleshooting
|
|
54
163
|
|
|
55
|
-
|
|
164
|
+
### Common Issues
|
|
56
165
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
-
|
|
166
|
+
**Hook not triggering?**
|
|
167
|
+
```bash
|
|
168
|
+
claude-mem status # Check installation
|
|
169
|
+
claude-mem install --force # Reinstall hooks
|
|
170
|
+
```
|
|
60
171
|
|
|
61
|
-
|
|
172
|
+
**Context not loading?**
|
|
173
|
+
```bash
|
|
174
|
+
claude-mem load-context # Verify memories exist
|
|
175
|
+
claude-mem logs # Check for errors
|
|
176
|
+
```
|
|
62
177
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
178
|
+
**Performance issues?**
|
|
179
|
+
```bash
|
|
180
|
+
# ChromaDB maintenance (if needed)
|
|
181
|
+
claude-mem status # Check memory usage
|
|
182
|
+
```
|
|
67
183
|
|
|
68
|
-
##
|
|
184
|
+
## 🔧 Requirements
|
|
69
185
|
|
|
70
|
-
|
|
186
|
+
- **Node.js**: 18.0 or higher
|
|
187
|
+
- **Claude Code**: Latest version recommended
|
|
188
|
+
- **Storage**: ~100MB for typical usage
|
|
189
|
+
- **Memory**: 2GB RAM minimum for large knowledge bases
|
|
71
190
|
|
|
72
|
-
## Support
|
|
191
|
+
## 📞 Support & Community
|
|
192
|
+
|
|
193
|
+
- **Documentation**: Complete guides at [claude-mem.ai/docs](https://claude-mem.ai/docs)
|
|
194
|
+
- **Issues**: Report bugs at [GitHub Issues](https://github.com/thedotmack/claude-mem/issues)
|
|
195
|
+
- **Feature Requests**: [GitHub Discussions](https://github.com/thedotmack/claude-mem/discussions)
|
|
196
|
+
- **Community**: Join our [Discord](https://discord.gg/claude-mem) for tips and discussions
|
|
197
|
+
|
|
198
|
+
## 📄 License
|
|
199
|
+
|
|
200
|
+
This software is free to use but is NOT open source. See [LICENSE](LICENSE) file for complete terms.
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## 🎯 Ready to Transform Your Claude Code Experience?
|
|
205
|
+
|
|
206
|
+
```bash
|
|
207
|
+
npm install -g claude-mem
|
|
208
|
+
claude-mem install
|
|
209
|
+
```
|
|
73
210
|
|
|
74
|
-
|
|
211
|
+
**Your AI assistant is about to get a lot smarter.** 🧠✨
|
|
75
212
|
|
|
76
213
|
---
|
|
77
214
|
|
|
78
|
-
*Built with ❤️ for
|
|
215
|
+
*Built with ❤️ for developers who believe AI assistants should remember and learn from every conversation.*
|