Skip to main content

Frequently asked general questions

They are identical - bdata is a shorthand alias installed alongside brightdata. Use whichever you prefer.
Yes. The CLI connects to Bright Data’s infrastructure to handle web requests. You can sign up for free and get started with the free tier.
The pipelines command runs any of the thousands of pre-built Scraper API scrapers, covering sites such as Amazon, LinkedIn, Instagram, TikTok, YouTube, Google Maps and Walmart. Run brightdata pipelines search <site or data type> to find a scraper and its dataset_id, then brightdata pipelines info <dataset_id> to see its collection methods.
CLI 0.4.0 removed the fixed pipeline types (brightdata pipelines amazon_product <url> and the others), brightdata pipelines list and the top-level brightdata status command. The old commands exit with a hint to the new ones. Find the scraper with brightdata pipelines search <site or data type>, run it with brightdata pipelines run <dataset_id> <method> <url> and check async runs with brightdata pipelines status <snapshot_id>.
  • Scrape: markdown (default), html, json, screenshot
  • Search: Formatted table (default), json, pretty
  • Pipelines: json (default), csv, ndjson, jsonl
All commands support -o <path> to write output to a file.
Yes. The CLI is fully pipe-friendly. When stdout is not a TTY, colors and spinners are automatically disabled. Use --json for machine-readable output and BRIGHTDATA_API_KEY environment variable for non-interactive authentication.

Authentication

Credentials are stored locally on your machine:The file is set to mode 0o600 (owner read/write only).
Use the device flow:
This prints a URL and a verification code. Open the URL on any device with a browser, enter the code, and authentication completes on the server.
Run brightdata logout followed by brightdata login with the new account. Or pass a different API key directly:

Troubleshooting

This means no default zone is configured. Fix it by either:
Your stored API key is no longer valid. Re-authenticate:
Your API key does not have permission for the requested zone or operation. Check zone permissions in the Bright Data control panel.
You’ve hit the rate limit for your zone. Options:
  • Wait a moment and retry
  • Use --async for large jobs to avoid blocking
  • Contact your account manager to increase limits
The default polling timeout is 600 seconds (10 minutes). For large datasets, increase it:
The CLI auto-detects TTY support. If detection fails, pipe through cat to force plain output:
Or use --json for clean, parseable output.

Frequently asked configuration questions

Valid values: markdown, json.
Settings are resolved in this order (highest priority first):
  1. CLI flags - e.g., --zone my_zone
  2. Environment variables - e.g., BRIGHTDATA_UNLOCKER_ZONE
  3. config.json - e.g., default_zone_unlocker
  4. Defaults - built-in fallbacks
Delete the configuration directory:
Then run brightdata login to start fresh.