brain-memory 0.1.0-beta.3 → 0.1.0-beta.31

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 (66) hide show
  1. package/CHANGELOG.md +339 -0
  2. package/README.md +400 -94
  3. package/SECURITY.md +61 -0
  4. package/assets/brand/README.md +28 -0
  5. package/assets/brand/icon-dark.svg +19 -0
  6. package/assets/brand/icon-light.svg +20 -0
  7. package/assets/brand/linkedin_cover.png +0 -0
  8. package/assets/brand/linkedin_cover_light.png +0 -0
  9. package/assets/brand/mark-dark.svg +19 -0
  10. package/assets/brand/mark-light.svg +20 -0
  11. package/assets/brand/png/icon-dark-1024.png +0 -0
  12. package/assets/brand/png/icon-dark-128.png +0 -0
  13. package/assets/brand/png/icon-dark-256.png +0 -0
  14. package/assets/brand/png/icon-dark-512.png +0 -0
  15. package/assets/brand/png/icon-dark-64.png +0 -0
  16. package/assets/brand/png/icon-light-1024.png +0 -0
  17. package/assets/brand/png/icon-light-128.png +0 -0
  18. package/assets/brand/png/icon-light-256.png +0 -0
  19. package/assets/brand/png/icon-light-512.png +0 -0
  20. package/assets/brand/png/icon-light-64.png +0 -0
  21. package/assets/brand/png/mark-dark-1024.png +0 -0
  22. package/assets/brand/png/mark-light-1024.png +0 -0
  23. package/assets/icon.png +0 -0
  24. package/assets/icon.svg +19 -0
  25. package/bin/brain.js +111 -0
  26. package/bin/cloud-sync.js +150 -0
  27. package/bin/forget.js +122 -0
  28. package/bin/install.js +229 -254
  29. package/bin/memorize.js +458 -0
  30. package/bin/pin.js +44 -0
  31. package/bin/recall.js +259 -0
  32. package/bin/reinforce.js +187 -0
  33. package/bin/session-start.js +298 -0
  34. package/bin/skill.js +67 -0
  35. package/bin/unpin.js +38 -0
  36. package/commands/brain/forget.md +245 -15
  37. package/commands/brain/memorize.md +76 -144
  38. package/commands/brain/pin.md +79 -0
  39. package/commands/brain/remember.md +48 -105
  40. package/commands/brain/skills.md +60 -0
  41. package/commands/brain/sleep.md +69 -28
  42. package/commands/brain/status.md +24 -10
  43. package/commands/brain/sync.md +386 -0
  44. package/package.json +22 -8
  45. package/prompts/antigravity.md +180 -0
  46. package/prompts/claude.md +124 -20
  47. package/prompts/openai.md +124 -20
  48. package/prompts/opencode.md +179 -0
  49. package/src/cloud-sync.js +534 -0
  50. package/src/crypto.js +130 -0
  51. package/src/export-import.js +200 -0
  52. package/src/git-sync.js +444 -0
  53. package/src/index-manager.js +219 -18
  54. package/src/installer.js +444 -0
  55. package/src/pinning.js +124 -0
  56. package/src/scorer.js +45 -11
  57. package/src/skills.js +208 -0
  58. package/src/tfidf.js +520 -0
  59. package/commands/brain/consolidate.md +0 -153
  60. package/commands/brain/explore.md +0 -79
  61. package/commands/brain/init.md +0 -157
  62. package/commands/brain/review.md +0 -130
  63. package/commands/brain/sunshine.md +0 -337
  64. package/hooks/session-end.md +0 -48
  65. package/hooks/session-start.md +0 -48
  66. package/prompts/gemini.md +0 -76
package/prompts/claude.md CHANGED
@@ -4,7 +4,7 @@ This project uses the **Brain Memory** plugin — a hierarchical, file-system-ba
4
4
 
5
5
  ## Memory Location
6
6
 
7
- All memories are stored in `.brain/` with a deep nested directory structure organized by life domains (professional, personal, social, family) with on-demand subcategories.
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
8
 
9
9
  ## How It Works
10
10
 
