agent-browser

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Browser Automation with agent-browser

基于agent-browser的浏览器自动化

Quick start

快速开始

bash

agent-browser open <url>        # Navigate to page
agent-browser snapshot -i       # Get interactive elements with refs
agent-browser click @e1         # Click element by ref
agent-browser fill @e2 "text"   # Fill input by ref
agent-browser close             # Close browser

bash

agent-browser open <url>        # 导航至页面
agent-browser snapshot -i       # 获取带引用标识的交互元素
agent-browser click @e1         # 通过引用标识点击元素
agent-browser fill @e2 "text"   # 通过引用标识填充输入框
agent-browser close             # 关闭浏览器

Core workflow

核心工作流程

Navigate:
```
agent-browser open <url>
```
Snapshot:
```
agent-browser snapshot -i
```
(returns elements with refs like
```
@e1
```
,
```
@e2
```
)
Interact using refs from the snapshot
Re-snapshot after navigation or significant DOM changes

导航：
```
agent-browser open <url>
```
快照：
```
agent-browser snapshot -i
```
（返回带有
```
@e1
```
、
```
@e2
```
等引用标识的元素）
使用快照中的引用标识进行交互
导航后或DOM发生重大变化时重新生成快照

Commands

命令列表

Navigation

导航命令

bash

agent-browser open <url>      # Navigate to URL (aliases: goto, navigate)
                              # Supports: https://, http://, file://, about:, data://
                              # Auto-prepends https:// if no protocol given
agent-browser back            # Go back
agent-browser forward         # Go forward
agent-browser reload          # Reload page
agent-browser close           # Close browser (aliases: quit, exit)
agent-browser connect 9222    # Connect to browser via CDP port

bash

agent-browser open <url>      # 导航至URL（别名：goto, navigate）
                              # 支持协议：https://, http://, file://, about:, data://
                              # 若未指定协议，自动添加https://
agent-browser back            # 返回上一页
agent-browser forward         # 前进到下一页
agent-browser reload          # 重新加载页面
agent-browser close           # 关闭浏览器（别名：quit, exit）
agent-browser connect 9222    # 通过CDP端口连接浏览器

Snapshot (page analysis)

快照（页面分析）

bash

agent-browser snapshot            # Full accessibility tree
agent-browser snapshot -i         # Interactive elements only (recommended)
agent-browser snapshot -c         # Compact output
agent-browser snapshot -d 3       # Limit depth to 3
agent-browser snapshot -s "#main" # Scope to CSS selector

bash

agent-browser snapshot            # 获取完整可访问性树
agent-browser snapshot -i         # 仅获取交互元素（推荐使用）
agent-browser snapshot -c         # 精简输出格式
agent-browser snapshot -d 3       # 限制输出深度为3
agent-browser snapshot -s "#main" # 仅分析CSS选择器指定的区域

Interactions (use @refs from snapshot)

交互操作（使用快照中的@引用标识）

bash

agent-browser click @e1           # Click
agent-browser dblclick @e1        # Double-click
agent-browser focus @e1           # Focus element
agent-browser fill @e2 "text"     # Clear and type
agent-browser type @e2 "text"     # Type without clearing
agent-browser press Enter         # Press key (alias: key)
agent-browser press Control+a     # Key combination
agent-browser keydown Shift       # Hold key down
agent-browser keyup Shift         # Release key
agent-browser hover @e1           # Hover
agent-browser check @e1           # Check checkbox
agent-browser uncheck @e1         # Uncheck checkbox
agent-browser select @e1 "value"  # Select dropdown option
agent-browser select @e1 "a" "b"  # Select multiple options
agent-browser scroll down 500     # Scroll page (default: down 300px)
agent-browser scrollintoview @e1  # Scroll element into view (alias: scrollinto)
agent-browser drag @e1 @e2        # Drag and drop
agent-browser upload @e1 file.pdf # Upload files

bash

agent-browser click @e1           # 点击元素
agent-browser dblclick @e1        # 双击元素
agent-browser focus @e1           # 聚焦元素
agent-browser fill @e2 "text"     # 清空并输入文本
agent-browser type @e2 "text"     # 直接输入文本（不清空原有内容）
agent-browser press Enter         # 按下按键（别名：key）
agent-browser press Control+a     # 按下组合键
agent-browser keydown Shift       # 按住按键
agent-browser keyup Shift         # 松开按键
agent-browser hover @e1           # 悬停在元素上
agent-browser check @e1           # 勾选复选框
agent-browser uncheck @e1         # 取消勾选复选框
agent-browser select @e1 "value"  # 选择下拉选项
agent-browser select @e1 "a" "b"  # 选择多个下拉选项
agent-browser scroll down 500     # 滚动页面（默认：向下滚动300px）
agent-browser scrollintoview @e1  # 滚动至元素可见（别名：scrollinto）
agent-browser drag @e1 @e2        # 拖拽元素
agent-browser upload @e1 file.pdf # 上传文件

