Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

有关设置、配置和故障排除,请参阅浏览器。 本页是本地控制 HTTP API、openclaw browser CLI 和脚本模式(快照、引用、等待、调试流程)的参考。

控制 API(可选)

仅用于本地集成时,Gateway 网关会暴露一个小型 loopback HTTP API:
  • Status/启动/停止:GET /POST /startPOST /stop
  • 标签页:GET /tabsPOST /tabs/openPOST /tabs/focusDELETE /tabs/:targetId
  • 快照/截图:GET /snapshotPOST /screenshot
  • 操作:POST /navigatePOST /act
  • 钩子:POST /hooks/file-chooserPOST /hooks/dialog
  • 下载:POST /downloadPOST /wait/download
  • 权限:POST /permissions/grant
  • 调试:GET /consolePOST /pdf
  • 调试:GET /errorsGET /requestsPOST /trace/startPOST /trace/stopPOST /highlight
  • 网络:POST /response/body
  • 状态:GET /cookiesPOST /cookies/setPOST /cookies/clear
  • 状态:GET /storage/:kindPOST /storage/:kind/setPOST /storage/:kind/clear
  • 设置:POST /set/offlinePOST /set/headersPOST /set/credentialsPOST /set/geolocationPOST /set/mediaPOST /set/timezonePOST /set/localePOST /set/device
所有端点都接受 ?profile=<name>POST /start?headless=true 会请求对本地托管配置执行一次性无头启动,而不会更改持久化的浏览器配置;仅附加、远程 CDP 和现有会话配置会拒绝该覆盖项,因为 OpenClaw 不会启动这些浏览器进程。 如果配置了共享密钥 Gateway 网关身份验证,浏览器 HTTP 路由也需要身份验证:
  • Authorization: Bearer <gateway token>
  • x-openclaw-password: <gateway password> 或使用该密码的 HTTP Basic 身份验证
注意:
  • 这个独立的 loopback 浏览器 API 不会使用 trusted-proxy 或 Tailscale Serve 身份标头。
  • 如果 gateway.auth.modenonetrusted-proxy,这些 loopback 浏览器路由不会继承那些携带身份的模式;请保持它们仅限 loopback。

/act 错误契约

POST /act 对路由级验证和策略失败使用结构化错误响应:
{ "error": "<message>", "code": "ACT_*" }
当前 code 值:
  • ACT_KIND_REQUIRED(HTTP 400):kind 缺失或无法识别。
  • ACT_INVALID_REQUEST(HTTP 400):操作负载未通过规范化或验证。
  • ACT_SELECTOR_UNSUPPORTED(HTTP 400):selector 被用于不支持的操作类型。
  • ACT_EVALUATE_DISABLED(HTTP 403):配置已禁用 evaluate(或 wait --fn)。
  • ACT_TARGET_ID_MISMATCH(HTTP 403):顶层或批量 targetId 与请求目标冲突。
  • ACT_EXISTING_SESSION_UNSUPPORTED(HTTP 501):现有会话配置不支持该操作。
其他运行时失败仍可能返回不带 code 字段的 { "error": "<message>" }

Playwright 要求

