diff --git a/AGENTS.md b/AGENTS.md index 1f77820..6f49b9b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,8 +1,8 @@ -# AGENTS.md - Oh My Memory Development Guide +# AGENTS.md - OpenCode Working Memory Plugin Development Guide ## Project Overview -**Oh My Memory** provides a four-tier memory architecture for AI agents: +The **OpenCode Working Memory Plugin** provides a four-tier memory architecture for AI agents: - **Core Memory** - Persistent blocks (goal/progress/context) that survive compaction - **Working Memory** - Session-scoped context with slots (error/decision/todo/dependency) and memory pool - **Smart Pruning** - Automatic filtering of tool outputs before adding to context @@ -14,8 +14,8 @@ Written in **TypeScript** for the OpenCode agent environment. ```bash # For development -git clone https://github.com/yourusername/oh-my-memory.git -cd oh-my-memory +git clone https://github.com/yourusername/opencode-working-memory.git +cd opencode-working-memory npm install # For usage (see README.md) @@ -40,7 +40,7 @@ Tests are manually verified through OpenCode sessions: ### File Structure ``` -oh-my-memory/ +opencode-working-memory/ ├── index.ts # Main plugin (1700+ lines) ├── package.json # Plugin manifest ├── tsconfig.json # TypeScript config diff --git a/README.md b/README.md index 2e87393..b388bd2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Oh My Memory +# OpenCode Working Memory Plugin -[![npm version](https://img.shields.io/npm/v/oh-my-memory.svg)](https://www.npmjs.com/package/oh-my-memory) +[![npm version](https://img.shields.io/npm/v/opencode-working-memory.svg)](https://www.npmjs.com/package/opencode-working-memory) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) **Advanced four-tier memory architecture that keeps your AI agent sharp, focused, and never forgets what matters.** @@ -25,8 +25,8 @@ Stop losing context across compactions. Stop watching your agent repeat the same Paste this into Claude Code, Cursor, or any AI agent: ``` -Install oh-my-memory plugin by following: -https://raw.githubusercontent.com/yourusername/oh-my-memory/main/docs/installation.md +Install opencode-working-memory plugin by following: +https://raw.githubusercontent.com/yourusername/opencode-working-memory/main/docs/installation.md ``` **Option B: Manual setup** @@ -35,7 +35,7 @@ https://raw.githubusercontent.com/yourusername/oh-my-memory/main/docs/installati ```json { - "plugin": ["oh-my-memory"] + "plugin": ["opencode-working-memory"] } ``` @@ -46,7 +46,7 @@ That's it! The plugin is now active. ### For LLM Agents 1. Read the OpenCode configuration file at `~/.config/opencode/opencode.json` -2. Add `"oh-my-memory"` to the `plugin` array +2. Add `"opencode-working-memory"` to the `plugin` array 3. Verify installation by checking the config file ## Quick Start diff --git a/docs/installation.md b/docs/installation.md index 8c49fec..28c73cb 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -10,7 +10,7 @@ ### Option 1: Install from npm (Recommended) ```bash -npm install oh-my-memory +npm install opencode-working-memory ``` Then add to your `.opencode/package.json`: @@ -18,7 +18,7 @@ Then add to your `.opencode/package.json`: ```json { "plugins": [ - "oh-my-memory" + "opencode-working-memory" ] } ``` @@ -30,10 +30,10 @@ Add to your `.opencode/package.json`: ```json { "dependencies": { - "oh-my-memory": "github:yourusername/oh-my-memory" + "opencode-working-memory": "github:yourusername/opencode-working-memory" }, "plugins": [ - "oh-my-memory" + "opencode-working-memory" ] } ``` @@ -50,8 +50,8 @@ npm install Clone the repository: ```bash -git clone https://github.com/yourusername/oh-my-memory.git -cd oh-my-memory +git clone https://github.com/yourusername/opencode-working-memory.git +cd opencode-working-memory npm install ``` @@ -59,7 +59,7 @@ Link to your OpenCode project: ```bash cd /path/to/your/project/.opencode -npm link /path/to/oh-my-memory +npm link /path/to/opencode-working-memory ``` Add to `.opencode/package.json`: @@ -67,7 +67,7 @@ Add to `.opencode/package.json`: ```json { "plugins": [ - "oh-my-memory" + "opencode-working-memory" ] } ``` @@ -119,7 +119,7 @@ The plugin works out-of-the-box with sensible defaults. For advanced configurati ```bash cd .opencode -npm uninstall oh-my-memory +npm uninstall opencode-working-memory ``` Remove from `.opencode/package.json` plugins array. Memory files in `.opencode/memory-*` will persist unless manually deleted. diff --git a/package.json b/package.json index 7c156c1..de21e1b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "oh-my-memory", + "name": "opencode-working-memory", "version": "1.0.0", "description": "Advanced four-tier memory architecture for OpenCode with intelligent pressure monitoring and auto-storage governance", "type": "module", @@ -10,19 +10,18 @@ "memory", "context-management", "ai-agent", - "llm", - "oh-my-opencode" + "llm" ], "author": "Your Name ", "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/yourusername/oh-my-memory.git" + "url": "git+https://github.com/yourusername/opencode-working-memory.git" }, "bugs": { - "url": "https://github.com/yourusername/oh-my-memory/issues" + "url": "https://github.com/yourusername/opencode-working-memory/issues" }, - "homepage": "https://github.com/yourusername/oh-my-memory#readme", + "homepage": "https://github.com/yourusername/opencode-working-memory#readme", "peerDependencies": { "@opencode-ai/plugin": "^1.2.0" },