Skip to content

README.md

Latest commit

 

History

History
61 lines (45 loc) · 2.58 KB

README.md

File metadata and controls

61 lines (45 loc) · 2.58 KB

agent-browser Environments

A demo of agent-browser running in a Vercel Sandbox. Pick a URL, take a screenshot or accessibility snapshot, and watch each command execute in real time.

How It Works

The app runs agent-browser + Chrome inside an ephemeral Vercel Sandbox microVM. A Linux VM spins up on demand, executes agent-browser commands, and shuts down. No binary size limits, no Chromium bundling complexity.

The UI streams progress via Server-Sent Events so you can see each step as it runs (sandbox creation, browser startup, navigation, screenshot/snapshot, cleanup).

Getting Started

cd examples/environments
pnpm install
pnpm dev

For local development, set VERCEL_TOKEN, VERCEL_TEAM_ID, and VERCEL_PROJECT_ID in .env.local so the Sandbox SDK can authenticate.

Sandbox Snapshots

Without optimization, each Sandbox run installs system dependencies + agent-browser + Chromium from scratch (~30s). A sandbox snapshot is a saved VM image with everything pre-installed -- the sandbox boots from the image instead of installing, bringing startup down to sub-second. (This is unrelated to agent-browser's accessibility snapshot feature, which dumps a page's accessibility tree.)

Create a sandbox snapshot by running the helper script once:

npx tsx scripts/create-snapshot.ts
# Output: AGENT_BROWSER_SNAPSHOT_ID=snap_xxxxxxxxxxxx

Add the ID to your Vercel project environment variables or .env.local. Recommended for production.

Environment Variables

Variable Description
AGENT_BROWSER_SNAPSHOT_ID Sandbox snapshot ID for sub-second startup (see above)
VERCEL_TOKEN Vercel personal access token (for local dev; OIDC is automatic on Vercel)
VERCEL_TEAM_ID Vercel team ID (for local dev)
VERCEL_PROJECT_ID Vercel project ID (for local dev)
KV_REST_API_URL Upstash Redis URL for rate limiting (optional)
KV_REST_API_TOKEN Upstash Redis token for rate limiting (optional)
RATE_LIMIT_PER_MINUTE Max requests per minute per IP (default: 10)
RATE_LIMIT_PER_DAY Max requests per day per IP (default: 100)

Project Structure

examples/environments/
  app/
    page.tsx                  # Demo UI with streaming progress
    actions/browse.ts         # Server action (env status check)
    api/browse/route.ts       # Streaming SSE endpoint
  lib/
    agent-browser-sandbox.ts  # Vercel Sandbox client with progress callbacks
    constants.ts              # Allowed URLs
    rate-limit.ts             # Upstash rate limiting
  scripts/
    create-snapshot.ts        # Create sandbox snapshot