brain-memory 0.1.0-beta.2 → 0.1.0-beta.21

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 (44) hide show
  1. package/README.md +272 -72
  2. package/assets/icon.png +0 -0
  3. package/assets/icon.svg +27 -0
  4. package/bin/brain.js +111 -0
  5. package/bin/cloud-sync.js +149 -0
  6. package/bin/install.js +217 -242
  7. package/bin/memorize.js +436 -0
  8. package/bin/pin.js +44 -0
  9. package/bin/recall.js +237 -0
  10. package/bin/reinforce.js +187 -0
  11. package/bin/session-start.js +292 -0
  12. package/bin/skill.js +67 -0
  13. package/bin/unpin.js +38 -0
  14. package/commands/brain/consolidate.md +7 -2
  15. package/commands/brain/explore.md +7 -2
  16. package/commands/brain/forget.md +7 -2
  17. package/commands/brain/init.md +8 -12
  18. package/commands/brain/memorize.md +76 -144
  19. package/commands/brain/pin.md +37 -0
  20. package/commands/brain/remember.md +48 -105
  21. package/commands/brain/review.md +7 -2
  22. package/commands/brain/skills.md +60 -0
  23. package/commands/brain/sleep.md +68 -27
  24. package/commands/brain/status.md +19 -5
  25. package/commands/brain/sunshine.md +18 -13
  26. package/commands/brain/sync.md +360 -0
  27. package/commands/brain/unpin.md +26 -0
  28. package/package.json +18 -8
  29. package/prompts/claude.md +115 -12
  30. package/prompts/gemini.md +115 -12
  31. package/prompts/openai.md +113 -10
  32. package/prompts/opencode.md +178 -0
  33. package/src/cloud-sync.js +534 -0
  34. package/src/crypto.js +130 -0
  35. package/src/export-import.js +200 -0
  36. package/src/git-sync.js +444 -0
  37. package/src/index-manager.js +205 -18
  38. package/src/installer.js +384 -0
  39. package/src/pinning.js +124 -0
  40. package/src/scorer.js +8 -2
  41. package/src/skills.js +208 -0
  42. package/src/tfidf.js +408 -0
  43. package/hooks/session-end.md +0 -48
  44. package/hooks/session-start.md +0 -48
