opencode-claude-memory 0.1.0 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 kuitos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,19 +1,71 @@
-# opencode-memory
+<div align="center">
 
-Cross-session memory plugin for [OpenCode](https://opencode.ai) — **fully compatible with Claude Code's memory format**.
+# 🧠 opencode-claude-memory
 
-Claude Code writes memories → OpenCode reads them.  
-OpenCode writes memories → Claude Code reads them.
+**A 1:1 replica of [Claude Code's memory system](https://github.com/anthropics/claude-code) for OpenCode**
 
-## Features
+*Ported from the original source — same paths, same format, same tools, same prompts. Zero drift.*
 
-- **5 tools**: `memory_save`, `memory_delete`, `memory_list`, `memory_search`, `memory_read`
-- **Claude Code compatible**: shares the same `~/.claude/projects/<project>/memory/` directory
-- **Auto-extraction**: shell wrapper that automatically extracts memories after each session
-- **System prompt injection**: existing memories are injected into every conversation
-- **4 memory types**: `user`, `feedback`, `project`, `reference` (same taxonomy as Claude Code)
+Claude Code writes memories → OpenCode reads them. OpenCode writes memories → Claude Code reads them.
 
-## Quick Start
+[![npm version](https://img.shields.io/npm/v/opencode-claude-memory.svg?style=flat-square)](https://www.npmjs.com/package/opencode-claude-memory)
+[![npm downloads](https://img.shields.io/npm/dm/opencode-claude-memory.svg?style=flat-square)](https://www.npmjs.com/package/opencode-claude-memory)
+[![License](https://img.shields.io/npm/l/opencode-claude-memory.svg?style=flat-square)](https://github.com/kuitos/opencode-claude-memory/blob/main/LICENSE)
+
+[Features](#-features) • [Quick Start](#-quick-start) • [How It Works](#-how-it-works) • [Configuration](#%EF%B8%8F-configuration) • [Tools Reference](#-tools-reference)
+
+</div>
+
+---
+
+## ✨ Features
+
+<table>
+<tr>
+<td width="50%">
+
+### 🔄 Claude Code Compatible
+Shares the exact same `~/.claude/projects/<project>/memory/` directory — bidirectional sync out of the box
+
+</td>
+<td width="50%">
+
+### 🛠️ 5 Memory Tools
+`memory_save`, `memory_delete`, `memory_list`, `memory_search`, `memory_read`
+
+</td>
+</tr>
+<tr>
+<td width="50%">
+
+### ⚡ Auto-Extraction
+Drop-in `opencode` wrapper that extracts memories in the background after each session
+
+</td>
+<td width="50%">
+
+### 💉 System Prompt Injection
+Existing memories are automatically injected into every conversation
+
+</td>
+</tr>
+<tr>
+<td width="50%">
+
+### 📁 4 Memory Types
+`user`, `feedback`, `project`, `reference` — same taxonomy as Claude Code
+
+</td>
+<td width="50%">
+
+### 🌳 Git Worktree Aware
+Worktrees of the same repo share the same memory directory
+
+</td>
+</tr>
+</table>
+
+## 🚀 Quick Start
 
 ### 1. Install
 
@@ -21,16 +73,11 @@ OpenCode writes memories → Claude Code reads them.
 npm install -g opencode-claude-memory
 ```
 
-This does two things:
-
-- Registers the **plugin** (memory tools + system prompt injection)
-- Places an `opencode` **wrapper** in your global bin that auto-extracts memories after each session
-
-> The wrapper is a drop-in replacement — it finds the real `opencode` binary in `PATH`, runs it normally, then triggers memory extraction in the background when you exit.
+This installs:
+- The **plugin** — memory tools + system prompt injection
+- An `opencode` **wrapper** — auto-extracts memories after each session
 
-### 2. Configure the plugin
-
-Add the plugin to your `opencode.json`:
+### 2. Configure
 
 ```jsonc
 // opencode.json
@@ -41,62 +88,85 @@ Add the plugin to your `opencode.json`:
 
 ### 3. Use
 
-Just run `opencode` as usual. The memory tools are available to the AI agent:
+```bash
+opencode  # just use it as usual
+```
+
+The AI agent can now use memory tools:
 
 - **"Remember that I prefer terse responses"** → saves a `feedback` memory
 - **"What do you remember about me?"** → reads from memory
 - **"Forget the memory about my role"** → deletes a memory
 
-When you exit a session, memories are automatically extracted in the background.
+When you exit, memories are extracted in the background — zero blocking.
 
-### Uninstall
+<details>
+<summary>🗑️ Uninstall</summary>
 
 ```bash
 npm uninstall -g opencode-claude-memory
 ```
 
-This removes both the wrapper and the plugin. Your saved memories in `~/.claude/projects/` are **not** deleted.
+This removes the wrapper and the plugin. Your saved memories in `~/.claude/projects/` are **not** deleted.
+
+</details>
 
-## Auto-Extraction
+## 💡 How It Works
 
-The wrapper:
+```mermaid
+graph LR
+    A[You run opencode] --> B[Wrapper finds real binary]
+    B --> C[Runs opencode normally]
+    C --> D[You exit]
+    D --> E[Get latest session ID]
+    E --> F[Fork session + extract memories]
+    F --> G[Memories saved to ~/.claude/projects/]
+```
 
-1. Finds the real `opencode` binary (skips itself in `PATH`)
-2. Runs it normally with all your arguments
-3. After you exit, finds the most recent session
-4. Forks that session and sends a memory extraction prompt
-5. The extraction runs **in the background** — you're never blocked
+The wrapper is a drop-in replacement that:
 
-### How it works
+1. Scans `PATH` to find the real `opencode` binary (skipping itself)
+2. Runs it with all your arguments
+3. After you exit, forks the session with a memory extraction prompt
+4. Extraction runs **in the background** — you're never blocked
 
-```
-You run `opencode`
-  → wrapper finds real opencode binary (skipping itself in PATH)
-  → runs real opencode with your arguments
-  → you exit
-  → opencode session list --format json -n 1  (get last session)
-  → opencode run -s <id> --fork "<extraction prompt>"  (background)
-  → memories saved to ~/.claude/projects/<project>/memory/
-```
+### What "1:1 Replica" Means
+
+Every core component is ported directly from [Claude Code's source](https://github.com/anthropics/claude-code):
+
+| Component | Source |
+|---|---|
+| `sanitizePath()` + `djb2Hash()` | `utils/sessionStoragePortable.ts` |
+| `findGitRoot()` + worktree resolution | `utils/git.ts` |
+| Memory types & frontmatter format | `commands/memory.ts` |
+| System prompt (types, when to save/skip) | `commands/memory.ts` |
+| Extraction prompt (post-session) | Claude Code's memory extraction agent |
+
+This ensures:
+- `~/.claude/projects/<sanitized>/memory/` paths are **byte-identical** to Claude Code's output
+- Git worktrees resolve to the same canonical root
+- Memory files are interchangeable — no migration needed
+
+## ⚙️ Configuration
 
-### Environment variables
+### Environment Variables
 
 | Variable | Default | Description |
 |---|---|---|
 | `OPENCODE_MEMORY_EXTRACT` | `1` | Set to `0` to disable auto-extraction |
 | `OPENCODE_MEMORY_FOREGROUND` | `0` | Set to `1` to run extraction in foreground (debugging) |
-| `OPENCODE_MEMORY_MODEL` | *(default)* | Override model for extraction (e.g., `anthropic/claude-sonnet-4-20250514`) |
+| `OPENCODE_MEMORY_MODEL` | *(default)* | Override model for extraction |
 | `OPENCODE_MEMORY_AGENT` | *(default)* | Override agent for extraction |
 
 ### Logs
 
 Extraction logs are written to `$TMPDIR/opencode-memory-logs/extract-*.log`.
 
-### Concurrency safety
+### Concurrency Safety
 
 A file lock prevents multiple extractions from running simultaneously on the same project. Stale locks (from crashed processes) are automatically cleaned up.
 
-## Memory Format
+## 📝 Memory Format
 
 Each memory is a Markdown file with YAML frontmatter:
 
@@ -113,7 +183,7 @@ Skip post-action summaries. User reads diffs directly.
 **How to apply:** Don't summarize changes at the end of responses.
 ```
 
-### Memory types
+### Memory Types
 
 | Type | Description |
 |---|---|
@@ -122,44 +192,19 @@ Skip post-action summaries. User reads diffs directly.
 | `project` | Ongoing work context not derivable from code |
 | `reference` | Pointers to external resources |
 
-### Index file
+<details>
+<summary>📄 Index file (MEMORY.md)</summary>
 
-`MEMORY.md` is an index (not content storage). Each entry is one line:
+`MEMORY.md` is an auto-managed index (not content storage). Each entry is one line:
 
 ```markdown
 - [User prefers terse responses](feedback_terse_responses.md) — Skip summaries, user reads diffs
 - [User is a data scientist](user_role.md) — Focus on observability/logging context
 ```
 
-## Claude Code Compatibility
-
-This plugin uses the **exact same path algorithm** as Claude Code:
-
-1. Find the canonical git root (resolves worktrees to their main repo)
-2. Sanitize the path with `sanitizePath()` (Claude Code's algorithm, including `djb2Hash` for long paths)
-3. Store in `~/.claude/projects/<sanitized>/memory/`
-
-This means:
-- Git worktrees of the same repo share the same memory directory
-- The sanitized path matches Claude Code's output exactly
-- Memory files use the same frontmatter format and type taxonomy
-
-## File Structure
-
-```
-opencode-memory/
-├── bin/
-│   └── opencode                # Drop-in wrapper (finds real binary, adds memory extraction)
-├── src/
-│   ├── index.ts                # Plugin entry point (tools + hooks)
-│   ├── memory.ts               # Memory CRUD operations
-│   ├── paths.ts                # Claude-compatible path resolution
-│   └── prompt.ts               # System prompt injection
-├── package.json
-└── tsconfig.json
-```
+</details>
 
-## Tools Reference
+## 🔧 Tools Reference
 
 ### `memory_save`
 
@@ -167,11 +212,11 @@ Save or update a memory.
 
 | Parameter | Type | Required | Description |
 |---|---|---|---|
-| `file_name` | string | yes | File name slug (e.g., `user_role`) |
-| `name` | string | yes | Short title |
-| `description` | string | yes | One-line description for relevance matching |
-| `type` | enum | yes | `user`, `feedback`, `project`, or `reference` |
-| `content` | string | yes | Memory content |
+| `file_name` | string | ✅ | File name slug (e.g., `user_role`) |
+| `name` | string | ✅ | Short title |
+| `description` | string | ✅ | One-line description for relevance matching |
+| `type` | enum | ✅ | `user`, `feedback`, `project`, or `reference` |
+| `content` | string | ✅ | Memory content |
 
 ### `memory_delete`
 
@@ -189,6 +234,6 @@ Search memories by keyword across name, description, and content.
 
 Read the full content of a specific memory file.
 
-## License
+## 📄 License
 
-MIT
+[MIT](LICENSE) © [kuitos](https://github.com/kuitos)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-claude-memory",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "type": "module",
   "description": "Cross-session memory plugin for OpenCode — Claude Code compatible, persistent, file-based memory",
   "main": "src/index.ts",