Skip to content

AGENTS.md

Latest commit

 

History

History
70 lines (47 loc) · 1.6 KB

AGENTS.md

File metadata and controls

70 lines (47 loc) · 1.6 KB

AGENTS.md - OpenCode Browser

Guidelines for AI agents working on this codebase.

Project Overview

OpenCode Browser provides browser automation tools to OpenCode via an OpenCode plugin, backed by a Chrome/Chromium extension.

Architecture:

OpenCode Plugin <-> Local Broker (unix socket) <-> Native Host <-> Chrome Extension

Components:

  1. Plugin (src/plugin.ts) - OpenCode plugin that talks to the broker
  2. Broker (bin/broker.cjs) - local multiplexer + per-tab ownership
  3. Native Host (bin/native-host.cjs) - Chrome Native Messaging bridge to the broker
  4. Extension (extension/) - executes browser commands via Chrome APIs

Build & Run Commands

# Install dependencies
bun install

# CLI install/uninstall/status
node bin/cli.js install
node bin/cli.js status
node bin/cli.js uninstall

# Validate scripts
node --check bin/broker.cjs
node --check bin/native-host.cjs

Testing Changes

To test end-to-end you need:

  1. The extension loaded in chrome://extensions
  2. Native host manifest installed (via npx @different-ai/opencode-browser install)
  3. OpenCode configured with the plugin

Then run in a fresh OpenCode process:

opencode run "use browser_status"
opencode run "use browser_get_tabs"

Code Style Guidelines

TypeScript (src/)

  • 2-space indentation
  • Double quotes
  • Semicolons required

JavaScript (extension/)

  • 2-space indentation
  • Double quotes
  • No semicolons

Important Notes

  • Native messaging requires the extension ID in the manifest (allowed_origins).
  • Broker enforces per-tab ownership; first touch auto-claims.