@@ -0,0 +1,178 @@
1
+ # Brain Memory System
2
+
3
+ This project uses the **Brain Memory** plugin — a hierarchical, file-system-based memory system that mimics human cognition with neuroscience-inspired mechanisms including associative networks, spreading activation, context-dependent recall, spaced reinforcement, and cognitive memory types.
4
+
5
+ ## Memory Location
6
+
7
+ All memories are stored in a single global `~/.brain/` directory in the user's home folder, shared across all projects and all supported AI agents. The directory uses a deep nested structure organized by life domains (professional, personal, social, family) with on-demand subcategories.
8
+
9
+ ## How It Works
10
+
11
+ ### Memory Format
12
+ Each memory is a Markdown file with YAML frontmatter containing: `id`, `type`, `cognitive_type` (episodic/semantic/procedural), `created`, `last_accessed`, `access_count`, `recall_history`, `strength` (0.0-1.0), `decay_rate` (per day), `salience` (0.0-1.0), `confidence` (0.0-1.0), `tags`, `related` memory IDs, `source`, and `encoding_context`.
13
+
14
+ ### Strength & Decay Model
15
+ - Memories have a base `strength` set at creation based on their impact/type/cognitive type
16
+ - Strength decays over time: `effective = strength * (decay_rate ^ days_since_access)`
17
+ - Recalled memories get **stronger** via spaced reinforcement — the longer since last recall, the bigger the boost
18
+ - Memories become progressively more forgetting-resistant with each recall (decay_rate improves)
19
+ - Weak memories can be consolidated into stronger combined memories
20
+ - During sleep, global synaptic homeostasis prevents strength inflation
21
+
22
+ ### Cognitive Types
23
+ - **Episodic** — Event-specific memories. Higher initial strength, faster decay. The details fade but lessons persist.
24
+ - **Semantic** — Abstracted knowledge. Default decay. Stable long-term storage.
25
+ - **Procedural** — Skills and workflows. Lower initial strength but extremely slow decay once established.
26
+
27
+ ### Memory Types & Default Strengths
28
+ | Type | Strength | Decay/day | Description |
29
+ |------|----------|-----------|-------------|
30
+ | decision | 0.85 | 0.995 | Choices made and rationale |
31
+ | insight | 0.90 | 0.997 | Deep realizations, patterns |
32
+ | goal | 0.80 | 0.993 | Objectives and aspirations |
33
+ | experience | 0.75 | 0.985 | Notable events or processes |
34
+ | learning | 0.70 | 0.990 | New knowledge acquired |
35
+ | relationship | 0.70 | 0.997 | Connections between entities |
36
+ | preference | 0.60 | 0.998 | User preferences and style |
37
+ | observation | 0.40 | 0.950 | Casual facts or notices |
38
+
39
+ ### Associative Network
40
+ Memories are connected via weighted edges in `~/.brain/associations.json`. When you recall memory A, **spreading activation** automatically surfaces related memories B and C — just like how the brain activates linked neurons. Links are strengthened through **Hebbian learning**: memories recalled together become more tightly connected over time.
41
+
42
+ ### Context-Dependent Recall
43
+ Memories store their encoding context (project, topics, task type). During recall, memories encoded in a similar context to the current session are scored higher — matching how human memory works better when recall context matches encoding context.
44
+
45
+ ### Salience & Confidence
46
+ - **Salience** (0.0-1.0): Emotional/motivational significance. High-salience memories (>= 0.7) are never auto-pruned.
47
+ - **Confidence** (0.0-1.0): Epistemic certainty. Low-confidence memories are flagged during recall.
48
+
49
+ ## Available Commands
50
+
51
+ - `/brain:init` — Initialize the brain structure
52
+ - `/brain:memorize [topic]` — Store memories from current context
53
+ - `/brain:remember [query]` — Recall relevant memories with spreading activation and context matching
54
+ - `/brain:review [scope]` — Spaced repetition review session for due memories
55
+ - `/brain:explore [category]` — Browse the brain hierarchy
56
+ - `/brain:consolidate [scope]` — Merge related weak memories into stronger ones
57
+ - `/brain:forget [target]` — Decay or archive memories
58
+ - `/brain:sunshine [target]` — Deep forensic erasure — trace and remove all references to a memory
59
+ - `/brain:sleep [scope]` — Full maintenance cycle: replay, synaptic homeostasis, knowledge propagation, semantic crystallization, reorganize, consolidate, prune, REM dreaming, and expertise detection
60
+ - `/brain:status` — Dashboard with brain health overview
61
+ - `/brain:sync [subcommand]` — Sync memories via Git remote or export/import for portability
62
+ - `/brain:pin [id|query]` — Pin a memory to the always-present tier (CoALA Phase 1)
63
+ - `/brain:unpin [id|query]` — Remove a memory from the always-present tier
64
+ - `/brain:skills [list|show|add|use|remove|export]` — Manage procedural skills (CoALA Phase 2)
65
+
66
+ ## Session Start Behavior
67
+
68
+ **Perform these steps at session start — but keep it lightweight.**
69
+
70
+ If `~/.brain/index.json` exists:
71
+
72
+ 1. **Run the session-start aggregator** — one deterministic, budget-bounded call:
73
+ ```bash
74
+ brain session-start --project "<current project>"
75
+ ```
76
+ It returns JSON with `memory_count`, `pinned` (always-apply conventions/preferences), `skills_index` (available procedural skills — name + description only), `context_recall` (memories relevant to this project), `due_for_review`, `low_confidence_alerts`, and `budget`. If `~/.brain/index.json` is absent it returns an empty payload.
77
+ 2. **Silently internalize** the payload — treat `pinned` facts as active constraints, note which `skills_index` skills exist (load a skill's full `SKILL.md` only when a task matches it), and keep `context_recall` in mind. Do **NOT** dump contents.
78
+ 3. **Output a single status line:**
79
+
80
+ ```
81
+ 🧠 Brain active — <N> memories (<M> in project context)
82
+ ```
83
+
84
+ Only add extra lines if actionable:
85
+ - `📋 <X> due for review` — if `due_for_review > 0`
86
+ - `⚠️ <N> low-confidence memories used frequently` — if `low_confidence_alerts` is non-empty
87
+
88
+ The aggregator is budget-bounded (`~/.brain/config.json`) and never exceeds the working-memory token budget, so just internalize whatever it returns. **The goal is ambient awareness** — know about past decisions, learnings, and preferences without reciting them.
89
+
90
+ ## Ambient Session Tracking
91
+
92
+ **Throughout the session, maintain a running mental log of notable events.** This requires no file writes — just internal awareness.
93
+
94
+ Track these categories as they happen:
95
+ - **Decisions** — Architecture choices, technology selections, trade-off resolutions
96
+ - **Learnings** — New patterns, debugging insights, API discoveries
97
+ - **Insights** — Realizations about the codebase, project, or process
98
+ - **Experiences** — Significant events like incidents, deployments, milestones
99
+ - **Goals** — New objectives discussed or planned
100
+
101
+ **Why this matters:** Without active tracking, you can only evaluate what happened at session end — by which point early-session events may be forgotten or the user may have already left. By tracking as events occur, nothing is lost.
102
+
103
+ ## Periodic Memory Checkpoint
104
+
105
+ **Every ~10 substantive interactions** (file edits, architecture decisions, debugging breakthroughs, significant discussions — not trivial reads or simple answers), silently evaluate whether your ambient tracking log contains memorizable content.
106
+
107
+ If notable items have accumulated, append a **brief one-liner** at the end of your next natural response:
108
+
109
+ ```
110
+ 🧠 Notable <type(s)> this session — /brain:memorize when ready
111
+ ```
112
+
113
+ **Rules:**
114
+ - **Never interrupt flow** — only append to the end of a response the user is already receiving, never send as a standalone message
115
+ - **At most once per ~10 substantive interactions** — no spamming
116
+ - **Reset the counter** after the user runs `/brain:memorize`
117
+ - **Don't mention if nothing notable** has accumulated
118
+ - **Be specific about types** — say "decisions and learnings" not just "notable content"
119
+
120
+ ## Session End Behavior
121
+
122
+ When a session is ending (user says bye/thanks/done, conversation wraps up, or you sense the interaction is concluding), perform these steps **in order**:
123
+
124
+ ### Step 1: Save Session Context (ALWAYS — do this first)
125
+
126
+ **Immediately** append a session summary to `~/.brain/contexts.json`, even for trivial sessions. Context tracking is cheap and provides valuable recall signals for future sessions.
127
+
128
+ ```json
129
+ {
130
+ "session_id": "<timestamp-based-id>",
131
+ "started": "<session start ISO timestamp>",
132
+ "ended": "<session end ISO timestamp>",
133
+ "project": "<current project name>",
134
+ "topics": ["<key topics discussed>"],
135
+ "task_type": "<primary task type>",
136
+ "memories_created": ["<IDs of memories stored this session>"],
137
+ "memories_recalled": ["<IDs of memories retrieved this session>"],
138
+ "notable_unsaved": ["<brief descriptions of notable items NOT yet memorized>"]
139
+ }
140
+ ```
141
+
142
+ Keep only the last 20 session entries. The `notable_unsaved` field preserves what happened even if the user didn't memorize — future sessions can reference it.
143
+
144
+ ### Step 2: Suggest Memorization (if warranted)
145
+
146
+ If the session contained meaningful content based on your ambient tracking:
147
+
148
+ ```
149
+ 💡 This session contained notable <type(s)>. Would you like to store them as brain memories?
150
+ Run /brain:memorize to capture them before this context is lost.
151
+ ```
152
+
153
+ **Rules:**
154
+ - Do NOT auto-memorize without user consent
155
+ - Do NOT prompt for trivial sessions (quick fixes, typo corrections, simple questions)
156
+ - Only suggest when there is genuinely valuable context worth preserving
157
+ - **Do not wait for explicit session-end signals** — if the conversation appears to be wrapping up, save context proactively
158
+
159
+ ## When Recalling Memories
160
+
161
+ When the user asks you to "remember" something, or when context from past sessions would be helpful, use the **deterministic recall engine** instead of manually computing scores:
162
+
163
+ 1. Run `brain recall "<query>" --project <project> --task <task_type> --top 10` (or `node <install-path>/bin/recall.js`)
164
+ 2. The engine computes TF-IDF relevance, decayed strength, spreading activation, context match, and salience — all deterministically
165
+ 3. Read the top-scoring memory files and present results
166
+ 4. Run `brain reinforce <mem_id1> <mem_id2> ...` to apply spaced reinforcement and Hebbian co-retrieval strengthening
167
+ 5. If no matches, search the archive (`~/.brain/_archived/`)
168
+
169
+ The recall engine ensures **identical scoring across all agents** — Claude, Gemini, Codex, and OpenCode all get the same rankings for the same query.
170
+
171
+ ## Portable Sync
172
+
173
+ Brain memories can be synced across devices in two ways:
174
+
175
+ 1. **Git remote** — Push/pull `~/.brain/` to any private Git repository (GitHub, GitLab, Codeberg, self-hosted). Run `/brain:sync setup <url>` to configure, then use `/brain:sync push` and `/brain:sync pull`.
176
+ 2. **Export/Import** — Pack the entire `~/.brain/` into a single portable file for manual transfer. Run `/brain:sync export` and `/brain:sync import <path>`.
177
+
178
+ Both methods support optional AES-256-GCM encryption. Sync is always manual — never automatic.