@antonvishal/browserbase-tracking-kit

Early-stage, community-maintained software. Not affiliated with or endorsed by Browserbase.

Companion tooling for @antonvishal/browserbase-tracking: configuration loading, the bbdash CLI, and the bundled read-only local dashboard. It has no role in tracking writes and does not depend on the runtime package.

Requires Node.js 22+ or Bun 1.2+. The CLI shebang uses Node; Bun can still run bbdash through its Node-compatible path.

npm add -D @antonvishal/browserbase-tracking-kit
# or
bun add -d @antonvishal/browserbase-tracking-kit

Create browserbase.config.ts in the project root:

import { defineConfig } from "@antonvishal/browserbase-tracking-kit";

export default defineConfig({
  dbCredentials: {
    url: process.env.DATABASE_URL!,
  },
  dashboard: {
    port: 4321,
    open: true,
  },
});

Declare the documented tracking tables and views in your application's Drizzle schema, provision them through your application's migration workflow, then launch the dashboard. The runtime package ships the complete copyable schema at node_modules/@antonvishal/browserbase-tracking/examples/schema.ts:

npx bbdash dash
# or
bunx bbdash dash

Resolution order is --database-url, browserbase.config.ts, then DATABASE_URL. CLI options override config values:

--config <path>       Config file (default: browserbase.config.ts)
--database-url <url>  Override dbCredentials.url
--port <port>         Override dashboard.port
--no-open             Disable automatic browser opening

One process binds only to 127.0.0.1 and serves both the SPA and its validated, read-only /api/v1 HTTP interface. It validates the tracking schema version before listening; it never creates or migrates them.

The dashboard displays stored Search queries and results, Fetch URLs and content, response headers, and error details. Treat local access as access to the underlying tracking database. The server intentionally binds only to the loopback interface and has no authentication; do not proxy or expose it to a network.

License

MIT. Browserbase is a trademark of its respective owner; use of the name here only describes compatibility.