@csuwl/opencode-memory-plugin 1.0.0 → 1.1.0

package/README.npm.md

@@ -1,11 +1,18 @@
 # @csuwl/opencode-memory-plugin
 
-> OpenClaw-style persistent memory system for OpenCode with full automation and local vector search
+> OpenClaw-style persistent memory system for OpenCode with **flexible configuration** for embedding models and search modes
 
 ## Installation
 
 ```bash
+# Install latest version
 npm install @csuwl/opencode-memory-plugin -g
+
+# Or install a specific version
+npm install -g @csuwl/opencode-memory-plugin@1.1.0
+
+# Or install locally without -g
+npm install @csuwl/opencode-memory-plugin
 ```
 
 The plugin will be automatically configured for you!
@@ -16,7 +23,74 @@ The plugin will be automatically configured for you!
 - 8 memory tools (write, read, search, vector search)
 - 2 automation agents (auto-save, auto-consolidate)
 - Daily memory logs with automatic consolidation
-- Semantic search using local embeddings
+- **Configurable semantic search** using @huggingface/transformers
+- **Multiple search modes**: hybrid, vector-only, bm25-only, hash-only
+- **Multiple embedding models**: all-MiniLM-L6-v2, bge-small-en-v1.5, bge-base-en-v1.5, and more
+- **100% local** - No API calls, models auto-download on first use
+
+## Configuration
+
+The plugin supports flexible configuration via `~/.opencode/memory/memory-config.json`.
+
+### Quick Configuration Examples
+
+**Default (Balanced)** - Works out of the box:
+```json
+{
+  "search": { "mode": "hybrid" },
+  "embedding": {
+    "model": "Xenova/bge-small-en-v1.5"
+  }
+}
+```
+
+**Fast Search** (No model, keywords only):
+```json
+{
+  "search": { "mode": "bm25" },
+  "embedding": { "enabled": false }
+}
+```
+
+**High Quality** (Best model):
+```json
+{
+  "search": { "mode": "vector" },
+  "embedding": {
+    "model": "Xenova/bge-base-en-v1.5"
+  }
+}
+```
+
+**Resource-Constrained** (Smallest model):
+```json
+{
+  "search": { "mode": "vector" },
+  "embedding": {
+    "model": "Xenova/all-MiniLM-L6-v2"
+  }
+}
+```
+
+### Available Search Modes
+
+| Mode | Description | Speed | Quality | Model Required |
+|------|-------------|-------|---------|----------------|
+| `hybrid` | Vector + BM25 (best) | Medium | ⭐⭐⭐⭐ | Yes |
+| `vector` | Vector-only | Medium | ⭐⭐⭐ | Yes |
+| `bm25` | Keywords only | Fast | ⭐⭐ | No |
+| `hash` | Hash fallback | Fast | ⭐ | No |
+
+### Available Embedding Models
+
+| Model | Size | Quality | Speed | Best For |
+|-------|------|---------|-------|----------|
+| `Xenova/all-MiniLM-L6-v2` | 80MB | Good | ⚡⚡⚡ | Baseline |
+| `Xenova/bge-small-en-v1.5` ⭐ | 130MB | Excellent | ⚡⚡ | **Best balance** |
+| `Xenova/bge-base-en-v1.5` | 400MB | Best | ⚡⚡ | High quality |
+| `Xenova/gte-small` | 70MB | Very Good | ⚡⚡⚡ | Small + fast |
+
+See [CONFIGURATION.md](https://github.com/csuwl/opencode-memory-plugin/blob/main/CONFIGURATION.md) for details.
 
 ## Usage
 
@@ -29,13 +103,26 @@ memory_write content="User prefers TypeScript" type="long-term"
 # Search memory
 memory_search query="typescript"
 
-# Semantic search
+# Semantic search (respects your config)
 vector_memory_search query="how to handle errors"
 
 # List daily logs
 list_daily days=7
 ```
 
+## What's New in v1.1.0
+
+✨ **Flexible Configuration System**
+- Choose from 5 embedding models (small to large)
+- 4 search modes (hybrid, vector, bm25, hash)
+- Configurable quality vs speed tradeoffs
+- Easy fallback to keyword-only search
+
+✨ **True Semantic Search**
+- Real vector embeddings using Transformers.js
+- Understands meaning, not just keywords
+- Works 100% offline after model download
+
 ## Configuration
 
 Memory files are located at `~/.opencode/memory/`:
@@ -46,11 +133,13 @@ Memory files are located at `~/.opencode/memory/`:
 - `IDENTITY.md` - Assistant identity
 - `TOOLS.md` - Tool usage conventions
 - `MEMORY.md` - Long-term memory
+- `memory-config.json` - **Plugin configuration**
 - And more...
 
 ## Documentation
 
-For full documentation, visit: https://github.com/csuwl/opencode-memory-plugin
+- **[CONFIGURATION.md](https://github.com/csuwl/opencode-memory-plugin/blob/main/CONFIGURATION.md)** - Complete configuration guide
+- [Full Documentation](https://github.com/csuwl/opencode-memory-plugin) - Project README
 
 ## License
 

package/bin/install.js

@@ -90,14 +90,77 @@ function createMemoryConfig() {
   }
 
   const config = {
-    version: '1.0.0',
-    auto_save: true,
-    auto_save_threshold_tokens: 1000,
-    vector_search: {
+    version: '2.0',
+    search: {
+      mode: 'hybrid',
+      options: {
+        hybrid: {
+          vectorWeight: 0.7,
+          bm25Weight: 0.3
+        }
+      }
+    },
+    embedding: {
       enabled: true,
-      hybrid: true,
-      rebuild_interval_hours: 24
+      provider: 'transformers',
+      model: 'Xenova/all-MiniLM-L6-v2',
+      fallbackMode: 'hash',
+      cache: {
+        enabled: true,
+        directory: path.join(HOME, '.cache', 'huggingface')
+      }
     },
+    models: {
+      available: {
+        'Xenova/all-MiniLM-L6-v2': {
+          dimensions: 384,
+          size: '80MB',
+          language: 'en',
+          useCase: 'general',
+          quality: 'good',
+          speed: 'fast'
+        },
+        'Xenova/bge-small-en-v1.5': {
+          dimensions: 384,
+          size: '130MB',
+          language: 'en',
+          useCase: 'high-quality',
+          quality: 'excellent',
+          speed: 'medium'
+        },
+        'Xenova/bge-base-en-v1.5': {
+          dimensions: 768,
+          size: '400MB',
+          language: 'en',
+          useCase: 'best-quality',
+          quality: 'best',
+          speed: 'slow'
+        },
+        'Xenova/e5-small-v2': {
+          dimensions: 384,
+          size: '130MB',
+          language: 'en',
+          useCase: 'question-answer',
+          quality: 'good',
+          speed: 'medium'
+        },
+        'Xenova/nomic-embed-text-v1.5': {
+          dimensions: 768,
+          size: '270MB',
+          language: 'en',
+          useCase: 'long-documents',
+          quality: 'excellent',
+          speed: 'medium'
+        }
+      }
+    },
+    indexing: {
+      chunkSize: 400,
+      chunkOverlap: 80,
+      autoRebuild: true
+    },
+    // Legacy v1.0 fields (for backward compatibility)
+    auto_save: true,
     consolidation: {
       enabled: true,
       run_daily: true,
@@ -105,11 +168,6 @@ function createMemoryConfig() {
       archive_days: 30,
       delete_days: 90
     },
-    git_backup: {
-      enabled: false,
-      auto_commit: false,
-      auto_push: false
-    },
     retention: {
       max_daily_files: 30,
       max_entries_per_file: 100,
@@ -119,7 +177,7 @@ function createMemoryConfig() {
   };
 
   fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
-  log('  ✓ Configuration created', 'green');
+  log('  ✓ Configuration created (v2.0)', 'green');
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@csuwl/opencode-memory-plugin",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "OpenClaw-style memory system for OpenCode with full automation and local vector search",
   "author": "csuwl <1105865632@qq.com>",
   "license": "MIT",
@@ -22,13 +22,14 @@
     "semantic-search"
   ],
   "dependencies": {
-    "@opencode-ai/plugin": "latest",
-    "better-sqlite3": "latest",
-    "sqlite-vec": "latest"
+    "@opencode-ai/plugin": "^1.0.0",
+    "@huggingface/transformers": "^3.8.1",
+    "better-sqlite3": "^11.7.0",
+    "sqlite-vec": "^0.1.1"
   },
   "devDependencies": {
-    "@types/node": "latest",
-    "typescript": "latest"
+    "@types/node": "^22.10.5",
+    "typescript": "^5.7.3"
   },
   "files": [
     "memory/",

package/scripts/uninstall.sh

@@ -0,0 +1,171 @@
+#!/bin/bash
+
+# OpenCode Memory Plugin - Uninstallation Script
+# This script removes all installed components
+
+set -e
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+function log() {
+    echo -e "${2}$1${NC}"
+}
+
+function getHomeDir() {
+    echo "$HOME"
+}
+
+# Paths
+HOME=$(getHomeDir)
+MEMORY_ROOT="$HOME/.opencode"
+MEMORY_DIR="$MEMORY_ROOT/memory"
+OPENCODE_CONFIG_DIR="$HOME/.config/opencode"
+OPENCODE_CONFIG="$OPENCODE_CONFIG_DIR/opencode.json"
+BACKUP_DIR="$HOME/opencode-memory-backup-$(date +%Y%m%d_%H%M%S)"
+
+log '' '' 
+log '═════════════════════════════════════════════════════════════════' "$BLUE"
+log '  OpenCode Memory Plugin - Uninstallation' "$BLUE"
+log '═════════════════════════════════════════════════════════════════' "$BLUE"
+log '' '' 
+
+# Ask for confirmation
+log 'This will uninstall the OpenCode Memory Plugin.' "$YELLOW"
+log '' '' 
+log 'The following will be removed:' "$YELLOW"
+log "  - Memory files in: $MEMORY_DIR" "$NC"
+log "  - OpenCode configuration entries" "$NC"
+log '' '' 
+log 'Your memory files will be backed up to:' "$GREEN"
+log "  $BACKUP_DIR" "$BLUE"
+log '' '' 
+
+read -p "Do you want to continue? (yes/no): " -r
+echo
+
+if [[ ! $REPLY =~ ^[Yy][Ee][Ss]$ ]]; then
+    log 'Uninstallation cancelled.' "$YELLOW"
+    exit 0
+fi
+
+log '' '' 
+log 'Step 1/4: Creating backup...' "$YELLOW"
+
+# Create backup directory
+mkdir -p "$BACKUP_DIR"
+
+# Backup memory files if they exist
+if [ -d "$MEMORY_DIR" ]; then
+    cp -r "$MEMORY_DIR" "$BACKUP_DIR/"
+    log "  ✓ Backed up memory files" "$GREEN"
+else
+    log "  ⊙ No memory files to backup" "$BLUE"
+fi
+
+# Backup OpenCode config
+if [ -f "$OPENCODE_CONFIG" ]; then
+    cp "$OPENCODE_CONFIG" "$BACKUP_DIR/"
+    log "  ✓ Backed up OpenCode config" "$GREEN"
+else
+    log "  ⊙ No OpenCode config to backup" "$BLUE"
+fi
+
+log '' '' 
+log 'Step 2/4: Removing OpenCode configuration...' "$YELLOW"
+
+# Remove OpenCode configuration entries
+if [ -f "$OPENCODE_CONFIG" ]; then
+    # Use Node.js to safely modify JSON
+    node -e "
+        const fs = require('fs');
+        const path = '$OPENCODE_CONFIG';
+        
+        try {
+            if (fs.existsSync(path)) {
+                let config = JSON.parse(fs.readFileSync(path, 'utf8'));
+                
+                // Remove memory instructions
+                if (config.instructions) {
+                    config.instructions = config.instructions.filter(
+                        instr => !instr.includes('.opencode/memory/')
+                    );
+                }
+                
+                // Remove memory agents
+                if (config.agent) {
+                    delete config.agent['memory-automation'];
+                    delete config.agent['memory-consolidate'];
+                }
+                
+                // Remove memory tools
+                if (config.tools) {
+                    delete config.tools.memory_write;
+                    delete config.tools.memory_read;
+                    delete config.tools.memory_search;
+                    delete config.tools.vector_memory_search;
+                    delete config.tools.list_daily;
+                    delete config.tools.init_daily;
+                    delete config.tools.rebuild_index;
+                    delete config.tools.index_status;
+                }
+                
+                fs.writeFileSync(path, JSON.stringify(config, null, 2));
+                console.log('  ✓ Removed memory configuration from OpenCode');
+            }
+        } catch (error) {
+            console.error('  ✗ Error modifying config:', error.message);
+            process.exit(1);
+        }
+    " 2>/dev/null || {
+        log "  ⚠ Could not modify OpenCode config (manual cleanup may be needed)" "$YELLOW"
+    }
+else
+    log "  ⊙ No OpenCode config found" "$BLUE"
+fi
+
+log '' '' 
+log 'Step 3/4: Removing memory directory...' "$YELLOW"
+
+# Remove memory directory
+if [ -d "$MEMORY_DIR" ]; then
+    rm -rf "$MEMORY_DIR"
+    log "  ✓ Removed memory directory" "$GREEN"
+else
+    log "  ⊙ No memory directory found" "$BLUE"
+fi
+
+log '' '' 
+log 'Step 4/4: Cleaning up...' "$YELLOW"
+
+# Remove vector database cache
+VECTOR_CACHE="$HOME/.cache/huggingface"
+if [ -d "$VECTOR_CACHE" ]; then
+    log "  ⊙ HuggingFace cache preserved at: $VECTOR_CACHE" "$BLUE"
+    log "    (You can safely delete this to save ~80MB)" "$NC"
+fi
+
+# Summary
+log '' '' 
+log '═════════════════════════════════════════════════════════════════' "$BLUE"
+log '  ✓ Uninstallation completed!' "$GREEN"
+log '═════════════════════════════════════════════════════════════════' "$BLUE"
+log '' '' 
+log 'Backup location:' "$GREEN"
+log "  $BACKUP_DIR" "$BLUE"
+log '' ' 
+log 'To restore your memory files:' "$YELLOW"
+log '  cp -r '$BACKUP_DIR'/memory ~/.opencode/' "$BLUE"
+log '' ' 
+log 'To completely remove the backup:' "$YELLOW"
+log '  rm -rf '$BACKUP_DIR "$BLUE"
+log '' ' 
+log 'To remove HuggingFace model cache (~80MB):' "$YELLOW"
+log '  rm -rf ~/.cache/huggingface' "$BLUE"
+log '' ' 
+log 'Thank you for using OpenCode Memory Plugin!' "$GREEN"
+log '' ''