@ulpi/browse

browse.json

Project-level configuration file for @ulpi/browse.

Overview

Create a browse.json file in your project root to set default options. Every command respects these settings unless overridden by CLI flags.

{
  "session": "my-agent",
  "json": true,
  "contentBoundaries": true,
  "allowedDomains": ["example.com", "*.api.io"],
  "idleTimeout": 3600000,
  "viewport": "1280x720",
  "device": "iPhone 14",
  "runtime": "playwright"
}

Fields

FieldTypeDefaultDescription
sessionstring"default"Named session for isolation
jsonbooleanfalseWrap output as {success, data, command}
contentBoundariesbooleanfalseNonce-delimited output for LLM safety
allowedDomainsstring[][]Block navigation outside these domains
idleTimeoutnumber1800000Session auto-close timeout (ms)
viewportstring"1920x1080"Default viewport size
devicestringDevice emulation preset
runtimestring"playwright"Browser runtime (playwright, rebrowser, lightpanda, chrome)

Precedence

CLI flags override browse.json values. Environment variables override both.

CLI flags > Environment variables > browse.json > Built-in defaults

On this page