Get information

信息获取

bash

agent-browser get text @e1        # Get element text
agent-browser get html @e1        # Get innerHTML
agent-browser get value @e1       # Get input value
agent-browser get attr @e1 href   # Get attribute
agent-browser get title           # Get page title
agent-browser get url             # Get current URL
agent-browser get count ".item"   # Count matching elements
agent-browser get box @e1         # Get bounding box
agent-browser get styles @e1      # Get computed styles (font, color, bg, etc.)

bash

agent-browser get text @e1        # 获取元素文本
agent-browser get html @e1        # 获取元素innerHTML
agent-browser get value @e1       # 获取输入框值
agent-browser get attr @e1 href   # 获取元素属性
agent-browser get title           # 获取页面标题
agent-browser get url             # 获取当前URL
agent-browser get count ".item"   # 统计匹配元素数量
agent-browser get box @e1         # 获取元素边界框
agent-browser get styles @e1      # 获取元素计算样式（字体、颜色、背景等）

Check state

状态检查

bash

agent-browser is visible @e1      # Check if visible
agent-browser is enabled @e1      # Check if enabled
agent-browser is checked @e1      # Check if checked

bash

agent-browser is visible @e1      # 检查元素是否可见
agent-browser is enabled @e1      # 检查元素是否可用
agent-browser is checked @e1      # 检查复选框是否已勾选

Screenshots & PDF

截图与PDF

bash

agent-browser screenshot          # Screenshot to stdout
agent-browser screenshot path.png # Save to file
agent-browser screenshot --full   # Full page
agent-browser pdf output.pdf      # Save as PDF

bash

agent-browser screenshot          # 将截图输出至标准输出
agent-browser screenshot path.png # 将截图保存至指定文件
agent-browser screenshot --full   # 截取整页
agent-browser pdf output.pdf      # 将页面保存为PDF

Video recording

视频录制

bash

agent-browser record start ./demo.webm    # Start recording (uses current URL + state)
agent-browser click @e1                   # Perform actions
agent-browser record stop                 # Stop and save video
agent-browser record restart ./take2.webm # Stop current + start new recording

Recording creates a fresh context but preserves cookies/storage from your session. If no URL is provided, it automatically returns to your current page. For smooth demos, explore first, then start recording.

bash

agent-browser record start ./demo.webm    # 开始录制（使用当前URL及页面状态）
agent-browser click @e1                   # 执行交互操作
agent-browser record stop                 # 停止录制并保存视频
agent-browser record restart ./take2.webm # 停止当前录制并开始新录制

录制会创建新的上下文，但会保留会话中的Cookie和存储数据。如果未指定URL，会自动返回当前页面。为了获得流畅的演示效果，建议先探索页面，再开始录制。

Wait

等待命令

bash

agent-browser wait @e1                     # Wait for element
agent-browser wait 2000                    # Wait milliseconds
agent-browser wait --text "Success"        # Wait for text (or -t)
agent-browser wait --url "**/dashboard"    # Wait for URL pattern (or -u)
agent-browser wait --load networkidle      # Wait for network idle (or -l)
agent-browser wait --fn "window.ready"     # Wait for JS condition (or -f)

bash

agent-browser wait @e1                     # 等待元素出现
agent-browser wait 2000                    # 等待指定毫秒数
agent-browser wait --text "Success"        # 等待指定文本出现（或使用-t参数）
agent-browser wait --url "**/dashboard"    # 等待URL匹配指定模式（或使用-u参数）
agent-browser wait --load networkidle      # 等待网络空闲（或使用-l参数）
agent-browser wait --fn "window.ready"     # 等待JavaScript条件满足（或使用-f参数）

Mouse control

鼠标控制

bash

agent-browser mouse move 100 200      # Move mouse
agent-browser mouse down left         # Press button
agent-browser mouse up left           # Release button
agent-browser mouse wheel 100         # Scroll wheel

bash

agent-browser mouse move 100 200      # 移动鼠标至指定坐标
agent-browser mouse down left         # 按下鼠标左键
agent-browser mouse up left           # 松开鼠标左键
agent-browser mouse wheel 100         # 滚动鼠标滚轮