某些功能(导航/操作/AI 快照/角色快照、元素截图、PDF)需要 Playwright。如果未安装 Playwright,这些端点会返回清晰的 501 错误。 没有 Playwright 时仍可工作的内容:
  • ARIA 快照
  • 当每个标签页的 CDP WebSocket 可用时,角色风格的无障碍快照(--interactive--compact--depth--efficient)。这是用于检查和引用发现的回退方案;Playwright 仍然是主要的操作引擎。
  • 当每个标签页的 CDP WebSocket 可用时,托管的 openclaw 浏览器的页面截图
  • existing-session / Chrome MCP 配置的页面截图
  • 来自快照输出的 existing-session 基于引用的截图(--ref
仍然需要 Playwright 的内容:
  • navigate
  • act
  • 依赖 Playwright 原生 AI 快照格式的 AI 快照
  • CSS 选择器元素截图(--element
  • 完整浏览器 PDF 导出
元素截图也会拒绝 --full-page;路由会返回 fullPage is not supported for element screenshots 如果看到 Playwright is not available in this gateway build,说明打包的 Gateway 网关缺少核心浏览器运行时依赖。请重新安装或更新 OpenClaw,然后重启 Gateway 网关。对于 Docker,还需要按如下所示安装 Chromium 浏览器二进制文件。

Docker Playwright 安装

如果你的 Gateway 网关在 Docker 中运行,请避免使用 npx playwright(npm 覆盖项会冲突)。 改用内置的 CLI:
docker compose run --rm openclaw-cli \
  node /app/node_modules/playwright-core/cli.js install chromium
要持久化浏览器下载,请设置 PLAYWRIGHT_BROWSERS_PATH(例如 /home/node/.cache/ms-playwright),并确保通过 OPENCLAW_HOME_VOLUME 或 bind mount 持久化 /home/node。参阅 Docker

工作原理(内部)

一个小型 loopback 控制服务器接受 HTTP 请求,并通过 CDP 连接到基于 Chromium 的浏览器。高级操作(点击/输入/快照/PDF)通过 CDP 之上的 Playwright 执行;缺少 Playwright 时,只有非 Playwright 操作可用。智能体看到的是一个稳定接口,而本地/远程浏览器和配置会在底层自由切换。

CLI 快速参考

所有命令都接受 --browser-profile <name> 来指定特定配置,并接受 --json 来输出机器可读结果。
openclaw browser status
openclaw browser start
openclaw browser start --headless # one-shot local managed headless launch
openclaw browser stop            # also clears emulation on attach-only/remote CDP
openclaw browser tabs
openclaw browser tab             # shortcut for current tab
openclaw browser tab new
openclaw browser tab select 2
openclaw browser tab close 2
openclaw browser open https://example.com
openclaw browser focus abcd1234
openclaw browser close abcd1234
openclaw browser screenshot
openclaw browser screenshot --full-page
openclaw browser screenshot --ref 12        # or --ref e12
openclaw browser screenshot --labels
openclaw browser snapshot
openclaw browser snapshot --format aria --limit 200
openclaw browser snapshot --interactive --compact --depth 6
openclaw browser snapshot --efficient
openclaw browser snapshot --labels
openclaw browser snapshot --urls
openclaw browser snapshot --selector "#main" --interactive
openclaw browser snapshot --frame "iframe#main" --interactive
openclaw browser console --level error
openclaw browser errors --clear
openclaw browser requests --filter api --clear
openclaw browser pdf
openclaw browser responsebody "**/api" --max-chars 5000
openclaw browser navigate https://example.com
openclaw browser resize 1280 720
openclaw browser click 12 --double           # or e12 for role refs
openclaw browser click-coords 120 340        # viewport coordinates
openclaw browser type 23 "hello" --submit
openclaw browser press Enter
openclaw browser hover 44
openclaw browser scrollintoview e12
openclaw browser drag 10 11
openclaw browser select 9 OptionA OptionB
openclaw browser download e12 report.pdf
openclaw browser waitfordownload report.pdf
openclaw browser upload /tmp/openclaw/uploads/file.pdf
openclaw browser fill --fields '[{"ref":"1","type":"text","value":"Ada"}]'
openclaw browser dialog --accept
openclaw browser wait --text "Done"
openclaw browser wait "#main" --url "**/dash" --load networkidle --fn "window.ready===true"
openclaw browser evaluate --fn '(el) => el.textContent' --ref 7
openclaw browser highlight e12
openclaw browser trace start
openclaw browser trace stop
openclaw browser cookies
openclaw browser cookies set session abc123 --url "https://example.com"
openclaw browser cookies clear
openclaw browser storage local get
openclaw browser storage local set theme dark
openclaw browser storage session clear
openclaw browser set offline on
openclaw browser set headers --headers-json '{"X-Debug":"1"}'
openclaw browser set credentials user pass            # --clear to remove
openclaw browser set geo 37.7749 -122.4194 --origin "https://example.com"
openclaw browser set media dark
openclaw browser set timezone America/New_York
openclaw browser set locale en-US
openclaw browser set device "iPhone 14"
注意:
  • uploaddialog预备调用;请在触发选择器/对话框的点击/按键之前运行它们。
  • click/type/等需要来自 snapshotref(数字 12、角色引用 e12,或可操作的 ARIA 引用 ax12)。操作有意不支持 CSS 选择器。当可见视口位置是唯一可靠目标时,请使用 click-coords
  • 下载、追踪和上传路径被限制在 OpenClaw 临时根目录中:/tmp/openclaw{,/downloads,/uploads}(回退:${os.tmpdir()}/openclaw/...)。
  • upload 也可以通过 --input-ref--element 直接设置文件输入。
当 OpenClaw 能证明替换标签页时,稳定的标签页 ID 和标签会在 Chromium 原始目标替换后保留下来,例如同一 URL,或表单提交后单个旧标签页变成单个新标签页。原始目标 ID 仍然不稳定;脚本中优先使用 tabs 返回的 suggestedTargetId 快照标志速览:
  • --format ai(使用 Playwright 时的默认值):带数字引用的 AI 快照(aria-ref="<n>")。
  • --format aria:带 axN 引用的无障碍树。当 Playwright 可用时,OpenClaw 会用后端 DOM ID 将引用绑定到实时页面,因此后续操作可以使用它们;否则请将输出视为仅供检查。
  • --efficient(或 --mode efficient):紧凑角色快照预设。设置 browser.snapshotDefaults.mode: "efficient" 可将其设为默认值(参阅 Gateway 网关配置)。
  • --interactive--compact--depth--selector 强制生成带 ref=e12 引用的角色快照。--frame "<iframe>" 将角色快照限定到 iframe。
  • --labels 添加一张仅视口截图,并叠加引用标签(输出 MEDIA:<path>)。
  • --urls 将发现的链接目标附加到 AI 快照。

快照和引用

OpenClaw 支持两种“快照”风格:
  • AI 快照(数字引用)openclaw browser snapshot(默认;--format ai
    • 输出:包含数字引用的文本快照。
    • 操作:openclaw browser click 12openclaw browser type 23 "hello"
    • 内部会通过 Playwright 的 aria-ref 解析该引用。
  • 角色快照(类似 e12 的角色引用)openclaw browser snapshot --interactive(或 --compact--depth--selector--frame
    • 输出:带 [ref=e12](以及可选 [nth=1])的基于角色的列表/树。
    • 操作:openclaw browser click e12openclaw browser highlight e12
    • 内部会通过 getByRole(...)(加上用于重复项的 nth())解析该引用。
    • 添加 --labels 可包含一张视口截图,并叠加 e12 标签。
    • 当链接文本存在歧义且智能体需要具体导航目标时,添加 --urls
  • ARIA 快照(类似 ax12 的 ARIA 引用)openclaw browser snapshot --format aria
    • 输出:作为结构化节点的无障碍树。
    • 操作:当快照路径可以通过 Playwright 和 Chrome 后端 DOM ID 绑定引用时,openclaw browser click ax12 可用。
  • 如果 Playwright 不可用,ARIA 快照仍可用于检查,但引用可能不可操作。需要操作引用时,请用 --format ai--interactive 重新生成快照。
  • 原始 CDP 回退路径的 Docker 验证:pnpm test:docker:browser-cdp-snapshot 会使用 CDP 启动 Chromium,运行 browser doctor --deep,并验证角色快照包含链接 URL、光标提升的可点击项和 iframe 元数据。
引用行为:
  • 引用在跨导航时不稳定;如果某些操作失败,请重新运行 snapshot 并使用新的引用。
  • /act 在能够证明替换标签页时,会在动作触发替换后返回当前原始 targetId。 后续命令请继续使用稳定的标签页 ID/标签。
  • 如果角色快照是用 --frame 获取的,角色引用会限定在该 iframe 内,直到下一次角色快照。
  • 未知或过期的 axN 引用会快速失败,而不是继续回退到 Playwright 的 aria-ref 选择器。发生这种情况时,请在同一标签页上运行新的快照。

等待增强功能

你可以等待的不只是时间/文本:
  • 等待 URL(Playwright 支持 glob):
    • openclaw browser wait --url "**/dash"
  • 等待加载状态:
    • openclaw browser wait --load networkidle
  • 等待 JS 谓词:
    • openclaw browser wait --fn "window.ready===true"
  • 等待选择器变为可见:
    • openclaw browser wait "#main"
这些可以组合使用:
openclaw browser wait "#main" \
  --url "**/dash" \
  --load networkidle \
  --fn "window.ready===true" \
  --timeout-ms 15000

调试工作流

当动作失败时(例如“不可见”、“严格模式违规”、“被遮挡”):
  1. openclaw browser snapshot --interactive
  2. 使用 click <ref> / type <ref>(在交互模式下优先使用角色引用)
  3. 如果仍然失败:运行 openclaw browser highlight <ref> 查看 Playwright 定位的目标
  4. 如果页面行为异常:
    • openclaw browser errors --clear
    • openclaw browser requests --filter api --clear
  5. 如需深度调试:录制跟踪:
    • openclaw browser trace start
    • 复现问题
    • openclaw browser trace stop(打印 TRACE:<path>

JSON 输出

--json 用于脚本和结构化工具。 示例:
openclaw browser status --json
openclaw browser snapshot --interactive --json
openclaw browser requests --filter api --json
openclaw browser cookies --json
JSON 中的角色快照包含 refs 以及一个小的 stats 块(行数/字符数/引用数/交互状态),以便工具推断载荷大小和密度。

状态与环境调节项

这些适用于“让站点表现得像 X”的工作流:
  • Cookie:cookiescookies setcookies clear
  • 存储:storage local|session get|set|clear
  • 离线:set offline on|off
  • 标头:set headers --headers-json '{"X-Debug":"1"}'(旧版 set headers --json '{"X-Debug":"1"}' 仍受支持)
  • HTTP 基本认证:set credentials user pass(或 --clear
  • 地理位置:set geo <lat> <lon> --origin "https://example.com"(或 --clear
  • 媒体:set media dark|light|no-preference|none
  • 时区 / 语言区域:set timezone ...set locale ...
  • 设备 / 视口:
    • set device "iPhone 14"(Playwright 设备预设)
    • set viewport 1280 720

安全与隐私

  • openclaw 浏览器配置文件可能包含已登录会话;请将其视为敏感信息。
  • browser act kind=evaluate / openclaw browser evaluatewait --fn 会在页面上下文中执行任意 JavaScript。提示注入可能会引导 这种行为。如果不需要,请用 browser.evaluateEnabled=false 禁用它。
  • 登录和反机器人说明(X/Twitter 等)请参阅浏览器登录 + X/Twitter 发帖
  • 保持 Gateway 网关/节点主机私有(仅限 loopback 或 tailnet)。
  • 远程 CDP 端点权限很强;请使用隧道并保护它们。
严格模式示例(默认阻止私有/内部目标):
{
  browser: {
    ssrfPolicy: {
      dangerouslyAllowPrivateNetwork: false,
      hostnameAllowlist: ["*.example.com", "example.com"],
      allowedHostnames: ["localhost"], // optional exact allow
    },
  },
}

相关内容