Skip to content

Use vibium as a WebDriver BiDi endpoint

If you already have a WebDriver BiDi client — Selenium, WebdriverIO, Puppeteer’s BiDi mode, or something you wrote — you do not need a vibium client library to use vibium. vibium serve is a BiDi endpoint that manages its own browser.

Terminal window
vibium serve --headless --port 9633
# Server listening on ws://localhost:9633

Point your client at that URL and speak standard BiDi. There is no chromedriver to install, and no POST /session handshake — connect the WebSocket and send commands.

→ {"id":1,"method":"session.status","params":{}}
← {"id":1,"result":{"build":{"version":"151.0.7922.71"},"ready":false}}
→ {"id":2,"method":"browsingContext.getTree","params":{}}
← {"id":2,"result":{"contexts":[{"context":"E1B0A6CA...","url":"about:blank"}]}}
→ {"id":3,"method":"browsingContext.navigate",
"params":{"context":"E1B0A6CA...","url":"https://example.com","wait":"complete"}}
← {"id":3,"result":{"navigation":"1496dc0f-...","url":"https://example.com/"}}

Events arrive unsolicited, as usual:

← {"method":"browsingContext.contextCreated","params":{...}}
← {"method":"browsingContext.navigationStarted","params":{...}}
← {"method":"network.beforeRequestSent","params":{...}}
← {"method":"browsingContext.load","params":{...}}

vibium downloads and launches Chrome for Testing on the first connection and cleans it up when you disconnect.


serve is one of two ways to reach vibium, and it is the right one only for some jobs.

You haveUseWhy
An existing BiDi clientvibium serveIt already speaks BiDi over a WebSocket. Nothing to integrate.
A vibium client library (JS, Python, Java)those clientsThey spawn vibium pipe for you.
A new client library you are writingvibium pipeNo port, no auth, browser lifetime tied to your process. See the client implementation guide.

Do not chain them. vibium pipe --connect ws://localhost:9633 works, but it inserts a second router that translates nothing.


serve also accepts vibium’s vibium: commands on the same connection — actionability-aware clicks, semantic locators, recording. Those are additions to BiDi, not replacements, so a plain BiDi client can ignore them entirely.

→ {"id":4,"method":"vibium:browser.page","params":{}}
← {"id":4,"type":"success","result":{"context":"B0EC708F...","userContext":"default"}}

See the API reference for the full list.


serve binds to 127.0.0.1 and rejects WebSocket upgrades whose Origin is not local. Browser automation is a remote code execution surface, so it is not exposed to the network by default.

To reach it from a container or another machine, forward a local port rather than binding wider — for example ssh -L 9633:localhost:9633 user@host, or Docker’s -p 127.0.0.1:9633:9633 with the server inside the container.

Clients that are not browsers (most BiDi libraries) send no Origin header and connect normally.

The port itself carries no authentication. Loopback keeps remote machines and web pages out, but any process or user on the same host can connect and drive the browser — including navigating to file:// URLs. That is the standard posture for local automation tools. On a host you share with untrusted users, do not leave serve running; use vibium pipe, whose lifetime is tied to the client process and which exchanges no network port at all.


You want one browser shared by several clients. Each connection to serve gets its own browser and its own session. For concurrent CLI use, see running concurrent CLI sessions.

You want the browser to outlive the connection. It does not. Disconnecting closes the browser. The daemon behind the vibium CLI is what keeps a browser alive between commands.