Documentation
Everything you need to get started with @ulpi/browse and make the most of it.
Getting Started
New to browse? Start here.
- Quickstart — Install and run your first browsing session in 5 minutes
- Installation — npm, Bun, npx, system requirements, troubleshooting
CLI Reference
Browse the complete command reference — 121 commands across 12 categories.
- Navigation — goto, back, forward, reload, url
- Content Extraction — text, html, links, forms, accessibility
- Interaction — click, fill, select, hover, type, scroll, wait
- Snapshot & Find — snapshot flags, find selectors, @ref workflow
- Visual & Compare — screenshot, pdf, responsive, diff
- React DevTools — component tree, props, Suspense, hydration
- View all 12 categories →
Configuration
- browse.json — Project-level configuration file
- CLI Flags — --session, --profile, --json, --headed, --runtime, --provider
- Environment Variables — BROWSE_PORT, BROWSE_SESSION, BROWSE_RUNTIME
Guides
Deep-dive guides for advanced use cases.
- AI Agent Integration — Claude Code, Cursor, Cline, Windsurf setup
- MCP Server Mode — Run browse as an MCP server for Cursor, Claude Desktop, Windsurf
- Sessions & Profiles — Parallel agents, persistent state, multiplexing
- Runtimes & Cloud Providers — Playwright, Rebrowser (stealth), LightPanda, Browserbase, Browserless
- Security — Domain allowlists, encrypted vault, content boundaries
- React DevTools — Component inspection, hydration debugging, profiling