Back to Details

agent-browser

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Browser Automation with agent-browser

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

Installation

安装

bash
bun i -g agent-browser@latest
bash
bun i -g agent-browser@latest

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

核心工作流程

  1. Navigate: 
    agent-browser open <url>
  2. Snapshot: 
    agent-browser snapshot -i
    (returns elements with refs like 
    @e1
    , 
    @e2
    )
  3. Interact using refs from the snapshot
  4. Re-snapshot after navigation or significant DOM changes
  1. 导航：
    agent-browser open <url>
  2. 快照：
    agent-browser snapshot -i
    （返回带
    @e1
    、
    @e2
    等引用标识的元素）
  3. 使用快照中的引用标识进行交互
  4. 导航或DOM发生重大变化后重新生成快照

Commands

命令列表

Navigation

导航

bash
agent-browser open <url>      # Navigate to URL
agent-browser back            # Go back
agent-browser forward         # Go forward
agent-browser reload          # Reload page
agent-browser close           # Close browser
bash
agent-browser open <url>      # 导航至指定URL
agent-browser back            # 返回上一页
agent-browser forward         # 前进到下一页
agent-browser reload          # 刷新页面
agent-browser close           # 关闭浏览器

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
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
agent-browser scroll down 500     # Scroll page
agent-browser scrollintoview @e1  # Scroll element into view
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         # 按下回车键
agent-browser press Control+a     # 按下组合键
agent-browser keydown Shift       # 按住Shift键
agent-browser keyup Shift         # 释放Shift键
agent-browser hover @e1           # 悬停在元素上
agent-browser check @e1           # 勾选复选框
agent-browser uncheck @e1         # 取消勾选复选框
agent-browser select @e1 "value"  # 选择下拉选项
agent-browser scroll down 500     # 向下滚动500像素
agent-browser scrollintoview @e1  # 滚动至元素可见
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
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         # 获取元素边界框

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
agent-browser wait --url "**/dashboard"    # Wait for URL pattern
agent-browser wait --load networkidle      # Wait for network idle
agent-browser wait --fn "window.ready"     # Wait for JS condition
bash
agent-browser wait @e1                     # 等待元素出现
agent-browser wait 2000                    # 等待指定毫秒数
agent-browser wait --text "Success"        # 等待指定文本出现
agent-browser wait --url "**/dashboard"    # 等待URL匹配指定模式
agent-browser wait --load networkidle      # 等待网络空闲
agent-browser wait --fn "window.ready"     # 等待JavaScript条件满足

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 label "Email" fill "user@test.com"
agent-browser find first ".item" click
agent-browser find nth 2 "a" text
bash
agent-browser find role button click --name "Submit"
agent-browser find text "Sign In" click
agent-browser find label "Email" fill "user@test.com"
agent-browser find first ".item" click
agent-browser find nth 2 "a" text

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
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
agent-browser set media dark              # Emulate color scheme
bash
agent-browser set viewport 1920 1080      # 设置视口尺寸
agent-browser set device "iPhone 14"      # 模拟指定设备
agent-browser set geo 37.7749 -122.4194   # 设置地理位置
agent-browser set offline on              # 切换离线模式
agent-browser set headers '{"X-Key":"v"}' # 设置额外HTTP头
agent-browser set credentials user pass   # 设置HTTP基础认证信息
agent-browser set media dark              # 模拟深色配色方案

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>              # 拦截请求
agent-browser network route <url> --abort      # 阻止请求
agent-browser network route <url> --body '{}'  # 模拟响应
agent-browser network unroute [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
agent-browser tab close           # Close tab
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 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代码

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
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 open example.com --headed              # Show browser window
agent-browser console                                # View console messages
agent-browser errors                                 # View page errors
agent-browser record start ./debug.webm   # Record from current page
agent-browser record stop                            # Save recording
agent-browser open example.com --headed  # Show browser window
agent-browser --cdp 9222 snapshot        # Connect via CDP
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
bash
agent-browser open example.com --headed              # 显示浏览器窗口
agent-browser console                                # 查看控制台消息
agent-browser errors                                 # 查看页面错误
agent-browser record start ./debug.webm   # 从当前页面开始录制
agent-browser record stop                            # 保存录制视频
agent-browser open example.com --headed  # 显示浏览器窗口
agent-browser --cdp 9222 snapshot        # 通过CDP连接
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       # 停止并保存跟踪文件