mirror of
https://github.com/browseros-ai/BrowserOS.git
synced 2026-05-13 15:46:22 +00:00
b3003542d8
* docs: overhaul READMEs across all major packages - Root README: restructure with feature table, LLM provider table, comparison matrix, architecture map, and docs link - New: packages/browseros/README.md (Chromium fork build system) - New: apps/server/README.md (MCP server + agent loop) - New: packages/cdp-protocol/README.md (CDP type bindings) - Polish: agent-sdk (badges, prerequisites, multi-step example, links) - Polish: cli (badges, install section, MCP server section, links) - Polish: agent extension (badges, WXT mention, architecture context) - Polish: eval (badges, paper links) * fix: address review — consistent tool count and correct default port - CLI README: "54 MCP tools" → "53+ MCP tools" to match root and server docs - Agent SDK README: localhost:3000 → localhost:9100 to match documented default * docs: add detailed comparison links to How We Compare section * docs: update comparison table with verified competitor data Research all 5 competitors via official websites and docs: - Chrome: no AI agent, Gemini Nano only, MV3 weakening ad blocking - Brave: BYOM feature, local models via BYOM, Shields ad blocking, MV2+MV3 - Dia: Skills-based AI, no BYOK, cloud AI, acquired by Atlassian - Comet: full cloud-based agent, built-in ad blocking, extensions on desktop - Atlas: standalone Chromium browser with Agent Mode, 30-day cloud memory Renamed Arc/Dia column to just Dia (Arc is sunset). * docs: simplify comparison table with clean checkmarks and key differentiators * docs: update browseros-agent README — remove submodule note, add missing packages
@browseros/cdp-protocol
Type-safe Chrome DevTools Protocol bindings for BrowserOS.
Internal package — auto-generated TypeScript types and API wrappers for all CDP domains. Used by
@browseros/serverto communicate with Chromium.
Usage
Import domain types or domain API wrappers using subpath exports:
// Import type definitions for a CDP domain
import type { NavigateParams, NavigateReturn } from '@browseros/cdp-protocol/domains/page'
// Import the API wrapper for a domain
import { PageAPI } from '@browseros/cdp-protocol/domain-apis/page'
// Core protocol API
import { ProtocolAPI } from '@browseros/cdp-protocol/protocol-api'
// Factory function
import { createAPI } from '@browseros/cdp-protocol/create-api'
Supported Domains
All standard Chrome DevTools Protocol domains are supported:
| Category | Domains |
|---|---|
| Page & DOM | Page, DOM, DOMDebugger, DOMSnapshot, DOMStorage, CSS, Overlay |
| Network | Network, Fetch, IO, ServiceWorker, CacheStorage |
| Input & Interaction | Input, Emulation, DeviceOrientation, DeviceAccess |
| JavaScript | Runtime, Debugger, Console, Profiler, HeapProfiler |
| Browser | Browser, Target, Inspector, Extensions, PWA |
| Performance | Performance, PerformanceTimeline, Tracing, Memory |
| Media | Media, WebAudio, Cast |
| Security | Security, WebAuthn, FedCm |
| Storage | IndexedDB, Storage, FileSystem |
| Other | Accessibility, Animation, Audits, Autofill, BackgroundService, BluetoothEmulation, EventBreakpoints, HeadlessExperimental, LayerTree, Log, Preload, Schema, SystemInfo, Tethering |
| BrowserOS Custom | Bookmarks, History |
Structure
src/generated/
├── domains/ # Type definitions for each CDP domain
│ ├── page.ts
│ ├── dom.ts
│ ├── network.ts
│ └── ...
├── domain-apis/ # API wrapper classes for each domain
│ ├── page.ts
│ ├── dom.ts
│ ├── network.ts
│ └── ...
├── protocol-api.ts # Unified protocol API
└── create-api.ts # API factory
Regenerating Types
Types are auto-generated from the CDP protocol specification. The generated output lives in src/generated/ and should not be edited manually.