BrowserSolver CLI

Official command-line interface for the BrowserSolver web unlocker API.

Unlock, render, crawl and screenshot any website — anti-bot bypass and technology detection through one API.

Every documented endpoint is a command — 9 commands — and request reaches any other path. JSON responses are pretty-printed; files (images, PDFs…) are saved with -o.

Requirements

• Node.js 20 or newer
• a BrowserSolver API key

Install

npm install --global @browsersolver/cli
browsersolver --help

Or run it without installing:

npx @browsersolver/cli --help

Configure your API key

The CLI reads the key from the environment; it does not load .env files.

export BROWSERSOLVER_API_KEY="YOUR_API_KEY"

PowerShell:

$env:BROWSERSOLVER_API_KEY = "YOUR_API_KEY"

Usage

browsersolver website-webunlocker --query https://example.com

Parameters use the names of the API reference as flags: --full-page and --full_page are equivalent. Boolean flags can be bare (--flag) or explicit (--flag=false); array parameters accept commas or repeated flags.

browsersolver website-webunlocker --help     # parameters of one command
browsersolver endpoints                # every command and its HTTP path
browsersolver endpoints search         # filter the list

Save files

browsersolver website-screenshot --url https://example.com --format png -o screenshot.png

Binary responses are never written to a terminal: pass -o <file>, or -o - to pipe them.

JSON parameters

echo '{"query": "https://example.com"}' | browsersolver website-webunlocker --params -
browsersolver website-webunlocker --params params.json --compact

Flags override values read with --params.

Any endpoint

browsersolver request get /v1/usage
browsersolver request post /v1/some/new/endpoint --params body.json

Pipe into jq

browsersolver website-webunlocker --query https://example.com | jq .

Exit codes

Code	Meaning
0	Success.
1	The API returned an error (details on standard error) or the network failed.
2	Invalid usage: unknown command or parameter, missing API key or required parameter.

Commands

Command	HTTP	Description
jobs	GET /v1/jobs/{id}	Poll the status, progress (0–100) and result of a job started with is_async=true. Polling is free. Poll until status is…
stats	GET /v1/stats	Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant. Enabled per a…
usage	GET /v1/usage	Retrieve real-time usage statistics and credit balance for your BrowserSolver account.
website-antibot	GET /v1/website/antibot	Single-pass scan that names the bot-protection vendor in front of a URL so you can choose the right BrowserSolver fetch…
website-crawler	GET / POST /v1/website/crawler	Fast HTTP pull of public HTML with no browser session. Ideal when the first response already contains the content you n…
website-rendering	GET /v1/website/rendering	Run a managed browser session against a public URL and collect the HTML after client-side scripts finish. Prefer Crawle…
website-screenshot	GET / POST /v1/website/screenshot	Turn any public URL into a PNG, JPEG, WebP, or PDF asset rendered by BrowserSolver. No local Chromium fleet to operate.
website-technology	GET / POST /v1/website/technology	Map CMS, frameworks, analytics, CDN, and security tooling exposed by a public URL. Choose simple lists or expert metada…
website-webunlocker	GET / POST /v1/website/webunlocker	BrowserSolver's highest HTML fetch tier for retail and marketplace hosts on your account whitelist. Solves persistent b…

Built on the SDK

The CLI uses the official Node.js SDK (@browsersolver/sdk). Use the SDK directly for programmatic access.

All BrowserSolver SDKs

SDK	Package	Install
Node.js	@browsersolver/sdk	npm install @browsersolver/sdk
Python	browsersolver	pip install browsersolver
Go	browsersolver-go	go get github.com/browsersolver/browsersolver-go
.NET	BrowserSolver	dotnet add package BrowserSolver
Ruby	browsersolver	gem install browsersolver
PHP	browsersolver/sdk	composer require browsersolver/sdk
Java	browsersolver-java	build from source, see its README
CLI	@browsersolver/cli	npm install -g @browsersolver/cli
MCP server	@browsersolver/mcp	npx -y @browsersolver/mcp

License

MIT — see LICENSE.