Semantic locators (alternative to refs)

语义定位器（替代引用标识）

bash

agent-browser find role button click --name "Submit"
agent-browser find text "Sign In" click
agent-browser find text "Sign In" click --exact      # Exact match only
agent-browser find label "Email" fill "user@test.com"
agent-browser find placeholder "Search" type "query"
agent-browser find alt "Logo" click
agent-browser find title "Close" click
agent-browser find testid "submit-btn" click
agent-browser find first ".item" click
agent-browser find last ".item" click
agent-browser find nth 2 "a" hover

bash

agent-browser find role button click --name "Submit"
agent-browser find text "Sign In" click
agent-browser find text "Sign In" click --exact      # 仅精确匹配文本
agent-browser find label "Email" fill "user@test.com"
agent-browser find placeholder "Search" type "query"
agent-browser find alt "Logo" click
agent-browser find title "Close" click
agent-browser find testid "submit-btn" click
agent-browser find first ".item" click
agent-browser find last ".item" click
agent-browser find nth 2 "a" hover

Browser settings

浏览器设置

bash

agent-browser set viewport 1920 1080          # Set viewport size
agent-browser set device "iPhone 14"          # Emulate device
agent-browser set geo 37.7749 -122.4194       # Set geolocation (alias: geolocation)
agent-browser set offline on                  # Toggle offline mode
agent-browser set headers '{"X-Key":"v"}'     # Extra HTTP headers
agent-browser set credentials user pass       # HTTP basic auth (alias: auth)
agent-browser set media dark                  # Emulate color scheme
agent-browser set media light reduced-motion  # Light mode + reduced motion

bash

agent-browser set viewport 1920 1080          # 设置视口尺寸
agent-browser set device "iPhone 14"          # 模拟指定设备
agent-browser set geo 37.7749 -122.4194       # 设置地理位置（别名：geolocation）
agent-browser set offline on                  # 切换离线模式
agent-browser set headers '{"X-Key":"v"}'     # 设置额外HTTP请求头
agent-browser set credentials user pass       # 设置HTTP基础认证信息（别名：auth）
agent-browser set media dark                  # 模拟深色配色方案
agent-browser set media light reduced-motion  # 模拟浅色模式+减少动画

Cookies & Storage

Cookie与存储

bash

agent-browser cookies                     # Get all cookies
agent-browser cookies set name value      # Set cookie
agent-browser cookies clear               # Clear cookies
agent-browser storage local               # Get all localStorage
agent-browser storage local key           # Get specific key
agent-browser storage local set k v       # Set value
agent-browser storage local clear         # Clear all

bash

agent-browser cookies                     # 获取所有Cookie
agent-browser cookies set name value      # 设置Cookie
agent-browser cookies clear               # 清空所有Cookie
agent-browser storage local               # 获取所有localStorage数据
agent-browser storage local key           # 获取localStorage中指定键的值
agent-browser storage local set k v       # 设置localStorage键值对
agent-browser storage local clear         # 清空所有localStorage数据

Network

网络控制

bash

agent-browser network route <url>              # Intercept requests
agent-browser network route <url> --abort      # Block requests
agent-browser network route <url> --body '{}'  # Mock response
agent-browser network unroute [url]            # Remove routes
agent-browser network requests                 # View tracked requests
agent-browser network requests --filter api    # Filter requests

bash

agent-browser network route <url>              # 拦截指定URL的请求
agent-browser network route <url> --abort      # 阻止指定URL的请求
agent-browser network route <url> --body '{}'  # 模拟指定URL的响应
agent-browser network unroute [url]            # 移除指定URL的路由规则
agent-browser network requests                 # 查看已追踪的请求
agent-browser network requests --filter api    # 过滤显示指定类型的请求

Tabs & Windows

标签页与窗口

bash

agent-browser tab                 # List tabs
agent-browser tab new [url]       # New tab
agent-browser tab 2               # Switch to tab by index
agent-browser tab close           # Close current tab
agent-browser tab close 2         # Close tab by index
agent-browser window new          # New window

bash

agent-browser tab                 # 列出所有标签页
agent-browser tab new [url]       # 新建标签页
agent-browser tab 2               # 切换至指定索引的标签页
agent-browser tab close           # 关闭当前标签页
agent-browser tab close 2         # 关闭指定索引的标签页
agent-browser window new          # 新建浏览器窗口

Frames

框架切换

bash

agent-browser frame "#iframe"     # Switch to iframe
agent-browser frame main          # Back to main frame

bash

