Caricamento in corso...
Caricamento in corso...
Last synced: Today, 22:00
Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.
Use this file to discover all available pages before exploring further.
openclaw browserManage OpenClaw's browser control surface and run browser actions (lifecycle, profiles, tabs, snapshots, screenshots, navigation, input, state emulation, and debugging).
Related:
--url <gatewayWsUrl>--token <token>--timeout <ms>--expect-final--browser-profile <name>--jsonbashopenclaw browser profiles openclaw browser --browser-profile openclaw start openclaw browser --browser-profile openclaw open https://example.com openclaw browser --browser-profile openclaw snapshot
Agents can run the same readiness check with
browser({ action: "doctor" })If
startnot reachable after startstarttabsopennavigateMinimal sequence:
bashopenclaw browser --browser-profile openclaw doctor openclaw browser --browser-profile openclaw start openclaw browser --browser-profile openclaw tabs openclaw browser --browser-profile openclaw open https://example.com
Detailed guidance: Browser troubleshooting
bashopenclaw browser status openclaw browser doctor openclaw browser doctor --deep openclaw browser start openclaw browser start --headless openclaw browser stop openclaw browser --browser-profile openclaw reset-profile
Notes:
doctor --deepattachOnlyopenclaw browser stopopenclaw browser stopopenclaw browser start --headlessbrowser.headlessDISPLAYWAYLAND_DISPLAYOPENCLAW_BROWSER_HEADLESS=0browser.headless=falsebrowser.profiles.<name>.headless=falseIf
openclaw browserplugins.allow~/.openclaw/openclaw.jsonWhen
plugins.allowbrowserjson5{ plugins: { allow: ["telegram", "browser"], }, }
An explicit root
browserbrowser.enabled=truebrowser.profiles.<name>Related: Browser tool
Profiles are named browser routing configs. In practice:
openclawuserbashopenclaw browser profiles openclaw browser create-profile --name work --color "#FF5A36" openclaw browser create-profile --name chrome-live --driver existing-session openclaw browser create-profile --name remote --cdp-url https://browser-host.example.com openclaw browser delete-profile --name work
Use a specific profile:
bashopenclaw browser --browser-profile work tabs
bashopenclaw browser tabs openclaw browser tab new --label docs openclaw browser tab label t1 docs openclaw browser tab select 2 openclaw browser tab close 2 openclaw browser open https://docs.openclaw.ai --label docs openclaw browser focus docs openclaw browser close t1
tabssuggestedTargetIdtabIdt1targetIdsuggestedTargetIdfocuscloseopen --labeltab new --labeltab labeltabIdsuggestedTargetIdSnapshot:
bashopenclaw browser snapshot openclaw browser snapshot --urls
Screenshot:
bashopenclaw browser screenshot openclaw browser screenshot --full-page openclaw browser screenshot --ref e12 openclaw browser screenshot --labels
Notes:
--full-page--ref--elementexisting-sessionuser--ref--element--labelssnapshot --urlsNavigate/click/type (ref-based UI automation):
bashopenclaw browser navigate https://example.com openclaw browser click <ref> openclaw browser click-coords 120 340 openclaw browser type <ref> "hello" openclaw browser press Enter openclaw browser hover <ref> openclaw browser scrollintoview <ref> openclaw browser drag <startRef> <endRef> openclaw browser select <ref> OptionA OptionB openclaw browser fill --fields '[{"ref":"1","value":"Ada"}]' openclaw browser wait --text "Done" openclaw browser evaluate --fn '(el) => el.textContent' --ref <ref>
Action responses return the current raw
targetIdsuggestedTargetIdFile + dialog helpers:
bashopenclaw browser upload /tmp/openclaw/uploads/file.pdf --ref <ref> openclaw browser waitfordownload openclaw browser download <ref> report.pdf openclaw browser dialog --accept
Managed Chrome profiles save ordinary click-triggered downloads into the OpenClaw downloads directory (
/tmp/openclaw/downloadswaitfordownloaddownloadViewport + emulation:
bashopenclaw browser resize 1280 720 openclaw browser set viewport 1280 720 openclaw browser set offline on openclaw browser set media dark openclaw browser set timezone Europe/London openclaw browser set locale en-GB openclaw browser set geo 51.5074 -0.1278 --accuracy 25 openclaw browser set device "iPhone 14" openclaw browser set headers '{"x-test":"1"}' openclaw browser set credentials myuser mypass
Cookies + storage:
bashopenclaw 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 token abc123 openclaw browser storage session clear
bashopenclaw browser console --level error openclaw browser pdf openclaw browser responsebody "**/api" openclaw browser highlight <ref> openclaw browser errors --clear openclaw browser requests --filter api openclaw browser trace start openclaw browser trace stop --out trace.zip
Use the built-in
userexisting-sessionbashopenclaw browser --browser-profile user tabs openclaw browser create-profile --name chrome-live --driver existing-session openclaw browser create-profile --name brave-live --driver existing-session --user-data-dir "~/Library/Application Support/BraveSoftware/Brave-Browser" openclaw browser --browser-profile chrome-live tabs
This path is host-only. For Docker, headless servers, Browserless, or other remote setups, use a CDP profile instead.
Current existing-session limits:
browser.actionTimeoutMsacttimeoutMstimeoutMsclicktypeslowly=truepressdelayMshoverscrollintoviewdragselectfillevaluateselectwait --load networkidle--ref--input-ref--element--timeout--ref--elementresponsebodyIf the Gateway runs on a different machine than the browser, run a node host on the machine that has Chrome/Brave/Edge/Chromium. The Gateway will proxy browser actions to that node (no separate browser control server required).
Use
gateway.nodes.browser.modegateway.nodes.browser.nodeSecurity + remote setup: Browser tool, Remote access, Tailscale, Security
© 2024 TaskFlow Mirror
Powered by TaskFlow Sync Engine