Documentation Index
Fetch the complete documentation index at: https://mintlify.com/steerlabs/opensteer/llms.txt
Use this file to discover all available pages before exploring further.
launch()
Launch a new browser instance. In local mode, starts a Playwright Chromium instance. In cloud mode, creates a session and connects via CDP.
Parameters
Run browser in headless mode. Overrides config value if specified.
Path to browser executable. Overrides config value if specified.
Slow down operations by specified milliseconds. Useful for debugging.
Playwright BrowserContext options like viewport, locale, timezone, etc.
Connect to a running browser via CDP. Example:
"http://localhost:9222"Browser channel:
"chrome", "chrome-beta", or "msedge"Browser profile directory. Preserves cookies, extensions, and sessions.
Connection timeout in milliseconds. Default: 30000 (30 seconds)
Examples
Basic launch
Headless mode
Custom viewport
Connect to existing browser
Cloud mode launch
close()
Close the browser and release all resources. In cloud mode, also closes the cloud session and action WebSocket.
Examples
Always close in finally block
Multiple sessions
Lifecycle best practices
In cloud mode,
close() terminates the cloud session immediately. Any pending actions will be cancelled.Error handling
Local vs cloud behavior
| Feature | Local Mode | Cloud Mode |
|---|---|---|
| Browser process | Runs on local machine | Runs in cloud infrastructure |
| Launch time | 2-5 seconds | 5-10 seconds |
| Session persistence | Until close() | Until close() or timeout |
| Browser profiles | Supported via profileDir | Not supported |
| CDP connection | Optional via connectUrl | Automatic |
| Cleanup on close | Kills browser process | Terminates cloud session |
Related methods
- Opensteer constructor - Initial configuration
- Cloud sessions - Cloud session management
- goto() - Navigate after launch