`opencli host install` is no longer a required setup step. Global postinstall writes the Chrome Native Messaging manifest; the first browser command still repairs it if Chrome was not installed yet.
4.7 KiB
Browser Bridge Setup
⚠️ Important: Browser commands reuse your Chrome login session. You must be logged into the target website in Chrome before running commands.
OpenCLI connects to your browser through a lightweight Browser Bridge Chrome extension. Chrome parents a native host via Native Messaging; the CLI never listens on a TCP port.
Extension Installation
Method 1: Download Pre-built Release (Recommended)
- Go to the GitHub Releases page and download the latest
opencli-extension-v{version}.zip. - Unzip the file and open
chrome://extensions, enable Developer mode (top-right toggle). - Click Load unpacked and select the unzipped folder.
Method 2: Load Unpacked Source (For Developers)
- Open
chrome://extensionsand enable Developer mode. - Click Load unpacked and select the
extension/directory from the repository.
Verification
That's it! npm install -g already registers the Native Messaging host. With Chrome open and the extension enabled (reload it if Chrome was already running), Chrome spawns opencli-host. No tokens, no TCP daemon, no extra opencli host install.
opencli doctor # Check extension + native host connectivity
Tab Targeting
Browser commands require an explicit <session> positional immediately after browser. Use the same session name for a multi-step flow, and use different names to isolate parallel work.
opencli browser baidu open https://www.baidu.com/
opencli browser baidu tab list
opencli browser baidu tab new https://www.baidu.com/
opencli browser baidu eval --tab <targetId> 'document.title'
opencli browser baidu tab select <targetId>
opencli browser baidu get title
opencli browser baidu tab close <targetId>
Key rules:
opencli browser <session> open <url>andopencli browser <session> tab new [url]return atargetId.opencli browser <session> tab listprints thetargetIdvalues of tabs that already exist.--tab <targetId>routes a single browser command to that specific tab.tab newcreates a new tab but does not change the default browser target.tab select <targetId>makes that tab the default target for later untargetedopencli browser ...commands.tab close <targetId>removes the tab; if it was the current default target, the stored default is cleared.
Session Lifecycle
Use a stable session name when you want multiple opencli browser commands to keep operating on the same page:
opencli browser my-session open https://example.com
opencli browser my-session state
opencli browser my-session extract "main"
Owned browser sessions use an interactive tab lease with a 10-minute idle timeout. Release it explicitly when done:
opencli browser my-session close
Use opencli browser <session> bind when you want to attach OpenCLI to a Chrome tab you already opened manually. Bound sessions do not have the owned-session idle close timer; they stay attached until unbind, tab close, window close, or Chrome exit. For owned sessions, use --window foreground to watch OpenCLI work in a visible automation window, or --window background to keep that automation window out of the way.
The OpenCLI Browser and OpenCLI Adapter tab groups are extension-managed automation containers; avoid putting your own long-lived tabs in them or renaming them.
How It Works
┌─────────────┐ unix socket ┌──────────────┐ Native Messaging ┌─────────┐
│ opencli │ ──────────────► │ opencli-host │ ◄──────────────── │ Chrome │
│ (CLI) │ ~/.opencli/run │ (Chrome-owned)│ connectNative │ Extension│
└─────────────┘ └──────────────┘ └─────────┘
Chrome spawns opencli-host via chrome.runtime.connectNative(). The CLI only connect()s the host's unix socket. The extension still drives pages with chrome.debugger. There is no :19825 and the CLI never listen()s.
Host lifecycle
Chrome parents opencli-host. Closing Chrome stops the host. Reload the OpenCLI extension to spawn it again. There is no opencli daemon stop.
After npm install -g @jackwener/opencli@latest, the next browser command asks a version-skewed host to exit via host-exit; Chrome's onDisconnect respawns the new binary. Reload the extension if that does not happen.
Running OpenCLI from a remote machine
Remote orchestration over a forwarded TCP port is gone with the daemon. The native host is local to the Chrome profile that spawned it.