@@ -37,7 +37,7 @@ Each memory is a Markdown file with YAML frontmatter containing: `id`, `type`, `
37
37
  | observation | 0.40 | 0.950 | Casual facts or notices |
38
38
 
39
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.
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
41
 
42
42
  ### Context-Dependent Recall
43
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.
@@ -48,28 +48,132 @@ Memories store their encoding context (project, topics, task type). During recal
48
48
 
49
49
  ## Available Commands
50
50
 
51
- - `/brain:init` — Initialize the brain structure
52
- - `/brain:memorize [topic]` — Store memories from current context
51
+ The everyday loop is **ambient** — `remember` and `memorize` run automatically at session start/end; you rarely type them.
52
+
53
+ **Core**
53
54
  - `/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
55
+ - `/brain:memorize [topic]` — Store memories from the current context
60
56
  - `/brain:status` — Dashboard with brain health overview
57
+ - `/brain:pin [id|query]` — Pin a memory to the always-present tier (toggle — also unpins, e.g. `--off`)
58
+ - `/brain:forget [target]` — Decay or archive memories (`--deep` = forensic erasure of every reference)
59
+
60
+ **Sync & skills**
61
+ - `/brain:sync [subcommand]` — Sync via Brain Cloud, Git remote, or export/import (auto-initializes on first run)
62
+ - `/brain:skills [list|show|add|use|remove|export]` — Manage procedural skills
63
+
64
+ **Maintenance (usually automatic — runs in the background)**
65
+ - `/brain:sleep [scope]` — Full maintenance cycle: replay, homeostasis, propagation, crystallization, reorganize, consolidate, prune, review reinforcement, REM dreaming, expertise detection
66
+
67
+ ## Session Start Behavior
68
+
69
+ **Perform these steps at session start — but keep it lightweight.**
70
+
71
+ If `~/.brain/index.json` exists:
72
+
73
+ 1. **Run the session-start aggregator** — one deterministic, budget-bounded call:
74
+ ```bash
75
+ brain session-start --project "<current project>"
76
+ ```
77
+ 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.
78
+ 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.
79
+ 3. **Output a single status line:**
80
+
81
+ ```
82
+ ◉ Brain active — <N> memories (<M> in project context)
83
+ ```
84
+
85
+ Only add extra lines if actionable:
86
+ - `📋 <X> due for review` — if `due_for_review > 0`
87
+ - `⚠️ <N> low-confidence memories used frequently` — if `low_confidence_alerts` is non-empty
88
+
89
+ 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.
90
+
91
+ ## Ambient Session Tracking
92
+
93
+ **Throughout the session, maintain a running mental log of notable events.** This requires no file writes — just internal awareness.
94
+
95
+ Track these categories as they happen:
96
+ - **Decisions** — Architecture choices, technology selections, trade-off resolutions
97
+ - **Learnings** — New patterns, debugging insights, API discoveries
98
+ - **Insights** — Realizations about the codebase, project, or process
99
+ - **Experiences** — Significant events like incidents, deployments, milestones
100
+ - **Goals** — New objectives discussed or planned
101
+
102
+ **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.
103
+
104
+ ## Periodic Memory Checkpoint
105
+
106
+ **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.
107
+
108
+ If notable items have accumulated, append a **brief one-liner** at the end of your next natural response:
61
109
 
62
- ## Auto-Memorize Guidance
110
+ ```
111
+ ◉ Notable <type(s)> this session — /brain:memorize when ready
112
+ ```
63
113
 
64
- At the end of significant sessions, consider suggesting `/brain:memorize` to the user if important decisions, learnings, or insights occurred during the conversation. Do NOT automatically memorize without the user's awareness.
114
+ **Rules:**
115
+ - **Never interrupt flow** — only append to the end of a response the user is already receiving, never send as a standalone message
116
+ - **At most once per ~10 substantive interactions** — no spamming
117
+ - **Reset the counter** after the user runs `/brain:memorize`
118
+ - **Don't mention if nothing notable** has accumulated
119
+ - **Be specific about types** — say "decisions and learnings" not just "notable content"
120
+
121
+ ## Session End Behavior
122
+
123
+ 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**:
124
+
125
+ ### Step 1: Save Session Context (ALWAYS — do this first)
126
+
127
+ **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.
128
+
129
+ ```json
130
+ {
131
+ "session_id": "<timestamp-based-id>",
132
+ "started": "<session start ISO timestamp>",
133
+ "ended": "<session end ISO timestamp>",
134
+ "project": "<current project name>",
135
+ "topics": ["<key topics discussed>"],
136
+ "task_type": "<primary task type>",
137
+ "memories_created": ["<IDs of memories stored this session>"],
138
+ "memories_recalled": ["<IDs of memories retrieved this session>"],
139
+ "notable_unsaved": ["<brief descriptions of notable items NOT yet memorized>"]
140
+ }
141
+ ```
142
+
143
+ 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.
144
+
145
+ ### Step 2: Suggest Memorization (if warranted)
146
+
147
+ If the session contained meaningful content based on your ambient tracking:
148
+
149
+ ```
150
+ 💡 This session contained notable <type(s)>. Would you like to store them as brain memories?
151
+ Run /brain:memorize to capture them before this context is lost.
152
+ ```
153
+
154
+ **Rules:**
155
+ - Do NOT auto-memorize without user consent
156
+ - Do NOT prompt for trivial sessions (quick fixes, typo corrections, simple questions)
157
+ - Only suggest when there is genuinely valuable context worth preserving
158
+ - **Do not wait for explicit session-end signals** — if the conversation appears to be wrapping up, save context proactively
65
159
 
