Integrations / Automation libraries / browz CLI
Browser profiles from your shell.
The browz command is built into the Browz agent. It finds the running app by itself, works with profiles by name or id, and prints JSON for scripts, so a cron job or CI step can start the right profile without any code.
alias browz="/Applications/Browz.app/Contents/Resources/browz-agent"
browz statusSetup
Set it up.
Install Browz and open it
Add the command
On a Mac it is inside the app. It reads the token and port from the Browz data folder, so no token goes on the command line.
Shellalias browz="/Applications/Browz.app/Contents/Resources/browz-agent" browz statusCreate a profile with a proxy
Add the proxy to the pool once, then give it to profiles by name.
Shellbrowz proxy add "Sydney residential" --host 203.0.113.10 --port 8080 --scheme http browz check "Sydney residential" browz create "Shop – Sydney" --proxy "Sydney residential"Start, list, stop
Shellbrowz start "Shop – Sydney" browz list browz stop "Shop – Sydney"
Example
A script: start a profile, use its debug port, stop it.
--json prints the API’s answer, so jq can pick out the CDP endpoint for a library, and browz json calls any route directly.
#!/bin/sh
set -eu
PROFILE="Shop – Sydney"
CDP=$(browz --json start "$PROFILE" | jq -r .cdpEndpoint)
echo "DevTools at $CDP"
ID=$(browz --json list | jq -r --arg n "$PROFILE" '.[] | select(.name == $n) | .id')
browz json POST /api/v1/browser/navigate "{\"id\":\"$ID\",\"url\":\"https://example.com\"}"
browz stop "$PROFILE"Good to know
Notes and tips.
- Proxy passwords given with
--passend up in your shell history. Add proxies with credentials in the app or through the API, and givebrowz checkthe password inBROWZ_PROXY_PASS: Browz never returns a stored password, so checking a proxy that has one needs it again. - Run
browzwith no arguments for every command and option. - Attach to the browser Browz started; never let the library launch its own. A library-launched browser is a stock one with none of the profile’s fingerprint, proxy or cookies.
- A person completes sign-ins, 2FA codes and CAPTCHAs in the profile’s window; your script can wait for the page that follows. Browz never solves or bypasses CAPTCHAs.
- Automate only where each site’s terms allow it. Our acceptable use policy applies to scripts the same as to people.
- The local API, CDP and the SDKs are on every plan, Free included (5 profiles), and are not metered.
FAQ
browz CLI and Browz.
Where is the command on Windows and Linux?
It is the browz-agent program that ships with Browz, on every system; a link to it named browz works the same way as the alias.
Can I create many profiles at once?
Yes: browz create "Shop" --count 10 --group "Shops" makes Shop-1 to Shop-10 in one folder, up to 100 at a time and within your plan’s profiles.
Does the CLI need the app open?
Yes. It talks to the running Browz agent through the local API, like the SDKs.
Get started
Download Browz. Every task, its own browser.
curl -fsSL https://gobrowz.com/agents/install.sh | sh