@contextmirror/claude-memory 0.4.0 → 0.4.1
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 +76 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,18 +9,27 @@ Every Claude Code session starts fresh. Switch to a different project folder and
|
|
|
9
9
|
## The Solution
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
npm install -g claude-memory
|
|
12
|
+
npm install -g @contextmirror/claude-memory
|
|
13
13
|
claude-memory scan ~/Projects
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
Now Claude knows about all your projects. Ask "What other projects do I have?" or "Generate a CLAUDE.md for this project" and Claude just knows.
|
|
17
17
|
|
|
18
|
+
## Features
|
|
19
|
+
|
|
20
|
+
- **Cross-project awareness** - Claude knows about all your projects
|
|
21
|
+
- **Staleness detection** - Automatically detects when projects need rescanning
|
|
22
|
+
- **Quick scans** - Only rescan projects that have changed
|
|
23
|
+
- **Update notifications** - Get notified when new versions are available
|
|
24
|
+
- **CLAUDE.md generation** - Auto-generate project documentation
|
|
25
|
+
- **MCP integration** - Works seamlessly with Claude Code
|
|
26
|
+
|
|
18
27
|
## Quick Start
|
|
19
28
|
|
|
20
29
|
### 1. Install
|
|
21
30
|
|
|
22
31
|
```bash
|
|
23
|
-
npm install -g claude-memory
|
|
32
|
+
npm install -g @contextmirror/claude-memory
|
|
24
33
|
```
|
|
25
34
|
|
|
26
35
|
### 2. Scan your projects
|
|
@@ -53,11 +62,39 @@ Now Claude has access to your project memory!
|
|
|
53
62
|
| Command | Description |
|
|
54
63
|
|---------|-------------|
|
|
55
64
|
| `claude-memory scan [dir]` | Scan directory for projects |
|
|
65
|
+
| `claude-memory scan --quick` | Only rescan stale projects (faster) |
|
|
66
|
+
| `claude-memory scan --check` | Check what's stale without scanning |
|
|
56
67
|
| `claude-memory list` | List known projects |
|
|
57
68
|
| `claude-memory show <project>` | Show project details |
|
|
69
|
+
| `claude-memory briefing [dir]` | Generate CLAUDE.md for a project |
|
|
58
70
|
| `claude-memory init` | Generate CLAUDE.md for current project |
|
|
59
|
-
| `claude-memory
|
|
71
|
+
| `claude-memory exclude <project>` | Exclude project from future scans |
|
|
72
|
+
| `claude-memory include <project>` | Re-include an excluded project |
|
|
60
73
|
| `claude-memory mcp` | Start MCP server |
|
|
74
|
+
| `claude-memory setup` | Interactive setup wizard |
|
|
75
|
+
|
|
76
|
+
## Staleness Detection
|
|
77
|
+
|
|
78
|
+
claude-memory automatically detects when your projects need rescanning:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
# Check what's stale
|
|
82
|
+
claude-memory scan --check
|
|
83
|
+
|
|
84
|
+
# Output:
|
|
85
|
+
# 🧠 Claude Memory - Staleness Check
|
|
86
|
+
#
|
|
87
|
+
# ⚠️ 2 project(s) need updating:
|
|
88
|
+
# 📝 my-project (New commits since last scan)
|
|
89
|
+
# 📄 another-project (Key files modified since last scan)
|
|
90
|
+
#
|
|
91
|
+
# Run `claude-memory scan --quick` to refresh only stale projects.
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**Detection methods:**
|
|
95
|
+
- **Git activity** - New commits since last scan
|
|
96
|
+
- **File changes** - package.json, CLAUDE.md, etc. modified
|
|
97
|
+
- **Age** - Projects not scanned in 7+ days
|
|
61
98
|
|
|
62
99
|
## MCP Tools
|
|
63
100
|
|
|
@@ -65,11 +102,25 @@ When connected, Claude Code gets these tools:
|
|
|
65
102
|
|
|
66
103
|
| Tool | Purpose |
|
|
67
104
|
|------|---------|
|
|
68
|
-
| `get_global_context` | Overview of all your projects |
|
|
105
|
+
| `get_global_context` | Overview of all your projects + staleness info |
|
|
69
106
|
| `get_project_summary` | Details about a specific project |
|
|
70
107
|
| `get_project_analysis` | Deep analysis for CLAUDE.md generation |
|
|
71
108
|
| `search_projects` | Search across all projects |
|
|
72
109
|
| `record_insight` | Save cross-project patterns |
|
|
110
|
+
| `search_code` | **[Pro]** Search code across all projects |
|
|
111
|
+
|
|
112
|
+
## Update Notifications
|
|
113
|
+
|
|
114
|
+
claude-memory checks for updates automatically (once per day, cached). When a new version is available, Claude will see:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
⬆️ Update available: v0.3.0 → v0.4.0
|
|
118
|
+
|
|
119
|
+
Run to update:
|
|
120
|
+
npm update -g @contextmirror/claude-memory
|
|
121
|
+
|
|
122
|
+
After updating, restart Claude Code to use the new version.
|
|
123
|
+
```
|
|
73
124
|
|
|
74
125
|
## How It Works
|
|
75
126
|
|
|
@@ -77,15 +128,17 @@ When connected, Claude Code gets these tools:
|
|
|
77
128
|
2. **Extract** - Pulls name, description, tech stack, git info, CLAUDE.md content
|
|
78
129
|
3. **Store** - Saves to `~/.claude-memory/context.json`
|
|
79
130
|
4. **Serve** - MCP server exposes context to Claude Code
|
|
131
|
+
5. **Detect** - Monitors for staleness on each session start
|
|
80
132
|
|
|
81
133
|
## Example Usage
|
|
82
134
|
|
|
83
135
|
Once set up, you can ask Claude:
|
|
84
136
|
|
|
85
137
|
- "What other projects do I have?"
|
|
86
|
-
- "Tell me about my
|
|
138
|
+
- "Tell me about my project X"
|
|
87
139
|
- "Generate a CLAUDE.md for this project"
|
|
88
140
|
- "Which of my projects use React?"
|
|
141
|
+
- "Is my project data up to date?"
|
|
89
142
|
|
|
90
143
|
Claude will query your project memory and respond with real context.
|
|
91
144
|
|
|
@@ -96,9 +149,22 @@ All data stays local:
|
|
|
96
149
|
```
|
|
97
150
|
~/.claude-memory/
|
|
98
151
|
├── context.json # Project metadata
|
|
99
|
-
|
|
152
|
+
├── context.json.bak # Backup
|
|
153
|
+
├── global-context.md # Human-readable overview
|
|
154
|
+
├── config.json # User configuration
|
|
155
|
+
├── update-check.json # Update check cache
|
|
156
|
+
└── license.json # Pro license (if activated)
|
|
100
157
|
```
|
|
101
158
|
|
|
159
|
+
## Pro Features
|
|
160
|
+
|
|
161
|
+
Activate with `claude-memory activate <key>`. Get a license at https://claude-memory.dev
|
|
162
|
+
|
|
163
|
+
| Feature | Description |
|
|
164
|
+
|---------|-------------|
|
|
165
|
+
| Cross-project code search | Search code patterns across all your projects |
|
|
166
|
+
| Semantic search | Search by meaning, not just keywords (coming soon) |
|
|
167
|
+
|
|
102
168
|
## License
|
|
103
169
|
|
|
104
170
|
MIT
|
|
@@ -106,3 +172,7 @@ MIT
|
|
|
106
172
|
## Author
|
|
107
173
|
|
|
108
174
|
Nathan (with Claude as co-developer)
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
*Part of the [Context Mirror](https://github.com/contextmirror) project*
|