@theihtisham/agent-shadow-brain 6.3.0 → 7.0.0

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 (43) hide show
  1. package/CHANGELOG.md +411 -391
  2. package/LICENSE +21 -21
  3. package/README.md +428 -438
  4. package/dist/adapters/aider.js +13 -13
  5. package/dist/adapters/base-adapter.js +14 -14
  6. package/dist/adapters/codex.js +8 -8
  7. package/dist/adapters/roo-code.js +18 -18
  8. package/dist/brain/adr-engine.js +11 -11
  9. package/dist/brain/analyzer.js +30 -30
  10. package/dist/brain/auto-update.js +1 -1
  11. package/dist/brain/global-brain.d.ts +52 -63
  12. package/dist/brain/global-brain.d.ts.map +1 -1
  13. package/dist/brain/global-brain.js +577 -339
  14. package/dist/brain/global-brain.js.map +1 -1
  15. package/dist/brain/health-score.js +19 -19
  16. package/dist/brain/learning-engine.js +59 -59
  17. package/dist/brain/mcp-server.d.ts +1 -0
  18. package/dist/brain/mcp-server.d.ts.map +1 -1
  19. package/dist/brain/mcp-server.js +16 -6
  20. package/dist/brain/mcp-server.js.map +1 -1
  21. package/dist/brain/plugin-system.js +23 -23
  22. package/dist/brain/pr-generator.js +19 -19
  23. package/dist/brain/project-context.js +1 -1
  24. package/dist/brain/project-context.js.map +1 -1
  25. package/dist/brain/report-generator.js +270 -270
  26. package/dist/cli.js +105 -34
  27. package/dist/cli.js.map +1 -1
  28. package/dist/dashboard/v6-dashboard-html.d.ts +1 -1
  29. package/dist/dashboard/v6-dashboard-html.d.ts.map +1 -1
  30. package/dist/dashboard/v6-dashboard-html.js +5 -5
  31. package/dist/index.d.ts +2 -0
  32. package/dist/index.d.ts.map +1 -1
  33. package/dist/index.js +2 -0
  34. package/dist/index.js.map +1 -1
  35. package/dist/types.d.ts +28 -10
  36. package/dist/types.d.ts.map +1 -1
  37. package/dist/watchers/git-watcher.d.ts.map +1 -1
  38. package/dist/watchers/git-watcher.js +1 -1
  39. package/dist/watchers/git-watcher.js.map +1 -1
  40. package/docs/launch/RELEASE_CHECKLIST_v7.0.0.md +24 -0
  41. package/docs/launch/RELEASE_NOTES_v7.0.0.md +44 -0
  42. package/package.json +17 -14
  43. package/docs/launch/README.md +0 -61
