OpenCode
Persistent long-term memory plugin for OpenCode using Hindsight. Automatically captures conversations, recalls relevant context on session start, and provides retain/recall/reflect tools the agent can call directly.
Quick Start
Add to your opencode.json (project) or ~/.config/opencode/opencode.json (global):
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["@vectorize-io/opencode-hindsight"]
}
OpenCode auto-installs plugins in the "plugin" array on startup — no npm install required.
Point the plugin at your Hindsight server and start OpenCode:
export HINDSIGHT_API_URL="http://localhost:8888"
opencode
Using Hindsight Cloud
Get an API key at ui.hindsight.vectorize.io/connect:
export HINDSIGHT_API_URL="https://api.hindsight.vectorize.io"
export HINDSIGHT_API_TOKEN="your-api-key"
opencode
Or configure inline via plugin options in opencode.json:
{
"$schema": "https://opencode.ai/config.json",
"plugin": [
["@vectorize-io/opencode-hindsight", {
"hindsightApiUrl": "https://api.hindsight.vectorize.io",
"hindsightApiToken": "your-api-key"
}]
]
}
Features
Custom Tools
The plugin registers three tools the agent can call explicitly:
| Tool | Description |
|---|---|
hindsight_retain | Store information in long-term memory |
hindsight_recall | Search long-term memory for relevant information |
hindsight_reflect | Generate a synthesized answer from long-term memory |
Auto-Retain
When the session goes idle (session.idle event), the plugin automatically retains the conversation transcript to Hindsight. Configurable via retainEveryNTurns to control frequency.
Session Recall
When a new session starts, the plugin recalls relevant project context and injects it into the system prompt, giving the agent access to memories from prior sessions.
Compaction Hook
When OpenCode compacts the context window, the plugin:
- Retains the current conversation before compaction
- Recalls relevant memories and injects them into the compaction context
This ensures memories survive context window trimming.
Configuration
Plugin Options
{
"plugin": [
["@vectorize-io/opencode-hindsight", {
"hindsightApiUrl": "http://localhost:8888",
"hindsightApiToken": "your-api-key",
"bankId": "my-project",
"autoRecall": true,
"autoRetain": true,
"recallBudget": "mid",
"recallTags": [],
"recallTagsMatch": "any",
"retainTags": [],
"retainEveryNTurns": 3,
"debug": false
}]
]
}
Config File
Create ~/.hindsight/opencode.json for persistent configuration that applies across all projects:
{
"hindsightApiUrl": "http://localhost:8888",
"hindsightApiToken": "your-api-key",
"recallBudget": "mid"
}
Environment Variables
| Variable | Description | Default |
|---|---|---|
HINDSIGHT_API_URL | Hindsight API base URL | (required) |
HINDSIGHT_API_TOKEN | API key for authentication | |
HINDSIGHT_BANK_ID | Static memory bank ID | opencode |
HINDSIGHT_AGENT_NAME | Agent name for dynamic bank IDs | opencode |
HINDSIGHT_AUTO_RECALL | Auto-recall on session start | true |
HINDSIGHT_AUTO_RETAIN | Auto-retain on session idle | true |
HINDSIGHT_RETAIN_MODE | full-session or last-turn | full-session |
HINDSIGHT_RECALL_BUDGET | Recall budget: low, mid, high | mid |
HINDSIGHT_RECALL_MAX_TOKENS | Max tokens for recall results | 1024 |
HINDSIGHT_RECALL_TAGS | Comma-separated tags to filter recall results | |
HINDSIGHT_RECALL_TAGS_MATCH | Tag match mode: any, all, any_strict, all_strict | any |
HINDSIGHT_DYNAMIC_BANK_ID | Enable dynamic bank ID derivation | false |
HINDSIGHT_BANK_MISSION | Bank mission/context for reflect | |
HINDSIGHT_DEBUG | Enable debug logging to stderr | false |
Configuration priority (later wins): defaults < ~/.hindsight/opencode.json < plugin options < env vars.
Dynamic Bank IDs
For multi-project isolation, enable dynamic bank ID derivation:
export HINDSIGHT_DYNAMIC_BANK_ID=true
The bank ID is composed from granularity fields (default: agent::project). Supported fields: agent, project, channel, user.
For multi-user scenarios (e.g., shared agent serving multiple users):
export HINDSIGHT_CHANNEL_ID="slack-general"
export HINDSIGHT_USER_ID="user123"
How It Works
- Plugin loads when OpenCode starts — creates a
HindsightClient, derives the bank ID, and registers tools + hooks - Session starts —
session.createdevent triggers, plugin marks session for recall injection - System transform — on the first LLM call, recalled memories are injected into the system prompt
- Agent works — can call
hindsight_recallandhindsight_retainexplicitly during the session - Session idles —
session.idleevent triggers auto-retain of the conversation - Compaction — if the context window fills up, memories are preserved through the compaction