https://github.com/ian-pascoe/opencode-byterover
ByteRover plugin for OpenCode
https://github.com/ian-pascoe/opencode-byterover
ai byterover memory opencode
Last synced: about 2 months ago
JSON representation
ByteRover plugin for OpenCode
- Host: GitHub
- URL: https://github.com/ian-pascoe/opencode-byterover
- Owner: ian-pascoe
- License: mit
- Created: 2026-04-24T12:40:05.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-04-24T17:22:03.000Z (about 2 months ago)
- Last Synced: 2026-04-24T17:24:25.810Z (about 2 months ago)
- Topics: ai, byterover, memory, opencode
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/opencode-byterover
- Size: 46.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
opencode-byterover
ByteRover memory integration for OpenCode.
## Overview
`opencode-byterover` is an OpenCode plugin that connects OpenCode sessions to ByteRover through `@byterover/brv-bridge`.
The plugin persists useful session context when sessions become idle or compact, then recalls relevant context during system prompt transformation.
## Prerequisites
- OpenCode with plugin support enabled.
- ByteRover CLI installed and available as `brv`, or a custom executable path configured with `brvPath`.
- ByteRover initialized for the project you want OpenCode to use as memory.
Verify the CLI is reachable before enabling the plugin:
```bash
brv --help
```
## Installation
Add the plugin to your OpenCode configuration:
```json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-byterover"]
}
```
For custom settings, use the tuple form shown below.
## Verify Setup
After starting OpenCode in a repository with the plugin enabled:
- `.brv/.gitignore` should be created or updated with an `opencode-byterover` managed block.
- OpenCode logs should include entries with `service: "byterover"`.
- If ByteRover is unavailable, OpenCode should show a warning toast unless `quiet` is enabled.
## Configuration
The plugin accepts these optional settings:
- `enabled`: enable or disable the plugin without removing it from config. Defaults to `true`.
- `brvPath`: custom ByteRover CLI path. Defaults to `brv` (assuming it's in the system `PATH`).
- `searchTimeoutMs`: ByteRover search timeout in milliseconds. Defaults to `15000`.
- `recallTimeoutMs`: ByteRover recall timeout in milliseconds. Defaults to `15000`.
- `persistTimeoutMs`: ByteRover persist timeout in milliseconds. Defaults to `15000`.
- `quiet`: suppress toast notifications for ByteRover operations. Defaults to `false`.
- `autoRecall`: automatically recall and inject ByteRover context into prompts. Defaults to `true`.
- `autoPersist`: automatically curate session turns into ByteRover. Defaults to `true`.
- `contextTagName`: XML-style tag name used for injected recall context. Defaults to `byterover-context`.
- `recallPrompt`: custom instruction text used before the recent conversation sent to ByteRover recall.
- `persistPrompt`: custom instruction text used before the conversation turn sent to ByteRover curation.
- `maxRecallTurns`: maximum recent user turns used to resolve recall context. Defaults to `3`.
- `maxRecallChars`: maximum recent conversation characters used for recall. Defaults to `4096`.
Numeric timeout and limit values must be positive integers. `brvPath`, `recallPrompt`, and `persistPrompt` must be non-empty strings. `contextTagName` must be a simple XML-style tag name such as `byterover-context`.
### Example
```json
{
"$schema": "https://opencode.ai/config.json",
"plugin": [
[
"opencode-byterover",
{
"enabled": true,
"brvPath": "brv",
"searchTimeoutMs": 15000,
"recallTimeoutMs": 15000,
"persistTimeoutMs": 15000,
"autoRecall": true,
"autoPersist": true,
"contextTagName": "byterover-context",
"recallPrompt": "Recall relevant project context for the latest user request.",
"persistPrompt": "Curate durable facts, decisions, preferences, and technical details.",
"maxRecallTurns": 3,
"maxRecallChars": 4096
}
]
]
}
```
## Development
```bash
pnpm install
pnpm format:check
pnpm lint
pnpm test
pnpm typecheck
pnpm build
```
## Releases
This package uses Changesets and GitHub Actions for releases.
Create a release note for user-facing changes:
```bash
pnpm changeset
```
Merging the generated release PR publishes the package to npm through trusted publishing.