agent-browser frame "#iframe"     # 切换至指定iframe
agent-browser frame main          # 返回主框架

Dialogs

对话框处理

bash

agent-browser dialog accept [text]  # Accept dialog
agent-browser dialog dismiss        # Dismiss dialog

bash

agent-browser dialog accept [text]  # 确认对话框（可输入文本）
agent-browser dialog dismiss        # 取消对话框

JavaScript

JavaScript执行

bash

agent-browser eval "document.title"   # Run JavaScript

bash

agent-browser eval "document.title"   # 执行JavaScript代码

Global options

全局选项

bash

agent-browser --session <name> ...    # Isolated browser session
agent-browser --json ...              # JSON output for parsing
agent-browser --headed ...            # Show browser window (not headless)
agent-browser --full ...              # Full page screenshot (-f)
agent-browser --cdp <port> ...        # Connect via Chrome DevTools Protocol
agent-browser -p <provider> ...       # Cloud browser provider (--provider)
agent-browser --proxy <url> ...       # Use proxy server
agent-browser --headers <json> ...    # HTTP headers scoped to URL's origin
agent-browser --executable-path <p>   # Custom browser executable
agent-browser --extension <path> ...  # Load browser extension (repeatable)
agent-browser --help                  # Show help (-h)
agent-browser --version               # Show version (-V)
agent-browser <command> --help        # Show detailed help for a command

bash

agent-browser --session <name> ...    # 使用独立浏览器会话
agent-browser --json ...              # 输出JSON格式结果（便于解析）
agent-browser --headed ...            # 显示浏览器窗口（非无头模式）
agent-browser --full ...              # 截取整页截图（-f参数）
agent-browser --cdp <port> ...        # 通过Chrome DevTools Protocol连接
agent-browser -p <provider> ...       # 使用云浏览器服务商（--provider参数）
agent-browser --proxy <url> ...       # 使用代理服务器
agent-browser --headers <json> ...    # 为URL源设置HTTP请求头
agent-browser --executable-path <p>   # 指定自定义浏览器可执行文件路径
agent-browser --extension <path> ...  # 加载浏览器扩展（可重复添加多个）
agent-browser --help                  # 显示帮助信息（-h参数）
agent-browser --version               # 显示版本信息（-V参数）
agent-browser <command> --help        # 显示指定命令的详细帮助

Proxy support

代理支持

bash

agent-browser --proxy http://proxy.com:8080 open example.com
agent-browser --proxy http://user:pass@proxy.com:8080 open example.com
agent-browser --proxy socks5://proxy.com:1080 open example.com

bash

agent-browser --proxy http://proxy.com:8080 open example.com
agent-browser --proxy http://user:pass@proxy.com:8080 open example.com
agent-browser --proxy socks5://proxy.com:1080 open example.com

Environment variables

环境变量

bash

AGENT_BROWSER_SESSION="mysession"            # Default session name
AGENT_BROWSER_EXECUTABLE_PATH="/path/chrome" # Custom browser path
AGENT_BROWSER_EXTENSIONS="/ext1,/ext2"       # Comma-separated extension paths
AGENT_BROWSER_PROVIDER="browserbase"         # Cloud browser provider
AGENT_BROWSER_STREAM_PORT="9223"             # WebSocket streaming port
AGENT_BROWSER_HOME="/path/to/agent-browser"  # Custom install location (for daemon.js)

bash

AGENT_BROWSER_SESSION="mysession"            # 默认会话名称
AGENT_BROWSER_EXECUTABLE_PATH="/path/chrome" # 自定义浏览器路径
AGENT_BROWSER_EXTENSIONS="/ext1,/ext2"       # 逗号分隔的扩展路径列表
AGENT_BROWSER_PROVIDER="browserbase"         # 云浏览器服务商
AGENT_BROWSER_STREAM_PORT="9223"             # WebSocket流端口
AGENT_BROWSER_HOME="/path/to/agent-browser"  # 自定义安装目录（用于daemon.js）

Example: Form submission

示例：表单提交

bash

agent-browser open https://example.com/form
agent-browser snapshot -i

bash

agent-browser open https://example.com/form
agent-browser snapshot -i

Output shows: textbox "Email" [ref=e1], textbox "Password" [ref=e2], button "Submit" [ref=e3]

输出内容包含：文本框"Email" [ref=e1], 文本框"Password" [ref=e2], 按钮"Submit" [ref=e3]

agent-browser fill @e1 "user@example.com" agent-browser fill @e2 "password123" agent-browser click @e3 agent-browser wait --load networkidle agent-browser snapshot -i # Check result

