memoir-cli 3.2.0 → 3.2.2

package/README.md

@@ -2,52 +2,95 @@
 
 # memoir
 
-**AI tools forget you. memoir doesn't.**
+**Persistent memory for AI coding tools.**
 
 [![npm version](https://img.shields.io/npm/v/memoir-cli.svg?style=flat-square&color=7c6ef0)](https://npmjs.org/package/memoir-cli)
 [![npm downloads](https://img.shields.io/npm/dm/memoir-cli.svg?style=flat-square&color=7c6ef0)](https://npmjs.org/package/memoir-cli)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 [![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen?style=flat-square)](https://nodejs.org)
 
-Sync memory across 11 AI tools. Search it all from your editor via MCP. One CLI, every device.
+Your AI forgets everything between sessions. memoir gives it long-term memory via MCP.
+
+Works with Claude Code, Cursor, Windsurf, Gemini, and 7 more tools.
 
 [Website](https://memoir.sh) • [npm](https://npmjs.org/package/memoir-cli) • [Blog](https://memoir.sh/blog)
 
 <br />
 
+<img src="demo.svg" alt="memoir demo — push, restore, and sync AI memory" width="700" />
+
 </div>
 
 ## The Problem
 
-You spend weeks teaching Claude how you code. Your projects are dialed in. Your AI knows your stack, your decisions, your preferences.
+You told Claude your project uses Zustand, not Redux. You explained your auth middleware to Cursor. You spent weeks building up context across your AI tools.
 
-Then you switch machines. **Everything is gone.** Your AI has amnesia. Your projects aren't there. You start from zero.
+Next session? **Gone.** New machine? **Gone.** Switch tools? **Gone.**
 
-## The Fix
+## How memoir fixes it
 
-```bash
-# On your main machine
-memoir push
+memoir is a **persistent memory layer** that runs via [MCP](https://modelcontextprotocol.io) inside your AI tools. Your AI can search, read, and save memories automatically — across sessions, tools, and machines.
 
-# On any other machine
+```
+you: how does auth work in this project?
+
+  memoir_recall("auth setup architecture")
+  Found 3 memories matching "auth"
+
+claude: Based on your previous sessions: this project uses JWT auth
+  with refresh tokens, the middleware is in src/middleware/auth.ts,
+  and you chose Zustand over Redux for auth state (decided March 12).
+```
+
+No re-explaining. memoir remembered.
+
+## Quick Start
+
+```bash
+# Install
 npm install -g memoir-cli
-memoir restore -y
 
-# Done. Everything's back:
-# ✔ AI memory restored (Claude, Gemini, Cursor, 11 tools)
-# ✔ 44 projects cloned & unpacked
-# ✔ Uncommitted changes applied
-# ✔ Session context injected — AI picks up mid-conversation
+# Setup
+memoir init
+```
+
+### Add MCP to your AI tools
+
+**Claude Code** — add to `~/.mcp.json`:
+```json
+{
+  "mcpServers": {
+    "memoir": { "command": "memoir-mcp" }
+  }
+}
+```
+
+**Cursor** — add to `.cursor/mcp.json`:
+```json
+{
+  "mcpServers": {
+    "memoir": { "command": "memoir-mcp" }
+  }
+}
 ```
 
-One command to save. One command to restore. That's it.
+That's it. Your AI tools now have 6 memory abilities:
+
+| MCP Tool | What it does |
+|----------|-------------|
+| `memoir_recall` | Search across all your AI memories |
+| `memoir_remember` | Save context for future sessions |
+| `memoir_list` | Browse all memory files by tool |
+| `memoir_read` | Read a specific memory in full |
+| `memoir_status` | See which AI tools are detected |
+| `memoir_profiles` | Switch between work/personal |
 
 ## What Gets Synced
 
 memoir syncs three layers that no other tool connects:
 
-### Layer 1: AI Memory
-Your AI tool configs, preferences, and project knowledge across 11 tools.
+### Layer 1: AI Memory (via MCP + CLI)
+Configs, instructions, and project knowledge across 11 tools — searchable and writable from inside any AI conversation.
 
 | Tool | What gets synced |
 |------|-----------------|
@@ -71,7 +114,7 @@ What you were **doing** — not just what your AI knows, but the active context.
 - Injected into your AI on restore so it picks up mid-conversation
 - Secrets auto-redacted (API keys, tokens, passwords stripped before sync)
 
-### Layer 3: Workspace (NEW in v3.1)
+### Layer 3: Workspace
 Your actual projects — code, files, everything.
 
 - **Git projects:** Remote URLs saved, auto-cloned on restore
@@ -79,76 +122,10 @@ Your actual projects — code, files, everything.
 - **Uncommitted work:** Saved as patches, applied after clone
 - **Zero git commands needed** — memoir handles it all
 
-```
-memoir push on Mac:
-  ✔ AI memory backed up
-  ✔ Session context captured
-  ✔ Workspace: 44 projects (17 git, 23 bundled)
-  🔒 E2E encrypted
-
-memoir restore on Windows:
-  ✔ AI memory restored
-  ✔ stock-market-book → C:\Users\You\stock-market-book (cloned)
-  ✔ socialslink → C:\Users\You\socialslink (cloned)
-  ✔ btc-trader → C:\Users\You\btc-trader (unpacked)
-  ✔ 41 more projects restored
-  📋 Session context injected — Claude picks up where you left off
-```
-
-## Quick Start
-
-```bash
-# Install
-npm install -g memoir-cli
-
-# First-time setup
-memoir init
-
-# Back up everything
-memoir push
-
-# Restore on any machine
-memoir restore
-```
-
-## MCP Server (NEW in v3.2)
-
-memoir ships an MCP server so your AI tools can search, read, and save memories without leaving the conversation.
-
-```bash
-# Start the server
-memoir mcp
-```
-
-**Claude Code** — add to `~/.mcp.json`:
-```json
-{
-  "mcpServers": {
-    "memoir": { "command": "memoir-mcp" }
-  }
-}
-```
-
-**Cursor** — add to `.cursor/mcp.json`:
-```json
-{
-  "mcpServers": {
-    "memoir": { "command": "memoir-mcp" }
-  }
-}
-```
-
-Your editor gets 6 tools: `memoir_recall` (search all memories), `memoir_remember` (save context), `memoir_list`, `memoir_read`, `memoir_status`, and `memoir_profiles`. Zero cost — runs locally.
-
 ## Key Features
 
-### Workspace sync
-```bash
-memoir push     # scans all projects, saves git URLs + bundles non-git projects
-memoir restore  # auto-clones repos, unpacks bundles, applies uncommitted patches
-```
-
-No manual git commands. memoir detects your projects, tracks their remotes, and restores them anywhere.
+### Cross-tool memory
+Tell Claude something once. Cursor knows it too. memoir is the shared memory layer between all your AI tools.
 
 ### Translate between AI tools
 ```bash
@@ -159,13 +136,17 @@ memoir migrate --from chatgpt --to all
 # Translate to every tool at once
 ```
 
-### Session handoff
+### Cross-machine sync
 ```bash
-# Capture your session (automatic on push, or manual)
-memoir snapshot
+# On your main machine
+memoir push
 
-# Pick up on another machine
-memoir resume --inject --to claude
+# On any other machine
+memoir restore -y
+# ✔ AI memory restored (Claude, Gemini, Cursor, 11 tools)
+# ✔ 44 projects cloned & unpacked
+# ✔ Uncommitted changes applied
+# ✔ Session context injected — AI picks up mid-conversation
 ```
 
 ### E2E Encryption
@@ -174,7 +155,7 @@ memoir encrypt    # toggle encryption on/off
 memoir push       # prompted for passphrase, AES-256-GCM encrypted
 ```
 
-Your backup is encrypted before it leaves your machine. Even if your storage is compromised, your data is safe. Secret scanning auto-redacts API keys, tokens, and passwords.
+Your backup is encrypted before it leaves your machine. Secret scanning auto-redacts API keys, tokens, and passwords.
 
 ### Profiles (personal / work)
 ```bash
@@ -183,26 +164,15 @@ memoir push --profile work
 memoir profile switch personal
 ```
 
-Each profile has its own repo and tool filters. Work configs never mix with personal.
-
-### Cloud sync (Pro)
+### Cloud sync
 ```bash
 memoir login
 memoir cloud push      # encrypted cloud backup
 memoir cloud restore   # restore from any version
-memoir history         # view all backup versions
 ```
 
 ### Cross-platform (Mac / Windows / Linux)
-```bash
-# Push from Mac
-memoir push
-
-# Restore on Windows — paths remap automatically
-memoir restore
-```
-
-Claude's memory paths are automatically remapped between platforms. Projects are cloned to the right locations. It just works.
+Paths remap automatically between platforms. Push from Mac, restore on Windows. It just works.
 
 ## All Commands
 
@@ -211,6 +181,7 @@ Claude's memory paths are automatically remapped between platforms. Projects are
 | `memoir init` | Setup wizard — GitHub or local storage |
 | `memoir push` | Back up AI memory + workspace + session |
 | `memoir restore` | Restore everything on a new machine |
+| `memoir mcp` | Start MCP server for editor integration |
 | `memoir status` | Show detected AI tools |
 | `memoir doctor` | Diagnose issues, scan for secrets |
 | `memoir view` | Preview what's in your backup |
@@ -224,41 +195,44 @@ Claude's memory paths are automatically remapped between platforms. Projects are
 | `memoir cloud restore` | Restore from memoir cloud |
 | `memoir history` | View cloud backup versions |
 | `memoir login` | Sign in to memoir cloud |
-| `memoir mcp` | Start MCP server for editor integration |
+| `memoir share` | Create encrypted shareable link |
+| `memoir upgrade` | View plans and upgrade |
 | `memoir update` | Self-update to latest version |
 
 ## How memoir compares
 
 | Feature | memoir | dotfiles managers | ai-rulez | memories.sh |
 |---------|--------|-------------------|----------|-------------|
+| MCP memory layer | **6 tools** | No | No | No |
 | AI memory sync | **11 tools** | No | 18 tools | 3 tools |
+| Cross-tool recall | **Yes** | No | No | No |
 | Workspace sync | **Yes** | No | No | No |
 | Session handoff | **Yes** | No | No | No |
-| AI-powered translation | **Yes** | No | No | No |
+| AI-powered migration | **Yes** | No | No | No |
 | E2E encryption | **Yes** | No | No | No |
 | Secret scanning | **Yes** | Some | No | No |
 | Cross-platform remap | **Yes** | Some | No | No |
-| Uncommitted work patches | **Yes** | No | No | No |
 | Cloud backup | **Yes** | No | No | Yes ($15/mo) |
 | Profiles | **Yes** | No | No | No |
-| MCP server | **Yes** | No | No | No |
 | Free & open source | **Yes** | Yes | Yes | No |
 
 ## Common Workflows
 
-### New machine setup
-```bash
-# Old machine
-memoir push
+### Your AI remembers across sessions
+```
+# Monday — you explain your auth setup to Claude
+# ...Claude calls memoir_remember to save the decision
 
-# New machine — one command, everything's back
-npm install -g memoir-cli && memoir init && memoir restore -y
+# Thursday — new conversation
+you: "add a protected route"
+# Claude calls memoir_recall, finds your auth architecture
+# No re-explaining needed
 ```
 
-### Daily sync between machines
+### New machine setup
 ```bash
-memoir push      # end of day on laptop
-memoir restore   # next morning on desktop — AI knows what you were doing
+npm install -g memoir-cli && memoir init && memoir restore -y
+# Done. Everything's back.
 ```
 
 ### Switching AI tools
@@ -284,6 +258,7 @@ memoir restore --profile team
 - **Auto-redaction** — secrets stripped from session handoffs before sync
 - **No credentials synced** — .env files, auth tokens, and API keys are never included
 - **Passphrase verified** — wrong passphrase caught before decrypt attempt
+- **Local MCP server** — runs on your machine, no data sent to external services
 
 ## Requirements
 
@@ -293,7 +268,7 @@ memoir restore --profile team
 
 ## Contributing
 
-Contributions welcome — especially new tool adapters and migration improvements.
+Contributions welcome — especially new tool adapters and MCP improvements.
 
 1. Fork the repo
 2. Create your branch (`git checkout -b feature/my-feature`)

package/demo.svg

@@ -0,0 +1,201 @@
+<svg viewBox="0 0 700 1260" xmlns="http://www.w3.org/2000/svg" width="700" preserveAspectRatio="xMidYMid meet">
+  <defs>
+    <style>
+      @keyframes fadeIn {
+        0% { opacity: 0; }
+        5% { opacity: 1; }
+        100% { opacity: 1; }
+      }
+
+      @keyframes blink {
+        0%, 49%, 100% { opacity: 1; }
+        50%, 99% { opacity: 0; }
+      }
+
+      .terminal-bg { fill: #1e1e2e; }
+
+      .chrome-bar { fill: #2d2d44; }
+      .chrome-dot-red { fill: #ff5f56; }
+      .chrome-dot-yellow { fill: #ffbd2e; }
+      .chrome-dot-green { fill: #27c93f; }
+
+      .title { font-size: 24px; font-weight: bold; fill: #22d3ee; font-family: 'JetBrains Mono', monospace; }
+      .subtitle { font-size: 14px; fill: #71717a; font-family: 'JetBrains Mono', monospace; }
+      .command { font-size: 16px; fill: #e4e4e7; font-family: 'JetBrains Mono', monospace; }
+      .prompt { font-size: 16px; fill: #7c6ef0; font-family: 'JetBrains Mono', monospace; font-weight: bold; }
+      .success { font-size: 16px; fill: #4ade80; font-family: 'JetBrains Mono', monospace; }
+      .comment { font-size: 14px; fill: #eab308; font-family: 'JetBrains Mono', monospace; }
+      .dim { font-size: 14px; fill: #71717a; font-family: 'JetBrains Mono', monospace; }
+      .error { font-size: 16px; fill: #ef4444; font-family: 'JetBrains Mono', monospace; }
+
+      .line-1 { animation: fadeIn 0.3s ease-out 0.0s both; }
+      .line-2 { animation: fadeIn 0.3s ease-out 0.3s both; }
+      .line-3 { animation: fadeIn 0.3s ease-out 0.6s both; }
+      .line-4 { animation: fadeIn 0.3s ease-out 0.9s both; }
+      .line-5 { animation: fadeIn 0.3s ease-out 1.2s both; }
+      .line-6 { animation: fadeIn 0.3s ease-out 1.5s both; }
+      .line-7 { animation: fadeIn 0.3s ease-out 1.8s both; }
+      .line-8 { animation: fadeIn 0.3s ease-out 2.1s both; }
+      .line-9 { animation: fadeIn 0.3s ease-out 2.4s both; }
+      .line-10 { animation: fadeIn 0.3s ease-out 2.7s both; }
+      .line-11 { animation: fadeIn 0.3s ease-out 3.0s both; }
+      .line-12 { animation: fadeIn 0.3s ease-out 3.3s both; }
+      .line-13 { animation: fadeIn 0.3s ease-out 3.6s both; }
+      .line-14 { animation: fadeIn 0.3s ease-out 3.9s both; }
+      .line-15 { animation: fadeIn 0.3s ease-out 4.2s both; }
+      .line-16 { animation: fadeIn 0.3s ease-out 4.5s both; }
+      .line-17 { animation: fadeIn 0.3s ease-out 4.8s both; }
+      .line-18 { animation: fadeIn 0.3s ease-out 5.1s both; }
+      .line-19 { animation: fadeIn 0.3s ease-out 5.4s both; }
+      .line-20 { animation: fadeIn 0.3s ease-out 5.7s both; }
+      .line-21 { animation: fadeIn 0.3s ease-out 6.0s both; }
+      .line-22 { animation: fadeIn 0.3s ease-out 6.3s both; }
+      .line-23 { animation: fadeIn 0.3s ease-out 6.6s both; }
+      .line-24 { animation: fadeIn 0.3s ease-out 6.9s both; }
+      .line-25 { animation: fadeIn 0.3s ease-out 7.2s both; }
+      .line-26 { animation: fadeIn 0.3s ease-out 7.5s both; }
+      .line-27 { animation: fadeIn 0.3s ease-out 7.8s both; }
+      .line-28 { animation: fadeIn 0.3s ease-out 8.1s both; }
+      .line-29 { animation: fadeIn 0.3s ease-out 8.4s both; }
+      .line-30 { animation: fadeIn 0.3s ease-out 8.7s both; }
+      .line-31 { animation: fadeIn 0.3s ease-out 9.0s both; }
+      .line-32 { animation: fadeIn 0.3s ease-out 9.3s both; }
+      .line-33 { animation: fadeIn 0.3s ease-out 9.6s both; }
+      .line-34 { animation: fadeIn 0.3s ease-out 9.9s both; }
+      .line-35 { animation: fadeIn 0.3s ease-out 10.2s both; }
+      .line-36 { animation: fadeIn 0.3s ease-out 10.5s both; }
+      .line-37 { animation: fadeIn 0.3s ease-out 10.8s both; }
+      .line-38 { animation: fadeIn 0.3s ease-out 11.1s both; }
+      .line-39 { animation: fadeIn 0.3s ease-out 11.4s both; }
+      .line-40 { animation: fadeIn 0.3s ease-out 11.7s both; }
+      .line-41 { animation: fadeIn 0.3s ease-out 12.0s both; }
+      .line-42 { animation: fadeIn 0.3s ease-out 12.3s both; }
+      .line-43 { animation: fadeIn 0.3s ease-out 12.6s both; }
+      .line-44 { animation: fadeIn 0.3s ease-out 12.9s both; }
+
+      .cursor { animation: blink 0.8s infinite 13.5s; }
+    </style>
+  </defs>
+
+  <!-- Background -->
+  <rect class="terminal-bg" width="700" height="1260" rx="12" ry="12"/>
+
+  <!-- Chrome bar -->
+  <rect class="chrome-bar" width="700" height="30"/>
+  <circle class="chrome-dot-red" cx="20" cy="15" r="6"/>
+  <circle class="chrome-dot-yellow" cx="50" cy="15" r="6"/>
+  <circle class="chrome-dot-green" cx="80" cy="15" r="6"/>
+
+  <!-- Content -->
+  <g class="line-1">
+    <text class="title" x="20" y="80">memoir</text>
+    <text class="subtitle" x="180" y="80">— Your AI remembers everything.</text>
+  </g>
+
+  <text class="command line-2" x="20" y="120">npm install -g memoir-cli</text>
+
+  <text class="comment line-3" x="20" y="170"># See what AI tools are on this machine</text>
+
+  <g class="line-4">
+    <text class="prompt" x="20" y="210">❯ </text>
+    <text class="command" x="50" y="210">memoir status</text>
+  </g>
+
+  <text class="subtitle line-5" x="20" y="260">memoir v3.2.0</text>
+
+  <text class="subtitle line-6" x="20" y="300">Detected AI tools:</text>
+
+  <g class="line-7">
+    <text class="success" x="20" y="340">✔ </text>
+    <text class="command" x="50" y="340">Claude Code    ~/.claude/ (settings, memory, CLAUDE.md)</text>
+  </g>
+
+  <g class="line-8">
+    <text class="success" x="20" y="375">✔ </text>
+    <text class="command" x="50" y="375">Gemini CLI     ~/.gemini/ (config, GEMINI.md)</text>
+  </g>
+
+  <g class="line-9">
+    <text class="success" x="20" y="410">✔ </text>
+    <text class="command" x="50" y="410">Cursor         .cursorrules (settings, keybindings)</text>
+  </g>
+
+  <g class="line-10">
+    <text class="success" x="20" y="445">✔ </text>
+    <text class="command" x="50" y="445">Codex          ~/.codex/ (config, AGENTS.md)</text>
+  </g>
+
+  <g class="line-11">
+    <text class="success" x="20" y="480">✔ </text>
+    <text class="command" x="50" y="480">Aider          ~/.aider.conf.yml</text>
+  </g>
+
+  <text class="subtitle line-12" x="20" y="520">5 tools found on this machine.</text>
+
+  <text class="comment line-13" x="20" y="570"># Back up everything in one command</text>
+
+  <g class="line-14">
+    <text class="prompt" x="20" y="610">❯ </text>
+    <text class="command" x="50" y="610">memoir push</text>
+  </g>
+
+  <g class="line-15">
+    <text class="success" x="20" y="655">✔ </text>
+    <text class="command" x="50" y="655">AI memory backed up (5 tools, 23 files)</text>
+  </g>
+
+  <g class="line-16">
+    <text class="success" x="20" y="690">✔ </text>
+    <text class="command" x="50" y="690">Session context captured</text>
+  </g>
+
+  <g class="line-17">
+    <text class="success" x="20" y="725">✔ </text>
+    <text class="command" x="50" y="725">Workspace: 44 projects (17 git, 23 bundled)</text>
+  </g>
+
+  <g class="line-18">
+    <text class="dim" x="20" y="765">🔒 E2E encrypted · pushed in 3.2s</text>
+  </g>
+
+  <text class="comment line-19" x="20" y="815"># Simulate switching machines...</text>
+
+  <g class="line-20">
+    <text class="error" x="20" y="855">[wiped all AI configs]</text>
+  </g>
+
+  <text class="comment line-21" x="20" y="905"># Restore on the new machine</text>
+
+  <g class="line-22">
+    <text class="prompt" x="20" y="945">❯ </text>
+    <text class="command" x="50" y="945">memoir restore --yes</text>
+  </g>
+
+  <g class="line-23">
+    <text class="success" x="20" y="990">✔ </text>
+    <text class="command" x="50" y="990">AI memory restored (Claude, Gemini, Cursor, Codex, Aider)</text>
+  </g>
+
+  <g class="line-24">
+    <text class="success" x="20" y="1025">✔ </text>
+    <text class="command" x="50" y="1025">44 projects cloned &amp; unpacked</text>
+  </g>
+
+  <g class="line-25">
+    <text class="success" x="20" y="1060">✔ </text>
+    <text class="command" x="50" y="1060">Uncommitted changes applied</text>
+  </g>
+
+  <g class="line-26">
+    <text class="success" x="20" y="1095">✔ </text>
+    <text class="command" x="50" y="1095">Session context injected — AI picks up mid-conversation</text>
+  </g>
+
+  <text class="subtitle line-27" x="20" y="1140">Done. All AI memory restored in seconds.</text>
+
+  <text class="command line-28" x="20" y="1180">npm install -g memoir-cli</text>
+
+  <!-- Blinking cursor -->
+  <text class="command cursor" x="20" y="1220">_</text>
+
+</svg>