claude-mem 3.5.5 β†’ 3.5.7

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 CHANGED
@@ -1,238 +1,114 @@
1
- # Claude Memory System (claude-mem)
1
+ # 🧠 Claude Memory System (claude-mem)
2
2
 
3
- ## πŸ˜΅β€πŸ’« Remember that one thing? Neither do we. But claude-mem remembers.
3
+ ## Remember that one thing? Neither do we… but `claude-mem` does! πŸ˜΅β€πŸ’«
4
4
 
5
- Transform your Claude Code from a goldfish into an elephant. Every conversation, every breakthrough, every "aha!" moment - captured, compressed, and ready when you need it.
5
+ Stop repeating yourself. `claude-mem` remembers what you and Claude Code figure out, so every new chat starts smarter than the last.
6
6
 
7
- ## πŸ—‘οΈ Smart Trashβ„’ - Never Truly Lose Anything
7
+ ## ⚑️ 10‑Second Setup
8
8
 
9
- We pioneered Smart Trash because we know that moment of panic when you realize you deleted something important. With claude-mem:
10
- - **Deleted files go to trash, not oblivion** - Everything lands safely in `~/.claude-mem/trash/`
11
- - **30-day safety net** - Accidentally removed memories? They're still there
12
- - **One command restore** - `claude-mem restore` brings back what you need
13
- - **Timestamped recovery** - See exactly when files were deleted
14
- - **Selective restoration** - Pick specific files or restore everything
15
-
16
- ## πŸš€ Why Your Context Matters
17
-
18
- ### The Problem We Solve
19
- - **Lost Context**: Starting every Claude Code session from scratch
20
- - **Repeated Explanations**: Re-describing your codebase and architecture repeatedly
21
- - **Fragmented Knowledge**: Valuable insights scattered across hundreds of conversations
22
- - **Context Switching**: Losing progress when switching between projects or devices
23
- - **Knowledge Decay**: Brilliant solutions forgotten and re-discovered multiple times
24
-
25
- ### The Claude-Mem Difference
26
- Your context isn't just saved - it's **understood**. Every session builds on the last. Every problem solved becomes institutional knowledge. Every pattern recognized becomes a building block for the next breakthrough.
27
-
28
- ## ✨ Key Features
29
-
30
- ### 🧠 **Intelligent Memory Compression**
31
- - Automatically extracts key learnings from your Claude Code conversations
32
- - Identifies patterns, architectural decisions, and breakthrough moments
33
- - Compresses hours of conversation into searchable, actionable knowledge
34
- - Uses advanced AI analysis to understand context and significance
9
+ ```bash
10
+ npm install -g claude-mem && claude-mem install
11
+ ```
35
12
 
36
- ### πŸ”„ **Seamless Integration**
37
- - **One-command setup**: `claude-mem install` and you're ready
38
- - **Zero friction**: Works invisibly in the background
39
- - **Automatic triggers**: Memory compression on `/compact` and `/clear`
40
- - **Instant context loading**: New sessions start with relevant memories
13
+ That’s it. Restart Claude Code and you’re good. No config. No tedious setup or dependencies.
41
14
 
42
- ### 🎯 **Context That Actually Loads**
43
- - Your new sessions start where the last one left off
44
- - Project-aware memory selection - the right context for the right project
45
- - Semantic search that actually understands what you're looking for
46
- - No more "As I explained in our last conversation..." - Claude already knows
15
+ ## ✨ What You Get
47
16
 
48
- ### πŸ“š **Comprehensive Knowledge Base**
49
- - Stores technical implementations, bug fixes, and solutions
50
- - Captures design patterns and architectural decisions
51
- - Remembers tool configurations and setup procedures
52
- - Archives complete conversation transcripts for detailed reference
17
+ - Remembers key insights from your chats with Claude Code
18
+ - Starts new sessions with the right context
19
+ - Works quietly in the background
20
+ - One-command install and status check
21
+ - **🎭 Shakespeare's Memory Theatre**: Transform operations into theatrical magnificence!
53
22
 
54
- ### πŸ” **Powerful Search & Retrieval**
55
- - Vector-based semantic search finds related concepts
56
- - Keyword search for specific terms and technologies
57
- - Project filtering to focus on relevant memories
58
- - Time-based filtering to find recent insights
23
+ ## 🎭 NEW: Shakespeare's Memory Theatre
59
24
 
60
- ## πŸ›  Installation & Setup
25
+ *"All the world's a stage, And all memory merely players"*
61
26
 
62
- ### Prerequisites
63
- - Node.js 18+
64
- - Claude Code CLI installed
65
- - uv (Python package manager) - automatically installed if missing
27
+ Experience claude-mem operations as a dramatic performance! Choose from five theatrical acts:
66
28
 