undefined

agent-browser fill @e1 "user@example.com" agent-browser fill @e2 "password123" agent-browser click @e3 agent-browser wait --load networkidle agent-browser snapshot -i # 检查提交结果

undefined

Example: Authentication with saved state

示例：使用保存的状态进行认证

bash

undefined

bash

undefined

Login once

首次登录

agent-browser open https://app.example.com/login agent-browser snapshot -i agent-browser fill @e1 "username" agent-browser fill @e2 "password" agent-browser click @e3 agent-browser wait --url "**/dashboard" agent-browser state save auth.json

Later sessions: load saved state

后续会话：加载保存的状态

agent-browser state load auth.json agent-browser open https://app.example.com/dashboard

undefined

agent-browser state load auth.json agent-browser open https://app.example.com/dashboard

undefined

Sessions (parallel browsers)

会话管理（并行浏览器）

bash

agent-browser --session test1 open site-a.com
agent-browser --session test2 open site-b.com
agent-browser session list

bash

agent-browser --session test1 open site-a.com
agent-browser --session test2 open site-b.com
agent-browser session list

JSON output (for parsing)

JSON输出（用于解析）

Add

--json

for machine-readable output:

bash

agent-browser snapshot -i --json
agent-browser get text @e1 --json

添加

--json

参数可获取机器可读的输出：

bash

agent-browser snapshot -i --json
agent-browser get text @e1 --json

Debugging

调试工具

bash

agent-browser --headed open example.com   # Show browser window
agent-browser --cdp 9222 snapshot         # Connect via CDP port
agent-browser connect 9222                # Alternative: connect command
agent-browser console                     # View console messages
agent-browser console --clear             # Clear console
agent-browser errors                      # View page errors
agent-browser errors --clear              # Clear errors
agent-browser highlight @e1               # Highlight element
agent-browser trace start                 # Start recording trace
agent-browser trace stop trace.zip        # Stop and save trace
agent-browser record start ./debug.webm   # Record video from current page
agent-browser record stop                 # Save recording

bash

agent-browser --headed open example.com   # 显示浏览器窗口
agent-browser --cdp 9222 snapshot         # 通过CDP端口连接
agent-browser connect 9222                # 替代方式：使用connect命令连接
agent-browser console                     # 查看控制台消息
agent-browser console --clear             # 清空控制台
agent-browser errors                      # 查看页面错误
agent-browser errors --clear              # 清空错误记录
agent-browser highlight @e1               # 高亮显示元素
agent-browser trace start                 # 开始录制性能追踪
agent-browser trace stop trace.zip        # 停止录制并保存追踪文件
agent-browser record start ./debug.webm   # 从当前页面开始录制视频
agent-browser record stop                 # 保存录制视频

Deep-dive documentation

深度文档

For detailed patterns and best practices, see:

Reference	Description
references/snapshot-refs.md	Ref lifecycle, invalidation rules, troubleshooting
references/session-management.md	Parallel sessions, state persistence, concurrent scraping
references/authentication.md	Login flows, OAuth, 2FA handling, state reuse
references/video-recording.md	Recording workflows for debugging and documentation
references/proxy-support.md	Proxy configuration, geo-testing, rotating proxies

如需了解详细使用模式和最佳实践，请查看：

参考文档	描述
references/snapshot-refs.md	引用标识生命周期、失效规则及故障排除
references/session-management.md	并行会话、状态持久化、并发数据采集
references/authentication.md	登录流程、OAuth、双因素认证处理、状态复用
references/video-recording.md	用于调试和文档的录制工作流
references/proxy-support.md	代理配置、地理位置测试、动态代理

Ready-to-use templates

即用型模板

Executable workflow scripts for common patterns:

Template	Description
templates/form-automation.sh	Form filling with validation
templates/authenticated-session.sh	Login once, reuse state
templates/capture-workflow.sh	Content extraction with screenshots

Usage:

bash

./templates/form-automation.sh https://example.com/form
./templates/authenticated-session.sh https://app.example.com/login
./templates/capture-workflow.sh https://example.com ./output

针对常见场景的可执行工作流脚本：

模板	描述
templates/form-automation.sh	带验证的表单填写自动化
templates/authenticated-session.sh	一次登录，复用状态
templates/capture-workflow.sh	结合截图的内容提取

使用方式：

bash

./templates/form-automation.sh https://example.com/form
./templates/authenticated-session.sh https://app.example.com/login
./templates/capture-workflow.sh https://example.com ./output