66
160
  ## When Recalling Memories
67
161
 
68
- When the user asks you to "remember" something, or when context from past sessions would be helpful:
69
- 1. Check `.brain/index.json` for relevant memories
70
- 2. Load `.brain/associations.json` for spreading activation
71
- 3. Score by v4 formula: `0.38*relevance + 0.18*decayed_strength + 0.08*recency + 0.14*spreading_bonus + 0.14*context_match + 0.08*salience`
72
- 4. Return strong individual matches or synthesize from multiple related memories
73
- 5. Apply spaced reinforcement (spacing-aware boost) and improve decay rate
74
- 6. Strengthen Hebbian links between co-retrieved memories
75
- 7. If no active matches, search the archive (`.brain/_archived/`)
162
+ 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:
163
+
164
+ 1. Run `brain recall "<query>" --project <project> --task <task_type> --top 10` (or `node <install-path>/bin/recall.js`)
165
+ 2. The engine computes TF-IDF relevance, decayed strength, spreading activation, context match, and salience — all deterministically
166
+ 3. Read the top-scoring memory files and present results
167
+ 4. Run `brain reinforce <mem_id1> <mem_id2> ...` to apply spaced reinforcement and Hebbian co-retrieval strengthening
168
+ 5. If no matches, search the archive (`~/.brain/_archived/`)
169
+
170
+ The recall engine ensures **identical scoring across all agents** — Claude, Gemini, and Codex all get the same rankings for the same query.
171
+
172
+ ## Portable Sync
173
+
174
+ Brain memories can be synced across devices in two ways:
175
+
176
+ 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`.
177
+ 2. **Export/Import** — Pack the entire `~/.brain/` into a single portable file for manual transfer. Run `/brain:sync export` and `/brain:sync import <path>`.
178
+
179
+ Both methods support optional AES-256-GCM encryption. Sync is always manual — never automatic.
package/prompts/openai.md CHANGED
@@ -4,7 +4,7 @@ This project uses the **Brain Memory** plugin — a hierarchical, file-system-ba
4
4
 
5
5
  ## Memory Location
6
6
 
7
- All memories are stored in `.brain/` with a deep nested directory structure organized by life domains (professional, personal, social, family) with on-demand subcategories.
7
+ All memories are stored in `~/.brain/` with a deep nested directory structure organized by life domains (professional, personal, social, family) with on-demand subcategories.
8
8
 
9
9
  ## How It Works
10
10
 
@@ -37,7 +37,7 @@ Each memory is a Markdown file with YAML frontmatter containing: `id`, `type`, `
37
37
  | observation | 0.40 | 0.950 | Casual facts or notices |
38
38
 
39
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.
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
41
 
42
42
  ### Context-Dependent Recall
43
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.
@@ -49,28 +49,132 @@ Memories store their encoding context (project, topics, task type). During recal
49
49
  ## Available Commands
50
50
 
51
51
  Brain skills are available via `/brain-` prefix:
52
- - `/brain-init` — Initialize the brain structure
53
- - `/brain-memorize [topic]` — Store memories from current context
52
+ The everyday loop is **ambient** — `remember` and `memorize` run automatically at session start/end; you rarely type them.
53
+
54
+ Core:
54
55
  - `/brain-remember [query]` — Recall relevant memories with spreading activation and context matching
