Skip to main content
Install the CLI with Node.js 22.13 or newer:
Or use npx @bridgly/cli to use without installing.

​
Log in

Paste your dashboard API key into the hidden prompt. The CLI verifies it with a balance read, then saves it locally in your OS user-config directory. The login persists across terminals and restarts; it does not edit your shell profile. The key is stored as plaintext with owner-only file permissions on Unix systems. For scripts, use BRIDGLY_API_KEY or override it for one invocation:
The key priority is --api-key flag, then BRIDGLY_API_KEY environment variable, and finally saved login. Prefer the hidden prompt or an environment secret over inline keys that can appear in shell history and process arguments.
Logout removes the saved credential. Revoke the key separately in the dashboard if needed, and unset BRIDGLY_API_KEY separately if your shell still exports it.

​
Find commands

list needs no key and makes no API calls. It includes published scraping endpoints and read-only account endpoints. Commands and flags are generated from the shared API registry, so new published endpoints appear in the next CLI release automatically.

​
Call an endpoint

Use bridgly <platform> <action> [--field value ...]:
Flags use kebab-case; original camelCase field names are also accepted. Defaults and validation come from the API schemas. Arrays accept multiple values, repeated flags, or JSON. Objects accept JSON or dotted nested flags. A bare boolean flag means true, and explicit true or false values are accepted.
Each scraping command makes one request with normal credit costs. The CLI does not automatically retry or fetch additional pages.

​
Check credits

These read credits and billing settings without spending scraping credits. Payment operations and billing updates are not exposed.

​
Format and save results

API commands default to full JSON responses including timeMs, creditsCost, and data. list defaults to a table. CSV and tables render data, flatten nested objects with dotted column names, and keep nested arrays as JSON cells. Arrays become rows; when data contains exactly one array field, that array is used as the rows. Use JSON to retain all pagination and response metadata. --output writes to a file, creates parent directories, and replaces existing file contents. .json and .csv infer the format unless --format overrides it. Progress and errors go to stderr so stdout can be piped into other tools. Set BRIDGLY_API_BASE_URL or --base-url to use another API origin for local development.