67
- ### Quick Install
68
29
  ```bash
69
- # Install globally
70
- npm install -g claude-mem
71
-
72
- # Set up Claude Code integration (installs uv if needed)
73
- claude-mem install
74
-
75
- # Restart Claude Code to activate
30
+ claude-mem theatre # Full theatrical experience
31
+ claude-mem theatre --act I # Tragedy of Defensive Validation
32
+ claude-mem theatre --act II # Romeo and Chroma_Add
33
+ claude-mem compress-theatrical file # Compress with Shakespearean flair
34
+ claude-mem status-theatrical # Check status dramatically
76
35
  ```
77
36
 
78
- ### Alternative Installation
79
- ```bash
80
- # Use without installing globally
81
- npx claude-mem install
82
- ```
83
-
84
- The `claude-mem install` command will automatically install [uv](https://docs.astral.sh/uv/) if it's not already present on your system. uv is required for the Chroma MCP server that powers the memory system.
85
-
86
- ### Verification
87
- ```bash
88
- # Check installation status
89
- claude-mem status
90
- ```
37
+ **Interactive Features:**
38
+ - πŸŽͺ Choose dialogue responses
39
+ - πŸ… Throw tomatoes at bad code
40
+ - πŸ‘ Standing ovation meter
41
+ - πŸ“œ Soliloquy generator
42
+ - 🎺 Trumpet fanfares
91
43
 
92
- ## πŸ’» How It Works
44
+ [πŸ“– Full Shakespeare Theatre Documentation](docs/shakespeare-theatre.md)
93
45
 
94
- ### The Memory Lifecycle
46
+ ## πŸ—‘οΈ Smart Trashβ„’ (Your Panic Button)
95
47
 
96
- 1. **🎬 Session Start**: Claude-mem loads relevant context from your knowledge base
97
- 2. **πŸ’¬ Active Session**: You work normally in Claude Code - no changes needed
98
- 3. **πŸ—œοΈ Memory Compression**: Use `/compact` or `/clear` to trigger intelligent compression
99
- 4. **🧠 Knowledge Extraction**: AI analysis extracts key learnings and patterns
100
- 5. **πŸ’Ύ Persistent Storage**: Memories stored in searchable vector database
101
- 6. **πŸ”„ Context Ready**: Next session starts with relevant memories loaded
48
+ Delete something by accident? It’s not gone.
49
+ - Everything goes to `~/.claude-mem/trash/`
50
+ - Restore with a single command: `claude-mem restore`
51
+ - Timestamped so you can see when things moved
102
52
 
103
- ### Technical Architecture
53
+ ## 🎯 Why It’s Useful
104
54
 
105
- - **Vector Database**: ChromaDB for semantic search and storage
106
- - **MCP Integration**: Model Context Protocol for Claude Code communication
107
- - **AI Analysis**: Advanced prompt engineering for knowledge extraction
108
- - **Local Storage**: All data stored locally in `~/.claude-mem/`
55
+ - No more re-explaining your project over and over
56
+ - Pick up exactly where you left off
57
+ - Find past solutions fast when you face a familiar bug
58
+ - Your knowledge compounds the more you use it
109
59
 
110
- ## πŸ“‹ Commands Reference
60
+ ## 🧭 Minimal Commands You’ll Ever Need
111
61
 
112
- ### Core Commands
113
62
  ```bash
114
- claude-mem install # Set up Claude Code integration
115
- claude-mem status # Check system status and configuration
116
- claude-mem load-context # View and search stored memories
117
- claude-mem logs # View system logs and debug information
118
- claude-mem uninstall # Remove Claude Code hooks
63
+ claude-mem install # Set up/repair integration
64
+ claude-mem status # Check everything’s working
65
+ claude-mem load-context # Peek at what it remembers
66
+ claude-mem logs # If you’re curious
67
+ claude-mem uninstall # Remove hooks
68
+
69
+ # Extras
70
+ claude-mem trash-view # See what’s in Smart Trashβ„’
71
+ claude-mem restore # Restore deleted items
72
+ # 🎭 Shakespeare's Memory Theatre Commands
73
+ claude-mem theatre # Experience memory operations dramatically
74
+ claude-mem compress-theatrical file.jsonl # Theatrical compression
75
+ claude-mem status-theatrical # Dramatic status check
119
76
  ```
120
77
 
121
- ### Advanced Usage
122
- ```bash
123
- claude-mem compress <file> # Manually compress a transcript file
124
- claude-mem trash-view # View what's in Smart Trashβ„’
125
- claude-mem restore # Recover deleted memories from Smart Trashβ„’
126
- claude-mem restore <file> # Restore specific file from trash
127
- ```
128
-
129
- ## πŸ“ Storage Structure
130
-
131
- Your claude-mem data is organized in `~/.claude-mem/`:
78
+ ## πŸ“ Where Stuff Lives (super simple)
132
79
 
133
80
  ```
134
81
  ~/.claude-mem/
135
- β”œβ”€β”€ index/ # ChromaDB vector database
136
- β”œβ”€β”€ archives/ # Original conversation transcripts
137
- β”œβ”€β”€ hooks/ # Claude Code integration scripts
138
- β”œβ”€β”€ trash/ # Smart Trash (deleted files)
139
- └── logs/ # System logs and debug information
82
+ β”œβ”€β”€ index/ # memory index
83
+ β”œβ”€β”€ archives/ # transcripts
84
+ β”œβ”€β”€ hooks/ # integration bits
85
+ β”œβ”€β”€ trash/ # Smart Trashβ„’
86
+ └── logs/ # diagnostics
140
87
  ```
141
88
 
142
- ## 🌟 Real-World Impact
143
-
144
- ### Your Context Becomes Your Superpower
145
- - **Instant Recall**: That bug you fixed 3 weeks ago? The solution loads automatically
146
- - **Compounding Knowledge**: Every session makes you more effective than the last
147
- - **Context Continuity**: Switch between 10 projects without losing your place in any of them
148
- - **Pattern Mastery**: Claude recognizes when you're facing a familiar problem and brings the solution forward
149
-
150
- ### For Teams (Coming Soon)
151
- - **Shared Knowledge**: Team-wide memory accessible to all members
152
- - **Onboarding Acceleration**: New team members access collective knowledge
153
- - **Best Practices**: Capture and share proven solutions
154
- - **Institutional Memory**: Prevent knowledge loss when team members leave
89
+ ## βœ… Requirements
155
90
 
156
- ## πŸš€ Coming Soon: Cloud Sync
91
+ - Node.js 18+
92
+ - Claude Code
157
93
 
158
- ### Individual Plan ($9.95/month)
159
- - **Multi-device sync**: Access your memories on any device
160
- - **Cloud backup**: Never lose your knowledge base
161
- - **Enhanced search**: Advanced filtering and semantic search
162
- - **API access**: Integrate with your own tools and workflows
94
+ ## πŸ†˜ If Something’s Weird
163
95
 
164
- ### Team Plan ($29.95/month, 3+ seats)
165
- - **Shared memories**: Team-wide knowledge base
166
- - **Role-based access**: Control what memories are shared
167
- - **Admin dashboard**: Manage team members and usage
168
- - **Priority support**: Direct access to our engineering team
169
-
170
- [**Join the waitlist**](https://claude-mem.ai) for early access to cloud features.
171
-
172
- ## πŸ›‘οΈ Privacy & Security
173
-
174
- - **Local-first**: All data stored locally by default
175
- - **No tracking**: We don't collect or transmit your conversations
176
- - **Your data**: You own and control your knowledge base
177
- - **Open architecture**: ChromaDB and MCP are open standards
178
-
179
- ## πŸ†˜ Troubleshooting
180
-
181
- ### Common Issues
182
-
183
- **Hook not triggering?**
184
- ```bash
185
- claude-mem status # Check installation
186
- claude-mem install --force # Reinstall hooks
187
- ```
188
-
189
- **Context not loading?**
190
- ```bash
191
- claude-mem load-context # Verify memories exist
192
- claude-mem logs # Check for errors
193
- ```
194
-
195
- **Performance issues?**
196
96
  ```bash
197
- # ChromaDB maintenance (if needed)
198
- claude-mem status # Check memory usage
97
+ claude-mem status # quick health check
98
+ claude-mem install --force # fixes most issues
199
99
  ```
200
100
 
201
- ## πŸ”§ Requirements
202
-
203
- - **Node.js**: 18.0 or higher
204
- - **Claude Code**: Latest version recommended
205
- - **Storage**: ~100MB for typical usage
206
- - **Memory**: 2GB RAM minimum for large knowledge bases
207
-
208
- ## πŸ“ž Support & Community
209
-
210
- - **Documentation**: Complete guides at [claude-mem.ai/docs](https://claude-mem.ai/docs)
211
- - **Issues**: Report bugs at [GitHub Issues](https://github.com/thedotmack/claude-mem/issues)
212
- - **Feature Requests**: [GitHub Discussions](https://github.com/thedotmack/claude-mem/discussions)
213
- - **Community**: Join our [Discord](https://discord.gg/claude-mem) for tips and discussions
214
-
215
101
  ## πŸ“„ License
216
102
 
217
- This software is free to use but is NOT open source. See [LICENSE](LICENSE) file for complete terms.
103
+ This software is free to use but is NOT open source. See `LICENSE`.
218
104
 
219
105
  ---
220
106
 
221
- ## 🎯 Make Your Context Stand Out
107
+ ## Ready to remember more and repeat less?
222
108
 
223
109
  ```bash
224
110
  npm install -g claude-mem
225
111
  claude-mem install
226
112
  ```
227
113
 
228
- **Stop repeating yourself. Start building on what you've already taught Claude.**
229
-
230
- Your context is your competitive advantage. Every problem you've solved, every pattern you've discovered, every architectural decision you've made - it all compounds into a knowledge base that makes you exponentially more effective.
231
-
232
- With Smart Trashβ„’, you'll never lose important context again. With intelligent compression, your conversations become searchable wisdom. With semantic loading, Claude starts every session already understanding your project.
233
-
234
- **This is context that stands out.** 🧠✨
235
-
236
- ---
237
-
238
- *Built for developers who know their context is too valuable to lose.*
114
+ Your future self will thank you. 🧠✨