55
- - `/brain-review [scope]` — Spaced repetition review session for due memories
56
- - `/brain-explore [category]` — Browse the brain hierarchy
57
- - `/brain-consolidate [scope]` — Merge related weak memories into stronger ones
58
- - `/brain-forget [target]` — Decay or archive memories
59
- - `/brain-sunshine [target]` — Deep forensic erasure — trace and remove all references to a memory
60
- - `/brain-sleep [scope]` — Full maintenance cycle: replay, synaptic homeostasis, knowledge propagation, semantic crystallization, reorganize, consolidate, prune, REM dreaming, and expertise detection
56
+ - `/brain-memorize [topic]` — Store memories from the current context
61
57
  - `/brain-status` — Dashboard with brain health overview
58
+ - `/brain-pin [id|query]` — Pin a memory to the always-present tier (toggle — also unpins, e.g. `--off`)
59
+ - `/brain-forget [target]` — Decay or archive memories (`--deep` = forensic erasure of every reference)
60
+
61
+ Sync & skills:
62
+ - `/brain-sync [subcommand]` — Sync via Brain Cloud, Git remote, or export/import (auto-initializes on first run)
63
+ - `/brain-skills [list|show|add|use|remove|export]` — Manage procedural skills
64
+
65
+ Maintenance (usually automatic — runs in the background):
66
+ - `/brain-sleep [scope]` — Full maintenance cycle: replay, homeostasis, propagation, crystallization, reorganize, consolidate, prune, review reinforcement, REM dreaming, expertise detection
67
+
68
+ ## Session Start Behavior
69
+
70
+ **Perform these steps at session start — but keep it lightweight.**
71
+
72
+ If `~/.brain/index.json` exists:
73
+
74
+ 1. **Run the session-start aggregator** — one deterministic, budget-bounded call:
75
+ ```bash
76
+ brain session-start --project "<current project>"
77
+ ```
78
+ 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.
79
+ 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.
80
+ 3. **Output a single status line:**
81
+
82
+ ```
83
+ ◉ Brain active — <N> memories (<M> in project context)
84
+ ```
85
+
86
+ Only add extra lines if actionable:
87
+ - `📋 <X> due for review` — if `due_for_review > 0`
88
+ - `⚠️ <N> low-confidence memories used frequently` — if `low_confidence_alerts` is non-empty
89
+
90
+ 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.
91
+
92
+ ## Ambient Session Tracking
93
+
94
+ **Throughout the session, maintain a running mental log of notable events.** This requires no file writes — just internal awareness.
95
+
96
+ Track these categories as they happen:
97
+ - **Decisions** — Architecture choices, technology selections, trade-off resolutions
98
+ - **Learnings** — New patterns, debugging insights, API discoveries
99
+ - **Insights** — Realizations about the codebase, project, or process
100
+ - **Experiences** — Significant events like incidents, deployments, milestones
101
+ - **Goals** — New objectives discussed or planned
102
+
103
+ **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.
104
+
105
+ ## Periodic Memory Checkpoint
106
+
107
+ **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.
108
+
109
+ If notable items have accumulated, append a **brief one-liner** at the end of your next natural response:
62
110
 
63
- ## Auto-Memorize Guidance
111
+ ```
112
+ ◉ Notable <type(s)> this session — /brain-memorize when ready
113
+ ```
64
114
 
65
- At the end of significant sessions, consider suggesting `/brain-memorize` to the user if important decisions, learnings, or insights occurred during the conversation. Do NOT automatically memorize without the user's awareness.
115
+ **Rules:**
116
+ - **Never interrupt flow** — only append to the end of a response the user is already receiving, never send as a standalone message
117
+ - **At most once per ~10 substantive interactions** — no spamming
118
+ - **Reset the counter** after the user runs `/brain-memorize`
119
+ - **Don't mention if nothing notable** has accumulated
120
+ - **Be specific about types** — say "decisions and learnings" not just "notable content"
121
+
122
+ ## Session End Behavior
123
+
124
+ 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**:
125
+
126
+ ### Step 1: Save Session Context (ALWAYS — do this first)
127
+
128
+ **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.
129
+
130
+ ```json
131
+ {
132
+ "session_id": "<timestamp-based-id>",
133
+ "started": "<session start ISO timestamp>",
134
+ "ended": "<session end ISO timestamp>",
135
+ "project": "<current project name>",
136
+ "topics": ["<key topics discussed>"],
137
+ "task_type": "<primary task type>",
138
+ "memories_created": ["<IDs of memories stored this session>"],
139
+ "memories_recalled": ["<IDs of memories retrieved this session>"],
140
+ "notable_unsaved": ["<brief descriptions of notable items NOT yet memorized>"]
141
+ }
142
+ ```
143
+
144
+ 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.
145
+
146
+ ### Step 2: Suggest Memorization (if warranted)
147
+
148
+ If the session contained meaningful content based on your ambient tracking:
149
+
150
+ ```
151
+ 💡 This session contained notable <type(s)>. Would you like to store them as brain memories?
152
+ Run /brain-memorize to capture them before this context is lost.
153
+ ```
154
+
155
+ **Rules:**
156
+ - Do NOT auto-memorize without user consent
157
+ - Do NOT prompt for trivial sessions (quick fixes, typo corrections, simple questions)
158
+ - Only suggest when there is genuinely valuable context worth preserving
159
+ - **Do not wait for explicit session-end signals** — if the conversation appears to be wrapping up, save context proactively
66
160
 
