opencode-working-memory/docs/installation.md

Installation Guide

Prerequisites

• OpenCode 1.0.0 or higher
• Node.js 18+ (for development only)

Quick Install (For Users)

Option 1: Install from npm (Recommended)

npm install opencode-working-memory

Then add to your .opencode/package.json:

{
  "plugins": [
    "opencode-working-memory"
  ]
}

Option 2: Install from GitHub

Add to your .opencode/package.json:

{
  "dependencies": {
    "opencode-working-memory": "github:yourusername/opencode-working-memory"
  },
  "plugins": [
    "opencode-working-memory"
  ]
}

Then run:

cd .opencode
npm install

Option 3: Local Development Install

Clone the repository:

git clone https://github.com/yourusername/opencode-working-memory.git
cd opencode-working-memory
npm install

Link to your OpenCode project:

cd /path/to/your/project/.opencode
npm link /path/to/opencode-working-memory

Add to .opencode/package.json:

{
  "plugins": [
    "opencode-working-memory"
  ]
}

Verification

After installation, start an OpenCode session and run:

core_memory_update goal "Test installation"

You should see a success message. Check .opencode/memory-core/ for the session file.

Configuration

The plugin works out-of-the-box with sensible defaults. For advanced configuration, see configuration.md.

Troubleshooting

Plugin Not Loading

Symptom: No core_memory_update tool available

Solution:

1. Check .opencode/package.json includes plugin in "plugins": [] array
2. Verify npm install completed successfully
3. Restart OpenCode session

Memory Files Not Created

Symptom: No .opencode/memory-core/ or .opencode/memory-working/ directories

Solution:

1. Ensure OpenCode has write permissions in project directory
2. Check plugin hooks are registered (look for "Working Memory Plugin" in session logs)
3. Trigger memory operations (e.g., use core_memory_update tool)

Type Errors During Development

Symptom: TypeScript errors when modifying plugin

Solution:

1. Ensure @opencode-ai/plugin is installed: npm install @opencode-ai/plugin
2. Run type checking: npx tsc --noEmit
3. See AGENTS.md for code style guidelines

Uninstallation

cd .opencode
npm uninstall opencode-working-memory

Remove from .opencode/package.json plugins array. Memory files in .opencode/memory-* will persist unless manually deleted.

Next Steps

• Read Architecture Documentation to understand how memory tiers work
• See Configuration Guide for customization options
• Check AGENTS.md for development guidelines