package/README.md CHANGED
@@ -1,438 +1,428 @@
1
- # Agent Shadow Brain
2
-
3
- Local-first memory and coordination for AI coding agents.
4
-
5
- Version: 6.3.0
6
-
7
- <p align="center">
8
- <img src="Banner.png" alt="Agent Shadow Brain shared local memory layer for AI agents" width="100%">
9
- </p>
10
- <p align="center">
11
- <a href="https://trendshift.io/repositories/20881" target="_blank"><img src="https://trendshift.io/api/badge/repositories/20881" alt="chopratejas%2Fheadroom | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
12
- </p>
13
- <p align="center">
14
- <img src="docs/launch/github-trending-ready.svg" alt="GitHub Trending Ready - Agent Shadow Brain v6.0.3 live on npm" width="420">
15
- </p>
16
-
17
- Agent Shadow Brain gives tools like Codex, Claude Code, Cursor, Cline, OpenCode, Aider, and related MCP clients a shared local memory layer. It stores compact, source-backed lessons about projects, recalls them later, generates fresh-session briefings, audits memory quality, and exports JSONL training/eval packs.
18
-
19
- It does not change model weights by itself. It helps agents work better by giving them relevant, current, source-linked context before and during complex work.
20
-
21
- ## What's New in 6.3.0
22
-
23
- Recall confidence scoring, plus the 6.2.0 dashboard upgrade for clarity and visibility.
24
-
25
- - **Recall confidence.** Every recalled memory now carries a blended confidence score (high/medium/low) so an agent can weight what it trusts. The score combines keyword relevance, recency (30-day half-life), author-assigned importance, cross-agent corroboration, and prior usage. Exposed via `GlobalBrain.recallScored()`, the `global_recall_scored` MCP tool, and a color-coded badge in the dashboard.
26
- - **Quieter automation.** Fixed a GitHub Actions bot that opened duplicate milestone/momentum issues; notifiers are now idempotent and verify against GitHub before posting.
27
-
28
- - **Simple by default, Advanced on demand.** The dashboard opens with eight plain-English tabs (Home, Brain Map, Memories, Ask the Brain, Activity, Connected Tools, Brain Health, Settings). Flip to Advanced to reveal every feature — nothing was removed, just tidied.
29
- - **Brain Map.** An interactive graph of everything the brain remembers — memories, projects, tools, and tags — sized by importance (PageRank) and linked by shared context. Zoom, pan, click a node for details, and watch it grow live as new memories arrive.
30
- - **Realtime activity.** Memory writes, reflections, and tool events stream live over WebSocket instead of polling, with a live pulse on Home.
31
- - **Live Network.** A refreshed animation of your tools talking to the brain, with flowing signal pulses.
32
- - **Two-way knowledge seeding.** Quick-Save captures knowledge in one click; "Hand to Agent" generates a ready briefing to pass context back to any tool.
33
- - **Plain-language everywhere.** Cryptic feature names rewritten (e.g. Calibration → Accuracy, Pre-Mortem → Risk Check, Tokens → Cost & Usage), each with a hover description.
34
-
35
- <p align="center">
36
- <img src="docs/screenshots/01-home.png" alt="Shadow Brain dashboard Home — summary of memories, connected tools, and live activity" width="100%">
37
- </p>
38
- <p align="center">
39
- <img src="docs/screenshots/02-brain-map.png" alt="Brain Map — interactive memory constellation graph" width="100%">
40
- </p>
41
- <p align="center">
42
- <img src="docs/screenshots/03-live-network.png" alt="Live Network — animated view of tools communicating with the brain" width="100%">
43
- </p>
44
- <p align="center">
45
- <img src="docs/screenshots/04-recall-confidence.png" alt="Recall confidence - recalled memories ranked with color-coded high, medium, and low confidence badges" width="100%">
46
- </p>
47
-
48
- ## What It Actually Does
49
-
50
- - Stores cross-project and cross-agent memories in a local JSON brain at `~/.shadow-brain/global.json`.
51
- - Recalls memories by project, agent, category, and keywords.
52
- - Generates source-backed resume packs for fresh sessions, account switches, context compaction, and handoffs.
53
- - Audits memory quality: source coverage, stale entries, duplicates, low-quality notes, recall health.
54
- - Creates verified memory seed drafts from dashboard/API, then requires user, agent, or dual approval before writing to durable memory.
55
- - Exports JSONL rows for evals, distillation, or local fine-tuning pipelines.
56
- - Provides CLI, dashboard API, and MCP tool surfaces.
57
- - Includes safety helpers such as hook audit, detach, and action firewall checks.
58
- - Works without telemetry and without an API key for local memory features.
59
-
60
- ## What It Does Not Claim
61
-
62
- - It does not secretly train GPT, Claude, Gemini, or any remote model.
63
- - It does not guarantee perfect recall.
64
- - It does not replace project docs, tests, source control, or human review.
65
- - It does not make every listed agent automatically available. Agent support depends on local installation and hook/config compatibility.
66
- - It does not publish or sync data unless you explicitly use export, sync, or other sharing commands.
67
-
68
- ## Install
69
-
70
- ```bash
71
- npm install -g @theihtisham/agent-shadow-brain
72
- ```
73
-
74
- CLI binaries:
75
-
76
- ```bash
77
- shadow-brain --help
78
- asb --help
79
- ```
80
-
81
- You can also run without global install:
82
-
83
- ```bash
84
- npx @theihtisham/agent-shadow-brain@latest --help
85
- ```
86
-
87
- ## Safe First Run
88
-
89
- Start by auditing before attaching hooks:
90
-
91
- ```bash
92
- shadow-brain audit-hooks .
93
- shadow-brain live-brain status .
94
- ```
95
-
96
- Only attach after you review what will be changed:
97
-
98
- ```bash
99
- shadow-brain attach-all .
100
- ```
101
-
102
- Detach later if needed:
103
-
104
- ```bash
105
- shadow-brain detach-all .
106
- ```
107
-
108
- ## v6.0.3: Live Brain
109
-
110
- The 6.0.3 release focuses on practical long-memory improvement for agents.
111
-
112
- ### Live Brain Status
113
-
114
- ```bash
115
- shadow-brain live-brain status .
116
- ```
117
-
118
- Shows:
119
-
120
- - memory count
121
- - average memory quality
122
- - source coverage
123
- - stale memories
124
- - duplicate clusters
125
- - recall eval score
126
- - recommended cleanup actions
127
-
128
- JSON output:
129
-
130
- ```bash
131
- shadow-brain live-brain status . --json
132
- ```
133
-
134
- ### Agent Briefing
135
-
136
- Generate a markdown briefing for a fresh agent session:
137
-
138
- ```bash
139
- shadow-brain live-brain brief . -o SHADOW_BRAIN_AGENT_BRIEF.md
140
- ```
141
-
142
- The briefing includes:
143
-
144
- - rules for agents
145
- - top source-backed memories
146
- - memory warnings
147
- - recall health
148
- - commands agents should run next
149
-
150
- ### Recall Eval
151
-
152
- Check whether the brain can retrieve useful memories for common agent tasks:
153
-
154
- ```bash
155
- shadow-brain live-brain eval .
156
- ```
157
-
158
- Custom eval queries use pipe separators:
159
-
160
- ```bash
161
- shadow-brain live-brain eval . --queries "current blocker|do not repeat|verified command"
162
- ```
163
-
164
- ### Memory Hygiene
165
-
166
- List concrete cleanup and learning actions:
167
-
168
- ```bash
169
- shadow-brain live-brain hygiene .
170
- ```
171
-
172
- This highlights missing sources, stale memories, duplicates, weak recall, and missing project-scoped memories.
173
-
174
- ### Training/Eval Export
175
-
176
- Export source-backed memories as JSONL:
177
-
178
- ```bash
179
- shadow-brain live-brain train-pack . --out shadow-brain-training.jsonl
180
- ```
181
-
182
- This is useful for:
183
-
184
- - retrieval evals
185
- - local distillation experiments
186
- - supervised fine-tuning datasets
187
- - memory regression tests
188
-
189
- The export is only data preparation. You choose the downstream training/eval tool.
190
-
191
- ## Core Memory Commands
192
-
193
- Recall from the global brain:
194
-
195
- ```bash
196
- shadow-brain global recall --query "current blocker next step" --json --limit 8
197
- ```
198
-
199
- Show global stats:
200
-
201
- ```bash
202
- shadow-brain global stats
203
- ```
204
-
205
- Create a source-backed resume seed:
206
-
207
- ```bash
208
- shadow-brain resume-seed . -o SHADOW_BRAIN_RESUME_SEED.md
209
- ```
210
-
211
- Show what a project has learned:
212
-
213
- ```bash
214
- shadow-brain timeline . --limit 30
215
- ```
216
-
217
- Create a cross-agent handoff packet:
218
-
219
- ```bash
220
- shadow-brain handoff codex claude-code . --task "continue release verification"
221
- ```
222
-
223
- Record a durable memory from a script:
224
-
225
- ```bash
226
- node tools/record-global-memory.mjs ^
227
- --project-dir "." ^
228
- --project-name "my-project" ^
229
- --agent codex ^
230
- --category "project.lesson" ^
231
- --importance 0.8 ^
232
- --tags "memory,release" ^
233
- --sources "README.md,CHANGELOG.md" ^
234
- --content "Keep release notes source-backed and verify npm metadata before publish."
235
- ```
236
-
237
- ## Dashboard
238
-
239
- Start the local dashboard:
240
-
241
- ```bash
242
- shadow-brain dash . --no-open --port 7341
243
- ```
244
-
245
- For a fast UI/API-only launch on a large repo:
246
-
247
- ```bash
248
- shadow-brain dash . --no-open --no-analysis --host 127.0.0.1 --port 7341
249
- ```
250
-
251
- Open:
252
-
253
- ```text
254
- http://127.0.0.1:7341
255
- ```
256
-
257
- The v6 dashboard includes a **Live Brain** tab for memory health, source coverage, recall evals, hygiene actions, top memories, and the generated agent briefing.
258
-
259
- It also includes:
260
-
261
- - **Memory Browser intelligence cards** for total memories, source coverage, fresh learning, seed queue, top categories, agent coverage, and top tags.
262
- - **Memory Seeder** for controlled research-to-memory workflows. Drafts stay out of the global brain until approval is complete.
263
- - **Token Economy accuracy split**: current runtime agent is shown separately from historical model spend, so old Claude/Cursor spend records do not imply the dashboard is running that agent.
264
-
265
- ### Realtime Activity (new in 6.1.0)
266
-
267
- The dashboard now streams brain activity live over its WebSocket instead of polling. Memory writes, dreams, seed drafts/commits, collisions, sub-agent spawns, and consolidation cycles appear the instant they happen.
268
-
269
- - **Live Pulse** card on the Overview with a streaming mini-feed and an events/min rate.
270
- - **Activity Log** tab with filter chips, a pulsing LIVE badge, pause/resume, clear, search, and an events/min sparkline.
271
- - **Connection indicator** in the header — green when the realtime socket is live, amber while reconnecting.
272
- - **Cross-process aware**: a memory written by an agent in a *different* terminal is picked up by watching `~/.shadow-brain/global.json`, so the feed reflects the whole machine, not just this process.
273
-
274
- Polling remains as a 15-second reconciliation fallback; live events arrive in well under a second.
275
-
276
- ### Intelligence Hub — Memory Constellation (new in 6.2.0)
277
-
278
- A new **Intelligence** tab turns the brain into an interactive graph. Every memory, project, agent, and tag is a node in a force-directed **Memory Constellation**, sized by importance (PageRank blended with each memory's own score) and linked by project, author, tags, and shared-tag relatedness.
279
-
280
- - **Interactive**: scroll to zoom, drag to pan, click a node to focus its neighborhood and open a detail drawer; hover for a tooltip.
281
- - **Filters + search** by node type (memory / project / agent / tag).
282
- - **Live**: new memories pulse into the graph over the realtime stream.
283
- - **Analytics strip**: source-coverage gauge, agent-contribution and category charts, tag cloud, and a recent-memory feed.
284
- - Works instantly on your existing `~/.shadow-brain/global.json` — no project analysis or setup step.
285
-
286
- Several previously sparse tabs were also rebuilt with real visualizations: **Pre-Mortem** (risk matrix + failure cards), **Attention** (weighted heat bars), **Calibration** (Brier/trust chart), **Reputation** (trust rings), **Causal Chains** (node-link DAG), and **Branch Brains** (stat cards).
287
-
288
- Constellation API:
289
-
290
- ```text
291
- GET /api/v6/memory-graph
292
- ```
293
-
294
-
295
- Memory seeding API:
296
-
297
- ```text
298
- GET /api/v6/seed-drafts
299
- POST /api/v6/seed-draft
300
- POST /api/v6/seed-approve
301
- POST /api/v6/seed-reject
302
- POST /api/v6/seed-commit
303
- GET /api/v6/memory-intelligence
304
- ```
305
-
306
- Useful API endpoints:
307
-
308
- ```text
309
- GET/POST /api/v6/live-brain
310
- GET/POST /api/v6/resume-pack
311
- GET/POST /api/v6/ww2br-recall
312
- GET/POST /api/v6/memory-browser
313
- ```
314
-
315
- Example:
316
-
317
- ```bash
318
- curl "http://127.0.0.1:7341/api/v6/live-brain?projectDir=C:/path/to/project"
319
- ```
320
-
321
- ## MCP Tools
322
-
323
- The MCP server exposes memory and agent-control tools for compatible clients.
324
-
325
- New in 6.3.0:
326
-
327
- - `global_recall_scored` — recall with a per-memory confidence score (recency, author importance, cross-agent corroboration, prior usage, keyword relevance). Results are ranked by confidence so agents can weight memories instead of trusting every hit equally. Supports `minConfidence` to drop low-trust hits.
328
-
329
- New in 6.0.3:
330
-
331
- - `live_brain_status`
332
- - `live_brain_brief`
333
- - `live_brain_train_pack`
334
-
335
- Existing useful tools include:
336
-
337
- - `global_recall`
338
- - `global_recall_scored`
339
- - `global_stats`
340
- - `global_timeline`
341
- - `subconscious_inject`
342
- - `agent_handoff`
343
- - `firewall_check`
344
-
345
- Start MCP from the dashboard API or existing CLI/server integration, depending on your setup.
346
-
347
- ## How Agents Should Use It
348
-
349
- Recommended workflow for complex work:
350
-
351
- 1. Run `shadow-brain live-brain status <project>`.
352
- 2. Generate or read a live briefing.
353
- 3. Verify current project docs and source files.
354
- 4. Work normally.
355
- 5. Record only durable, source-backed lessons after proof.
356
- 6. Run recall evals when memory quality starts to drift.
357
-
358
- Good memories are short, action-oriented, and source-backed:
359
-
360
- ```text
361
- [lesson:release-readme-v1] Before publishing, verify package.json version, package-lock root version, README install commands, build output, and npm pack contents.
362
- Sources: package.json; package-lock.json; README.md
363
- Tags: release,npm,verification
364
- ```
365
-
366
- Bad memories are vague:
367
-
368
- ```text
369
- Make project better.
370
- ```
371
-
372
- ## Local Data
373
-
374
- Default global brain:
375
-
376
- ```text
377
- ~/.shadow-brain/global.json
378
- ```
379
-
380
- Project-local generated files may include:
381
-
382
- ```text
383
- SHADOW_BRAIN_AGENT_BRIEF.md
384
- SHADOW_BRAIN_RESUME_SEED.md
385
- shadow-brain-training.jsonl
386
- ```
387
-
388
- Do not store secrets, API keys, passwords, private keys, or raw credentials in memory content, metadata, tags, prompts, reports, or exported training data.
389
-
390
- ## Development
391
-
392
- ```bash
393
- npm install
394
- npm run build
395
- npm test
396
- ```
397
-
398
- Focused tests:
399
-
400
- ```bash
401
- npx vitest run tests/brain/live-brain.test.ts tests/brain/context-continuity.test.ts
402
- ```
403
-
404
- On Windows PowerShell, if execution policy blocks `npm.ps1`, use:
405
-
406
- ```powershell
407
- npm.cmd run build
408
- npx.cmd vitest run tests\brain\live-brain.test.ts
409
- ```
410
-
411
- ## Release Checklist
412
-
413
- For a 6.0.3 release:
414
-
415
- ```bash
416
- npm run build
417
- npm test
418
- npm pack --dry-run
419
- ```
420
-
421
- Then publish only after verifying the package contents:
422
-
423
- ```bash
424
- npm publish --access public
425
- ```
426
-
427
- GitHub release should include:
428
-
429
- - this README
430
- - `CHANGELOG.md`
431
- - `docs/launch/RELEASE_NOTES_v6.0.3.md`
432
- - `docs/launch/RELEASE_CHECKLIST_v6.0.3.md`
433
- - build/test output
434
- - npm package dry-run output
435
-
436
- ## License
437
-
438
- MIT
1
+ # Agent Shadow Brain
2
+
3
+ Local-first memory and coordination for AI coding agents.
4
+
5
+ Version: 7.0.0
6
+
7
+
8
+ Agent Shadow Brain gives tools like Codex, Claude Code, Cursor, Cline, OpenCode, Aider, and related MCP clients a shared local memory layer. It stores compact, source-backed lessons about projects, recalls them later, generates fresh-session briefings, audits memory quality, and exports JSONL training/eval packs.
9
+
10
+ It does not change model weights by itself. It helps agents work better by giving them relevant, current, source-linked context before and during complex work.
11
+
12
+ ## What's New in 7.0.0
13
+
14
+ - **Durable multi-agent memory.** Saves lock, reload, and merge the latest store so independent agents cannot replace each other's new memories. Queued writes acknowledge success after persistence. Failed operations remain retryable and visible in storage health.
15
+ - **Explainable recall.** Results include matched keywords, score components, and identities reporting the same normalized content within the same project and category. Unrelated notes no longer inflate scores. Scores are ranking heuristics, not probabilities of truth or proof of independent verification.
16
+ - **Storage diagnostics.** Use `shadow-brain storage-health --json` or MCP `global_storage_health` to inspect errors and pending operations. Invalid or unsupported stores fail explicitly and remain unchanged.
17
+ - **Safer setup and packaging.** Installation no longer edits agent settings. Help, version, and memory diagnostics do not load provider configuration. Dependencies are refreshed, activity-log text is escaped, and package tests install a real tarball into a fresh consumer project.
18
+
19
+ ### Upgrade from 6.x
20
+
21
+ Use Node.js 22.12+ within 22.x, Node 24.x, or Node 26+. Back up your existing `global.json` before upgrading and stop older Shadow Brain writers; older versions do not participate in the new lock protocol. The schema remains version 1. Start integrations explicitly using the existing setup/attach commands after installation.
22
+
23
+ `writeSync()` remains an in-memory operation; call `await brain.sync()` for durable persistence. `await brain.write()` resolves after the background sync or an explicit sync; a false result means persistence failed or the queue was full. Failed accepted operations remain pending for retry. Recall reads the process snapshot, refreshed by sync; it is not an instantaneous cross-process read.
24
+
25
+ ### New commands
26
+
27
+ ```bash
28
+ shadow-brain storage-health --json
29
+ shadow-brain storage-health --db ./global.json --json
30
+ shadow-brain recall-explain "deployment rollback" --limit 5
31
+ shadow-brain recall-explain "database migration" --project . --min-confidence 0.4
32
+ ```
33
+
34
+ `storage-health` validates readability and schema, reports JSON even on failure, and exits with code 1 for an invalid store. It does not repair or rewrite an existing store; when checking a missing store it may create its parent directory. `lastSuccessfulSync` describes the current process only. The MCP health tool inspects existing process state without initializing or flushing it.
35
+
36
+ The library exports `GlobalBrain`, `getGlobalBrain`, and their public types:
37
+
38
+ ```js
39
+ import { getGlobalBrain } from '@theihtisham/agent-shadow-brain';
40
+ const brain = getGlobalBrain({ dbPath: './global.json' });
41
+ await brain.init();
42
+ console.log(brain.recallScored({ keywords: ['deployment'], limit: 5 }));
43
+ console.log(brain.getStorageHealth());
44
+ await brain.shutdown();
45
+ ```
46
+
47
+ Details: [release notes](docs/launch/RELEASE_NOTES_v7.0.0.md).
48
+
49
+ ## Earlier dashboard features
50
+
51
+ - **Simple by default, Advanced on demand.** The dashboard opens with eight plain-English tabs (Home, Brain Map, Memories, Ask the Brain, Activity, Connected Tools, Brain Health, Settings). Flip to Advanced to reveal every feature — nothing was removed, just tidied.
52
+ - **Brain Map.** An interactive graph of everything the brain remembers — memories, projects, tools, and tags — sized by importance (PageRank) and linked by shared context. Zoom, pan, click a node for details, and watch it grow live as new memories arrive.
53
+ - **Realtime activity.** Memory writes, reflections, and tool events stream live over WebSocket instead of polling, with a live pulse on Home.
54
+ - **Live Network.** A refreshed animation of your tools talking to the brain, with flowing signal pulses.
55
+ - **Two-way knowledge seeding.** Quick-Save captures knowledge in one click; "Hand to Agent" generates a ready briefing to pass context back to any tool.
56
+ - **Plain-language everywhere.** Cryptic feature names rewritten (e.g. Calibration → Accuracy, Pre-Mortem → Risk Check, Tokens → Cost & Usage), each with a hover description.
57
+
58
+
59
+ ## What It Actually Does
60
+
61
+ - Stores cross-project and cross-agent memories in a local JSON brain at `~/.shadow-brain/global.json`.
62
+ - Recalls memories by project, agent, category, and keywords.
63
+ - Generates source-backed resume packs for fresh sessions, account switches, context compaction, and handoffs.
64
+ - Audits memory quality: source coverage, stale entries, duplicates, low-quality notes, recall health.
65
+ - Creates verified memory seed drafts from dashboard/API, then requires user, agent, or dual approval before writing to durable memory.
66
+ - Exports JSONL rows for evals, distillation, or local fine-tuning pipelines.
67
+ - Provides CLI, dashboard API, and MCP tool surfaces.
68
+ - Includes safety helpers such as hook audit, detach, and action firewall checks.
69
+ - Works without telemetry and without an API key for local memory features.
70
+
71
+ ## What It Does Not Claim
72
+
73
+ - It does not secretly train GPT, Claude, Gemini, or any remote model.
74
+ - It does not guarantee perfect recall.
75
+ - It does not replace project docs, tests, source control, or human review.
76
+ - It does not make every listed agent automatically available. Agent support depends on local installation and hook/config compatibility.
77
+ - It does not publish or sync data unless you explicitly use export, sync, or other sharing commands.
78
+
79
+ ## Install
80
+
81
+ ```bash
82
+ npm install -g @theihtisham/agent-shadow-brain
83
+ ```
84
+
85
+ CLI binaries:
86
+
87
+ ```bash
88
+ shadow-brain --help
89
+ asb --help
90
+ ```
91
+
92
+ You can also run without global install:
93
+
94
+ ```bash
95
+ npx @theihtisham/agent-shadow-brain@latest --help
96
+ ```
97
+
98
+ ## Safe First Run
99
+
100
+ Start by auditing before attaching hooks:
101
+
102
+ ```bash
103
+ shadow-brain audit-hooks .
104
+ shadow-brain live-brain status .
105
+ ```
106
+
107
+ Only attach after you review what will be changed:
108
+
109
+ ```bash
110
+ shadow-brain attach-all .
111
+ ```
112
+
113
+ Detach later if needed:
114
+
115
+ ```bash
116
+ shadow-brain detach-all .
117
+ ```
118
+
119
+ ## v6.0.3: Live Brain
120
+
121
+ The 6.0.3 release focuses on practical long-memory improvement for agents.
122
+
123
+ ### Live Brain Status
124
+
125
+ ```bash
126
+ shadow-brain live-brain status .
127
+ ```
128
+
129
+ Shows:
130
+
131
+ - memory count
132
+ - average memory quality
133
+ - source coverage
134
+ - stale memories
135
+ - duplicate clusters
136
+ - recall eval score
137
+ - recommended cleanup actions
138
+
139
+ JSON output:
140
+
141
+ ```bash
142
+ shadow-brain live-brain status . --json
143
+ ```
144
+
145
+ ### Agent Briefing
146
+
147
+ Generate a markdown briefing for a fresh agent session:
148
+
149
+ ```bash
150
+ shadow-brain live-brain brief . -o SHADOW_BRAIN_AGENT_BRIEF.md
151
+ ```
152
+
153
+ The briefing includes:
154
+
155
+ - rules for agents
156
+ - top source-backed memories
157
+ - memory warnings
158
+ - recall health
159
+ - commands agents should run next
160
+
161
+ ### Recall Eval
162
+
163
+ Check whether the brain can retrieve useful memories for common agent tasks:
164
+
165
+ ```bash
166
+ shadow-brain live-brain eval .
167
+ ```
168
+
169
+ Custom eval queries use pipe separators:
170
+
171
+ ```bash
172
+ shadow-brain live-brain eval . --queries "current blocker|do not repeat|verified command"
173
+ ```
174
+
175
+ ### Memory Hygiene
176
+
177
+ List concrete cleanup and learning actions:
178
+
179
+ ```bash
180
+ shadow-brain live-brain hygiene .
181
+ ```
182
+
183
+ This highlights missing sources, stale memories, duplicates, weak recall, and missing project-scoped memories.
184
+
185
+ ### Training/Eval Export
186
+
187
+ Export source-backed memories as JSONL:
188
+
189
+ ```bash
190
+ shadow-brain live-brain train-pack . --out shadow-brain-training.jsonl
191
+ ```
192
+
193
+ This is useful for:
194
+
195
+ - retrieval evals
196
+ - local distillation experiments
197
+ - supervised fine-tuning datasets
198
+ - memory regression tests
199
+
200
+ The export is only data preparation. You choose the downstream training/eval tool.
201
+
202
+ ## Core Memory Commands
203
+
204
+ Recall from the global brain:
205
+
206
+ ```bash
207
+ shadow-brain global recall --query "current blocker next step" --json --limit 8
208
+ ```
209
+
210
+ Show global stats:
211
+
212
+ ```bash
213
+ shadow-brain global stats
214
+ ```
215
+
216
+ Create a source-backed resume seed:
217
+
218
+ ```bash
219
+ shadow-brain resume-seed . -o SHADOW_BRAIN_RESUME_SEED.md
220
+ ```
221
+
222
+ Show what a project has learned:
223
+
224
+ ```bash
225
+ shadow-brain timeline . --limit 30
226
+ ```
227
+
228
+ Create a cross-agent handoff packet:
229
+
230
+ ```bash
231
+ shadow-brain handoff codex claude-code . --task "continue release verification"
232
+ ```
233
+
234
+ Record a durable memory from a script:
235
+
236
+ ```bash
237
+ node tools/record-global-memory.mjs ^
238
+ --project-dir "." ^
239
+ --project-name "my-project" ^
240
+ --agent codex ^
241
+ --category "project.lesson" ^
242
+ --importance 0.8 ^
243
+ --tags "memory,release" ^
244
+ --sources "README.md,CHANGELOG.md" ^
245
+ --content "Keep release notes source-backed and verify npm metadata before publish."
246
+ ```
247
+
248
+ ## Dashboard
249
+
250
+ Start the local dashboard:
251
+
252
+ ```bash
253
+ shadow-brain dash . --no-open --port 7341
254
+ ```
255
+
256
+ For a fast UI/API-only launch on a large repo:
257
+
258
+ ```bash
259
+ shadow-brain dash . --no-open --no-analysis --host 127.0.0.1 --port 7341
260
+ ```
261
+
262
+ Open:
263
+
264
+ ```text
265
+ http://127.0.0.1:7341
266
+ ```
267
+
268
+ The v6 dashboard includes a **Live Brain** tab for memory health, source coverage, recall evals, hygiene actions, top memories, and the generated agent briefing.
269
+
270
+ It also includes:
271
+
272
+ - **Memory Browser intelligence cards** for total memories, source coverage, fresh learning, seed queue, top categories, agent coverage, and top tags.
273
+ - **Memory Seeder** for controlled research-to-memory workflows. Drafts stay out of the global brain until approval is complete.
274
+ - **Token Economy accuracy split**: current runtime agent is shown separately from historical model spend, so old Claude/Cursor spend records do not imply the dashboard is running that agent.
275
+
276
+ ### Realtime Activity (new in 6.1.0)
277
+
278
+ The dashboard now streams brain activity live over its WebSocket instead of polling. Memory writes, dreams, seed drafts/commits, collisions, sub-agent spawns, and consolidation cycles appear the instant they happen.
279
+
280
+ - **Live Pulse** card on the Overview with a streaming mini-feed and an events/min rate.
281
+ - **Activity Log** tab with filter chips, a pulsing LIVE badge, pause/resume, clear, search, and an events/min sparkline.
282
+ - **Connection indicator** in the header — green when the realtime socket is live, amber while reconnecting.
283
+ - **Cross-process aware**: a memory written by an agent in a *different* terminal is picked up by watching `~/.shadow-brain/global.json`, so the feed reflects the whole machine, not just this process.
284
+
285
+ Polling remains as a 15-second reconciliation fallback; live events arrive in well under a second.
286
+
287
+ ### Intelligence Hub — Memory Constellation (new in 6.2.0)
288
+
289
+ A new **Intelligence** tab turns the brain into an interactive graph. Every memory, project, agent, and tag is a node in a force-directed **Memory Constellation**, sized by importance (PageRank blended with each memory's own score) and linked by project, author, tags, and shared-tag relatedness.
290
+
291
+ - **Interactive**: scroll to zoom, drag to pan, click a node to focus its neighborhood and open a detail drawer; hover for a tooltip.
292
+ - **Filters + search** by node type (memory / project / agent / tag).
293
+ - **Live**: new memories pulse into the graph over the realtime stream.
294
+ - **Analytics strip**: source-coverage gauge, agent-contribution and category charts, tag cloud, and a recent-memory feed.
295
+ - Works instantly on your existing `~/.shadow-brain/global.json` — no project analysis or setup step.
296
+
297
+ Several previously sparse tabs were also rebuilt with real visualizations: **Pre-Mortem** (risk matrix + failure cards), **Attention** (weighted heat bars), **Calibration** (Brier/trust chart), **Reputation** (trust rings), **Causal Chains** (node-link DAG), and **Branch Brains** (stat cards).
298
+
299
+ Constellation API:
300
+
301
+ ```text
302
+ GET /api/v6/memory-graph
303
+ ```
304
+
305
+
306
+ Memory seeding API:
307
+
308
+ ```text
309
+ GET /api/v6/seed-drafts
310
+ POST /api/v6/seed-draft
311
+ POST /api/v6/seed-approve
312
+ POST /api/v6/seed-reject
313
+ POST /api/v6/seed-commit
314
+ GET /api/v6/memory-intelligence
315
+ ```
316
+
317
+ Useful API endpoints:
318
+
319
+ ```text
320
+ GET/POST /api/v6/live-brain
321
+ GET/POST /api/v6/resume-pack
322
+ GET/POST /api/v6/ww2br-recall
323
+ GET/POST /api/v6/memory-browser
324
+ ```
325
+
326
+ Example:
327
+
328
+ ```bash
329
+ curl "http://127.0.0.1:7341/api/v6/live-brain?projectDir=C:/path/to/project"
330
+ ```
331
+
332
+ ## MCP Tools
333
+
334
+ The MCP server exposes memory and agent-control tools for compatible clients.
335
+
336
+ New in 6.3.0:
337
+
338
+ - `global_recall_scored` — recall with a per-memory confidence score (recency, author importance, cross-agent corroboration, prior usage, keyword relevance). Results are ranked by confidence so agents can weight memories instead of trusting every hit equally. Supports `minConfidence` to drop low-trust hits.
339
+
340
+ New in 6.0.3:
341
+
342
+ - `live_brain_status`
343
+ - `live_brain_brief`
344
+ - `live_brain_train_pack`
345
+
346
+ Existing useful tools include:
347
+
348
+ - `global_recall`
349
+ - `global_recall_scored`
350
+ - `global_stats`
351
+ - `global_timeline`
352
+ - `subconscious_inject`
353
+ - `agent_handoff`
354
+ - `firewall_check`
355
+
356
+ Start MCP from the dashboard API or existing CLI/server integration, depending on your setup.
357
+
358
+ ## How Agents Should Use It
359
+
360
+ Recommended workflow for complex work:
361
+
362
+ 1. Run `shadow-brain live-brain status <project>`.
363
+ 2. Generate or read a live briefing.
364
+ 3. Verify current project docs and source files.
365
+ 4. Work normally.
366
+ 5. Record only durable, source-backed lessons after proof.
367
+ 6. Run recall evals when memory quality starts to drift.
368
+
369
+ Good memories are short, action-oriented, and source-backed:
370
+
371
+ ```text
372
+ [lesson:release-readme-v1] Before publishing, verify package.json version, package-lock root version, README install commands, build output, and npm pack contents.
373
+ Sources: package.json; package-lock.json; README.md
374
+ Tags: release,npm,verification
375
+ ```
376
+
377
+ Bad memories are vague:
378
+
379
+ ```text
380
+ Make project better.
381
+ ```
382
+
383
+ ## Local Data
384
+
385
+ Default global brain:
386
+
387
+ ```text
388
+ ~/.shadow-brain/global.json
389
+ ```
390
+
391
+ Project-local generated files may include:
392
+
393
+ ```text
394
+ SHADOW_BRAIN_AGENT_BRIEF.md
395
+ SHADOW_BRAIN_RESUME_SEED.md
396
+ shadow-brain-training.jsonl
397
+ ```
398
+
399
+ Do not store secrets, API keys, passwords, private keys, or raw credentials in memory content, metadata, tags, prompts, reports, or exported training data.
400
+
401
+ ## Development
402
+
403
+ ```bash
404
+ npm ci --ignore-scripts
405
+ npm run verify
406
+ npm run test:package
407
+ ```
408
+
409
+ Focused tests:
410
+
411
+ ```bash
412
+ npx vitest run tests/brain/live-brain.test.ts tests/brain/context-continuity.test.ts
413
+ ```
414
+
415
+ On Windows PowerShell, if execution policy blocks `npm.ps1`, use:
416
+
417
+ ```powershell
418
+ npm.cmd run build
419
+ npx.cmd vitest run tests\brain\live-brain.test.ts
420
+ ```
421
+
422
+ ## Release Checklist
423
+
424
+ Run `npm run verify`, `npm audit --audit-level=high`, and `npm run test:package`. Inspect the package allowlist, then publish the verified tarball. Confirm the npm version, integrity, and GitHub tag before announcing a release. See [the complete release checklist](docs/launch/RELEASE_CHECKLIST_v7.0.0.md).
425
+
426
+ ## License
427
+
428
+ MIT