67
161
  ## When Recalling Memories
68
162
 
69
- When the user asks you to "remember" something, or when context from past sessions would be helpful:
70
- 1. Check `.brain/index.json` for relevant memories
71
- 2. Load `.brain/associations.json` for spreading activation
72
- 3. Score by v4 formula: `0.38*relevance + 0.18*decayed_strength + 0.08*recency + 0.14*spreading_bonus + 0.14*context_match + 0.08*salience`
73
- 4. Return strong individual matches or synthesize from multiple related memories
74
- 5. Apply spaced reinforcement (spacing-aware boost) and improve decay rate
75
- 6. Strengthen Hebbian links between co-retrieved memories
76
- 7. If no active matches, search the archive (`.brain/_archived/`)
163
+ 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:
164
+
165
+ 1. Run `brain recall "<query>" --project <project> --task <task_type> --top 10` (or `node <install-path>/bin/recall.js`)
166
+ 2. The engine computes TF-IDF relevance, decayed strength, spreading activation, context match, and salience — all deterministically
167
+ 3. Read the top-scoring memory files and present results
168
+ 4. Run `brain reinforce <mem_id1> <mem_id2> ...` to apply spaced reinforcement and Hebbian co-retrieval strengthening
169
+ 5. If no matches, search the archive (`~/.brain/_archived/`)
170
+
171
+ The recall engine ensures **identical scoring across all agents** — Claude, Gemini, and Codex all get the same rankings for the same query.
172
+
173
+ ## Portable Sync
174
+
175
+ Brain memories can be synced across devices in two ways:
176
+
177
+ 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`.
178
+ 2. **Export/Import** — Pack the entire `~/.brain/` into a single portable file for manual transfer. Run `/brain-sync export` and `/brain-sync import <path>`.
179
+
180
+ Both methods support optional AES-256-GCM encryption. Sync is always manual — never automatic.
@@ -0,0 +1,179 @@
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
+ The everyday loop is **ambient** — `remember` and `memorize` run automatically at session start/end; you rarely type them.
52
+
53
+ **Core**
54
+ - `/brain:remember [query]` — Recall relevant memories with spreading activation and context matching
55
+ - `/brain:memorize [topic]` — Store memories from the current context
56
+ - `/brain:status` — Dashboard with brain health overview
57
+ - `/brain:pin [id|query]` — Pin a memory to the always-present tier (toggle — also unpins, e.g. `--off`)
58
+ - `/brain:forget [target]` — Decay or archive memories (`--deep` = forensic erasure of every reference)
59
+
60
+ **Sync & skills**
61
+ - `/brain:sync [subcommand]` — Sync via Brain Cloud, Git remote, or export/import (auto-initializes on first run)
62
+ - `/brain:skills [list|show|add|use|remove|export]` — Manage procedural skills
63
+
64
+ **Maintenance (usually automatic — runs in the background)**
65
+ - `/brain:sleep [scope]` — Full maintenance cycle: replay, homeostasis, propagation, crystallization, reorganize, consolidate, prune, review reinforcement, REM dreaming, expertise detection
66
+
67
+ ## Session Start Behavior
68
+
69
+ **Perform these steps at session start — but keep it lightweight.**
70
+
71
+ If `~/.brain/index.json` exists:
72
+
73
+ 1. **Run the session-start aggregator** — one deterministic, budget-bounded call:
74
+ ```bash
75
+ brain session-start --project "<current project>"
76
+ ```
77
+ 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.
78
+ 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.
79
+ 3. **Output a single status line:**
80
+
81
+ ```
82
+ ◉ Brain active — <N> memories (<M> in project context)
83
+ ```
84
+
85
+ Only add extra lines if actionable:
86
+ - `📋 <X> due for review` — if `due_for_review > 0`
87
+ - `⚠️ <N> low-confidence memories used frequently` — if `low_confidence_alerts` is non-empty
88
+
89
+ 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.
90
+
91
+ ## Ambient Session Tracking
92
+
93
+ **Throughout the session, maintain a running mental log of notable events.** This requires no file writes — just internal awareness.
94
+
95
+ Track these categories as they happen:
96
+ - **Decisions** — Architecture choices, technology selections, trade-off resolutions
97
+ - **Learnings** — New patterns, debugging insights, API discoveries
98
+ - **Insights** — Realizations about the codebase, project, or process
99
+ - **Experiences** — Significant events like incidents, deployments, milestones
100
+ - **Goals** — New objectives discussed or planned
101
+
102
+ **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.
103
+
104
+ ## Periodic Memory Checkpoint
105
+
106
+ **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.
107
+
108
+ If notable items have accumulated, append a **brief one-liner** at the end of your next natural response:
109
+
110
+ ```
111
+ ◉ Notable <type(s)> this session — /brain:memorize when ready
112
+ ```
113
+
114
+ **Rules:**
115
+ - **Never interrupt flow** — only append to the end of a response the user is already receiving, never send as a standalone message
116
+ - **At most once per ~10 substantive interactions** — no spamming
117
+ - **Reset the counter** after the user runs `/brain:memorize`
118
+ - **Don't mention if nothing notable** has accumulated
119
+ - **Be specific about types** — say "decisions and learnings" not just "notable content"
120
+
121
+ ## Session End Behavior
122
+
123
+ 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**:
124
+
125
+ ### Step 1: Save Session Context (ALWAYS — do this first)
126
+
127
+ **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.
128
+
129
+ ```json
130
+ {
131
+ "session_id": "<timestamp-based-id>",
132
+ "started": "<session start ISO timestamp>",
133
+ "ended": "<session end ISO timestamp>",
134
+ "project": "<current project name>",
135
+ "topics": ["<key topics discussed>"],
136
+ "task_type": "<primary task type>",
137
+ "memories_created": ["<IDs of memories stored this session>"],
138
+ "memories_recalled": ["<IDs of memories retrieved this session>"],
139
+ "notable_unsaved": ["<brief descriptions of notable items NOT yet memorized>"]
140
+ }
141
+ ```
142
+
143
+ 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.
144
+
145
+ ### Step 2: Suggest Memorization (if warranted)
146
+
147
+ If the session contained meaningful content based on your ambient tracking:
148
+
149
+ ```
150
+ 💡 This session contained notable <type(s)>. Would you like to store them as brain memories?
151
+ Run /brain:memorize to capture them before this context is lost.
152
+ ```
153
+
154
+ **Rules:**
155
+ - Do NOT auto-memorize without user consent
156
+ - Do NOT prompt for trivial sessions (quick fixes, typo corrections, simple questions)
157
+ - Only suggest when there is genuinely valuable context worth preserving
158
+ - **Do not wait for explicit session-end signals** — if the conversation appears to be wrapping up, save context proactively
159
+
160
+ ## When Recalling Memories
161
+
162
+ 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:
163
+
164
+ 1. Run `brain recall "<query>" --project <project> --task <task_type> --top 10` (or `node <install-path>/bin/recall.js`)
165
+ 2. The engine computes TF-IDF relevance, decayed strength, spreading activation, context match, and salience — all deterministically
166
+ 3. Read the top-scoring memory files and present results
167
+ 4. Run `brain reinforce <mem_id1> <mem_id2> ...` to apply spaced reinforcement and Hebbian co-retrieval strengthening
168
+ 5. If no matches, search the archive (`~/.brain/_archived/`)
169
+
170
+ The recall engine ensures **identical scoring across all agents** — Claude, Gemini, Codex, and OpenCode all get the same rankings for the same query.
171
+
172
+ ## Portable Sync
173
+
174
+ Brain memories can be synced across devices in two ways:
175
+
176
+ 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`.
177
+ 2. **Export/Import** — Pack the entire `~/.brain/` into a single portable file for manual transfer. Run `/brain:sync export` and `/brain:sync import <path>`.
178
+
179
+ Both methods support optional AES-256-GCM encryption. Sync is always manual — never automatic.