Here's a polished, consistent README for mem-review v1.0 — aligned with the Ravenclaw 🦅 style we've built across the toolchain (backup-md, code-gen, cron-hub, git-agent, heartbeat-hub, etc.):
# mem-review 🧠 v1.0
**Daily memory consolidation agent**
Scans `memory/*.md` files (daily notes, observations, insights), extracts key takeaways, and merges them intelligently into a single evergreen `MEMORY.md` file.
Your second brain's nightly gardener — keeping the vault sharp, compressed, and searchable.
## 🚀 Quickstart
```bash
cd ~/tools/projects/mem-review
npm install
npm link # → ~/bin/mem-review
# Dry-run preview of today's insights
mem-review review
# Actually update MEMORY.md (with confirmation)
mem-review update
# Safe first look (recommended!)
mem-review update --dry
📋 Commands
| Command | Description |
|---|---|
mem-review review |
Scan recent memory/*.md files → show extracted snippets & potential merges |
mem-review update |
Extract insights → append/merge to MEMORY.md (interactive or --yes) |
mem-review update --dry |
Preview changes without writing (safe default behavior in early versions) |
mem-review stats |
Basic stats: file count, word count, last review date (planned) |
✨ Features (v1.0)
- Recursively finds all
.mdin~/memory/(or custom path via env/config) - Simple extraction: headers, bullet points, bold/italic highlights
- Stub merge logic: appends dated section to
MEMORY.md - Dry-run mode prevents accidental overwrites
- Timestamped backups of
MEMORY.mdbefore changes (via backup-md integration potential)
Example review output snippet:
Reviewing 7 files from last 24h...
memory/2026-02-07.md
• New agent: git-grind – auto PR workflow
• Insight: Weekly git-agent grind ritual → reduces drift
memory/2026-02-08.md
• Heartbeat scan: disk 78% → cleanup needed
• Weather note: Atlanta 42°F, rainy – indoor grind day
Potential MEMORY.md additions (3 items):
- 2026-02-07: Added git-grind to Pro Tools phase
- 2026-02-08: Disk warning – integrate with heartbeat-hub fix
- 2026-02-08: Ravenclaw daily ritual confirmed
🧪 Tests
node test/review.test.js # Basic scan + extraction stubs (TODO: expand with jest/mocha)
# or: npm test (once package.json configured)
🔧 Built With / Planned
- fs-extra + glob — file discovery
- marked or remark — markdown parsing (for smarter extraction)
- yargs — CLI interface
- Future: LLM integration (via local model or API) for semantic summarization & deduplication
🚀 Roadmap
| Version | Status | Key Features |
|---|---|---|
| v1.0 | ✅ Live | Basic scan/review + stub update to MEMORY.md |
| v1.1 | Planned | Semantic scoring (dupe detection), better extraction |
| v1.2 | Idea | LLM-powered summaries, conflict-aware merge, tagging |
| v2.0 | Future | Full auto-merge, graph updates, Obsidian plugin hooks |
mem-review v1.0 is live — distilling chaos into clarity.
One daily pass keeps the second brain immortal. 🧠🦅
Grind on.
Last updated: 2026-02-08
### Compact / quick-scan version (for personal notes or dashboard)
```markdown
# mem-review 🧠 v1.0
Daily memory → evergreen MEMORY.md
```bash
mem-review review # preview insights
mem-review update # merge to MEMORY.md
mem-review update --dry
Roadmap
v1.0 ✓ scan + basic merge
v1.1 → semantic dedupe
v1.2 → LLM summaries
v2 → auto + graph
Live & consolidating since 2026-02-08 🧠
Fits perfectly into the ecosystem — imagine cron-hub scheduling it daily + heartbeat-hub reporting on memory health.
Want:
- a mocked MEMORY.md before/after diff?
- Obsidian graph tie-in notes?
- raven brain ASCII art header?
Or drop the next tool (node-watch? sys-health? tts-queue?) — we're building momentum! 🦅