Skip to content

Commit 7794be9

Browse files
committed
added to docs
1 parent d2d56ee commit 7794be9

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

docs/customize/browser/all-parameters.mdx

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,23 @@ mode: "wide"
66
---
77

88
## Core Settings
9+
910
- `cdp_url`: CDP URL for connecting to existing browser instance (e.g., `"http://localhost:9222"`)
1011

1112
## Display & Appearance
13+
1214
- `headless` (default: `None`): Run browser without UI. Auto-detects based on display availability (`True`/`False`/`None`)
1315
- `window_size`: Browser window size for headful mode. Use dict `{'width': 1920, 'height': 1080}` or `ViewportSize` object
1416
- `window_position` (default: `{'width': 0, 'height': 0}`): Window position from top-left corner in pixels
1517
- `viewport`: Content area size, same format as `window_size`. Use `{'width': 1280, 'height': 720}` or `ViewportSize` object
1618
- `no_viewport` (default: `None`): Disable viewport emulation, content fits to window size
1719
- `device_scale_factor`: Device scale factor (DPI). Set to `2.0` or `3.0` for high-resolution screenshots
1820

19-
20-
2121
## Browser Behavior
22+
2223
- `keep_alive` (default: `None`): Keep browser running after agent completes
2324
- `allowed_domains`: Restrict navigation to specific domains. Domain pattern formats:
24-
- `'example.com'` - Matches only `https://example.com/*`
25+
- `'example.com'` - Matches only `https://example.com/*`
2526
- `'*.example.com'` - Matches `https://example.com/*` and any subdomain `https://*.example.com/*`
2627
- `'http*://example.com'` - Matches both `http://` and `https://` protocols
2728
- `'chrome-extension://*'` - Matches any Chrome extension URL
@@ -32,18 +33,20 @@ mode: "wide"
3233
- `is_local` (default: `True`): Whether this is a local browser instance. Set to `False` for remote browsers. If we have a `executable_path` set, it will be automatically set to `True`. This can effect your download behavior.
3334

3435
## User Data & Profiles
36+
3537
- `user_data_dir` (default: auto-generated temp): Directory for browser profile data. Use `None` for incognito mode
3638
- `profile_directory` (default: `'Default'`): Chrome profile subdirectory name (`'Profile 1'`, `'Work Profile'`, etc.)
3739
- `storage_state`: Browser storage state (cookies, localStorage). Can be file path string or dict object
3840

3941
## Network & Security
42+
4043
- `proxy`: Proxy configuration using `ProxySettings(server='http://host:8080', bypass='localhost,127.0.0.1', username='user', password='pass')`
4144
- `permissions` (default: `['clipboardReadWrite', 'notifications']`): Browser permissions to grant. Use list like `['camera', 'microphone', 'geolocation']`
4245

4346
- `headers`: Additional HTTP headers for connect requests (remote browsers only)
4447

45-
4648
## Browser Launch
49+
4750
- `executable_path`: Path to browser executable for custom installations. Platform examples:
4851
- macOS: `'/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'`
4952
- Windows: `'C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe'`
@@ -56,23 +59,29 @@ mode: "wide"
5659
- `ignore_default_args`: List of default args to disable, or `True` to disable all. Use list like `['--enable-automation', '--disable-extensions']`
5760

5861
## Timing & Performance
62+
5963
- `minimum_wait_page_load_time` (default: `0.25`): Minimum time to wait before capturing page state in seconds
6064
- `wait_for_network_idle_page_load_time` (default: `0.5`): Time to wait for network activity to cease in seconds
6165
- `wait_between_actions` (default: `0.5`): Time to wait between agent actions in seconds
6266

6367
## AI Integration
68+
6469
- `highlight_elements` (default: `True`): Highlight interactive elements for AI vision
70+
- `paint_order_filtering` (default: `True`): Enable paint order filtering to optimize DOM tree by removing elements hidden behind others. Slightly experimental
6571

6672
## Downloads & Files
73+
6774
- `accept_downloads` (default: `True`): Automatically accept all downloads
6875
- `downloads_path`: Directory for downloaded files. Use string like `'./downloads'` or `Path` object
6976
- `auto_download_pdfs` (default: `True`): Automatically download PDFs instead of viewing in browser
7077

7178
## Device Emulation
79+
7280
- `user_agent`: Custom user agent string. Example: `'Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X)'`
7381
- `screen`: Screen size information, same format as `window_size`
7482

7583
## Recording & Debugging
84+
7685
- `record_video_dir`: Directory to save video recordings as `.mp4` files
7786
- `record_video_size` (default: `ViewportSize`): The frame size (width, height) of the video recording.
7887
- `record_video_framerate` (default: `30`): The framerate to use for the video recording.
@@ -82,13 +91,16 @@ mode: "wide"
8291
- `record_har_mode` (default: `'full'`): HAR recording mode (`'full'`, `'minimal'`)
8392

8493
## Advanced Options
94+
8595
- `disable_security` (default: `False`): ⚠️ **NOT RECOMMENDED** - Disables all browser security features
8696
- `deterministic_rendering` (default: `False`): ⚠️ **NOT RECOMMENDED** - Forces consistent rendering but reduces performance
8797

8898
---
8999

90100
## Outdated BrowserProfile
101+
91102
For backward compatibility, you can pass all the parameters from above to the `BrowserProfile` and then to the `Browser`.
103+
92104
```python
93105
from browser_use import BrowserProfile
94106
profile = BrowserProfile(headless=False)

0 commit comments

Comments
 (0)