Browser Bridge Protocol

Every WebSocket message the browser bridge accepts, with replies and error codes

The bridge at ws://127.0.0.1:8765/ws routes messages between CLI clients, the bridge’s BrowserAgent and the Chrome extension.

Quick Start

1. Register as the extension (JavaScript)

   const ws = new WebSocket("ws://127.0.0.1:8765/ws");
   ws.addEventListener("open", () => {
     ws.send(JSON.stringify({ type: "register", client: "extension" }));
   });
   ws.addEventListener("message", (e) => console.log(JSON.parse(e.data)));

2. Start a session as a CLI client (Python)

   import asyncio, json, websockets
   
   async def main():
       async with websockets.connect("ws://127.0.0.1:8765/ws") as ws:
           print(await ws.recv())  # "connected" welcome
           await ws.send(json.dumps({"type": "start_session", "goal": "open example.com"}))
           print(await ws.recv())
   
   asyncio.run(main())

Message Catalog

Roles

Each socket is an extension, a CLI, or neither, decided at connect time.

See Role Registration for the handshake.

Error Codes

Best Practices

Related