eagle-mem 2.0.3 → 2.0.5

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.
Files changed (2) hide show
  1. package/README.md +103 -67
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -9,70 +9,136 @@ Persistent memory for [Claude Code](https://docs.anthropic.com/en/docs/claude-co
9
9
 
10
10
  **Zero per-instance overhead.** No daemon, no vector DB, no MCP server. Just bash scripts, sqlite3, and jq.
11
11
 
12
- ## Install
12
+ ## Getting started
13
+
14
+ **1. Install** (once — this is the only setup step):
13
15
 
14
16
  ```bash
15
17
  npm install -g eagle-mem
16
18
  eagle-mem install
17
19
  ```
18
20
 
19
- That's it. Eagle Mem registers 5 lifecycle hooks in Claude Code and is fully automatic from here.
20
-
21
- ## New project
22
-
23
- Open Claude Code in your project. Eagle Mem activates and shows:
21
+ **2. Open Claude Code** in any project directory. Eagle Mem activates and shows what it loaded:
24
22
 
25
23
  ```
26
24
  █▀▀ ▄▀█ █▀▀ █ █▀▀ █▀▄▀█ █▀▀ █▀▄▀█
27
25
  ██▄ █▀█ █▄█ █▄▄ ██▄ █ ▀ █ ██▄ █ ▀ █
28
26
 
29
27
  Project: my-app
30
- Sessions: 0 recent | Memories: 0 | Tasks: 0 pending
28
+ Sessions: 5 recent | Memories: 3 | Tasks: 2 pending
29
+ Last: Added auth middleware with JWT validation
30
+ ```
31
+
32
+ From here, everything is automatic. You don't run any commands — Eagle Mem captures session summaries, mirrors Claude's memories and tasks, and re-injects context after every `/compact` or new session.
33
+
34
+ **3. Already have Claude Code history on a project?** Run this inside the project directory:
35
+
36
+ ```bash
37
+ cd ~/projects/my-app
38
+ eagle-mem refresh
31
39
  ```
32
40
 
33
- Since no overview exists, Eagle Mem prompts Claude to build one on your first message. After that, every session starts with full context — you don't do anything.
41
+ This backfills everything into Eagle Mem:
42
+
43
+ ```
44
+ Eagle Mem Refresh
45
+ ─────────────────────────────────────
46
+
47
+ Step 1/4: Scanning codebase structure...
48
+ ✓ 120 files found
49
+ ✓ Languages: TypeScript (15k lines), CSS (2k lines)
50
+ ✓ Frameworks: Next.js, React, Tailwind, Prisma
51
+ ✓ Scan complete
52
+
53
+ Step 2/4: Indexing source files...
54
+ ✓ Index complete
55
+
56
+ Step 3/4: Syncing Claude Code memories, plans, and tasks...
57
+ ✓ Memory sync complete
58
+
59
+ Step 4/4: Verifying...
60
+ Sessions: 12
61
+ Code chunks: 340
62
+ Memories: 8
63
+ Tasks: 15
64
+ ```
34
65
 
35
- **What happens automatically:**
36
- - Every Claude turn end: session summary saved
37
- - Every tool use: file touches recorded, Claude's memories/plans/tasks mirrored
38
- - Every session start (including after `/compact`): overview + summaries + memories + tasks injected
39
- - Every prompt: FTS5 searches past sessions for relevant context
66
+ Now open Claude Code in that project — it sees your full history from the start.
40
67
 
41
- ## Existing project
68
+ ## Commands
42
69
 
43
- If you've been using Claude Code on a project and want to backfill everything:
70
+ Eagle Mem gives you terminal commands for when you need to look something up or manage your data outside of Claude Code.
71
+
72
+ ### Search past sessions
44
73
 
45
74
  ```bash
46
- eagle-mem refresh .
75
+ eagle-mem search "auth middleware"
47
76
  ```
48
77
 
49
- This runs three steps:
50
- 1. **Scan** — analyzes your codebase structure (languages, frameworks, entry points)
51
- 2. **Index** — chunks source files into FTS5-searchable pieces
52
- 3. **Memory sync** — imports all existing Claude Code memories, plans, and tasks
78
+ Searches across session summaries, Claude memories, and indexed code using FTS5. Use this when you know you worked on something last week but can't remember the details.
53
79
 
54
- Now open Claude Code. Eagle Mem injects your full history from the start.
80
+ ```bash
81
+ eagle-mem search --timeline
82
+ ```
55
83
 
56
- ## Day-to-day usage
84
+ Shows your most recent sessions in chronological order — useful for catching up after a break.
57
85
 
58
- Most of the time you don't run anything manually. The hooks handle everything. But when you need to:
86
+ ### View or set your project overview
59
87
 
60
- | When | What to do |
61
- |------|-----------|
62
- | Search past sessions | `eagle-mem search "auth middleware"` |
63
- | See recent timeline | `eagle-mem search --timeline` |
64
- | View project overview | `eagle-mem overview` |
65
- | Set a custom overview | `eagle-mem overview set "..."` |
66
- | Full re-sync after major changes | `eagle-mem refresh .` |
67
- | Clean up old data | `eagle-mem prune` |
88
+ ```bash
89
+ eagle-mem overview
90
+ ```
68
91
 
69
- Inside Claude Code, you also have skills (slash commands):
92
+ Shows the overview that gets injected into every Claude Code session. This is what Claude reads first to understand your project.
70
93
 
71
- | Skill | When to use it |
72
- |-------|---------------|
73
- | `/eagle-mem-search` | Find something from a past session |
74
- | `/eagle-mem-overview` | Build a rich project briefing from code + README + git |
75
- | `/eagle-mem-tasks` | Break complex work into tasks that survive `/compact` |
94
+ ```bash
95
+ eagle-mem overview set "My app is a Next.js dashboard for monitoring API health..."
96
+ ```
97
+
98
+ Set a custom overview. You can also let Claude write one for you by running `/eagle-mem-overview` inside a Claude Code session — it reads your README, entry points, and git history to synthesize one.
99
+
100
+ ### Sync everything
101
+
102
+ ```bash
103
+ eagle-mem refresh
104
+ ```
105
+
106
+ Run this inside a project directory after major changes (new packages, restructured directories, pulling a large branch). It re-scans the codebase, re-indexes source files, and syncs any new Claude Code memories and tasks.
107
+
108
+ ### Other commands
109
+
110
+ | Command | When to use it |
111
+ |---------|---------------|
112
+ | `eagle-mem scan` | Re-analyze codebase structure (languages, frameworks, entry points) |
113
+ | `eagle-mem index` | Re-index source files for code search |
114
+ | `eagle-mem memories` | View or sync mirrored Claude Code memories and plans |
115
+ | `eagle-mem tasks` | View mirrored Claude Code tasks |
116
+ | `eagle-mem prune` | Clean up old observations and orphaned code chunks |
117
+
118
+ ## Skills (inside Claude Code)
119
+
120
+ Inside a Claude Code session, you have slash commands that let Claude do the work for you:
121
+
122
+ ### `/eagle-mem-search`
123
+
124
+ Search past sessions from within Claude Code. Claude interprets results and connects them to your current work — better than raw terminal search when you need context, not just a match.
125
+
126
+ ### `/eagle-mem-overview`
127
+
128
+ Build a rich project briefing. Claude reads your README, entry points, recent git history, and current codebase to write a 2-3 paragraph overview that captures what the project *does*, not just its file counts. This overview is injected at every session start.
129
+
130
+ ### `/eagle-mem-tasks`
131
+
132
+ Break complex work into tasks that survive `/compact`. Uses Claude Code's native `TaskCreate`/`TaskUpdate` with dependency support. When context fills up and you compact, Eagle Mem re-injects the task state so Claude picks up where it left off.
133
+
134
+ ### Other skills
135
+
136
+ | Skill | What it does |
137
+ |-------|-------------|
138
+ | `/eagle-mem-scan` | Analyze codebase structure — languages, frameworks, entry points |
139
+ | `/eagle-mem-index` | Index source files for FTS5 code search |
140
+ | `/eagle-mem-memories` | View, search, and sync Claude Code's mirrored memories and plans |
141
+ | `/eagle-mem-prune` | Database hygiene — graduated cleanup of stale data |
76
142
 
77
143
  ## Updating
78
144
 
@@ -108,36 +174,6 @@ Data lives in a single SQLite database at `~/.eagle-mem/memory.db` (WAL mode, FT
108
174
  | claude_plans | Mirror of Claude Code plans |
109
175
  | claude_tasks | Mirror of Claude Code tasks |
110
176
 
111
- ## All commands
112
-
113
- | Command | What it does |
114
- |---------|-------------|
115
- | `eagle-mem install` | First-time setup: hooks, database, skills |
116
- | `eagle-mem update` | Re-deploy hooks and run pending migrations |
117
- | `eagle-mem uninstall` | Remove hooks and optionally delete data |
118
- | `eagle-mem refresh` | Full sync: scan + index + memories in one command |
119
- | `eagle-mem search <query>` | FTS5 search across summaries, memories, and code |
120
- | `eagle-mem overview` | View or set the project overview |
121
- | `eagle-mem scan` | Analyze codebase structure |
122
- | `eagle-mem index` | Index source files for code search |
123
- | `eagle-mem memories` | View/sync mirrored Claude Code memories and plans |
124
- | `eagle-mem tasks` | View mirrored Claude Code tasks |
125
- | `eagle-mem prune` | Remove old observations and orphaned chunks |
126
-
127
- ## All skills
128
-
129
- Seven skills available inside Claude Code sessions:
130
-
131
- | Skill | What it does |
132
- |-------|-------------|
133
- | `/eagle-mem-search` | Progressive memory recall — search, expand, drill into sessions |
134
- | `/eagle-mem-overview` | Build a structured project briefing from code, README, and git history |
135
- | `/eagle-mem-scan` | Analyze codebase structure — languages, frameworks, entry points |
136
- | `/eagle-mem-index` | Index source files for FTS5 code search across sessions |
137
- | `/eagle-mem-memories` | View, search, and sync Claude Code's mirrored memories and plans |
138
- | `/eagle-mem-tasks` | TaskAware Compact Loop — break work into tasks that survive compaction |
139
- | `/eagle-mem-prune` | Database hygiene — graduated cleanup of stale data |
140
-
141
177
  ## Uninstall
142
178
 
143
179
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eagle-mem",
3
- "version": "2.0.3",
3
+ "version": "2.0.5",
4
4
  "description": "Persistent memory for Claude Code — SQLite + FTS5, no daemon, no bloat",
5
5
  "bin": {
6
6
  "eagle-mem": "bin/eagle-mem"