Global options These flags work with any command:
Flag Description -k, --api-key <key>Override API key for this request --timingShow request timing info -v, --versionShow CLI version
brightdata loginAuthenticate with Bright Data. Opens the browser for OAuth by default.
Flag Description -k, --api-key <key>Use API key directly (skips browser) -c, --customer-id <id>Bright Data account ID (optional) -d, --deviceUse device flow for SSH/headless environments
brightdata login # Browser OAuth (recommended) brightdata login --device # Headless/SSH environments brightdata login --api-key < ke y > # Direct API key
On first login, the CLI automatically creates cli_unlocker and cli_browser proxy zones and sets sensible defaults.
brightdata logoutClear stored credentials.
brightdata scrape <url>Scrape any URL using Bright Data’s Web Unlocker. Handles CAPTCHAs, JavaScript rendering, and anti-bot protections automatically.
Flag Description -f, --format <fmt>markdown (default), html, screenshot, json--country <code>ISO country code for geo-targeting (e.g. us, de, jp) --zone <name>Web Unlocker zone name --mobileUse a mobile user agent --asyncSubmit async, return a snapshot ID -o, --output <path>Write output to file --jsonForce JSON output --prettyPretty-print JSON output
Markdown (default)
HTML
JSON with geo-targeting
Screenshot
Async mode
Pipe to markdown reader
brightdata scrape https://news.ycombinator.com
brightdata search <query>Search Google, Bing, or Yandex via Bright Data’s SERP API. Google returns structured JSON with organic results, ads, People Also Ask, and related searches. Bing and Yandex return markdown by default.
Flag Description --engine <name>google (default), bing, yandex--country <code>Localized results (e.g. us, de) --language <code>Language code (e.g. en, fr) --page <n>Page number, 0-indexed (default: 0) --type <type>web (default), news, images, shopping--device <type>desktop, mobile--zone <name>SERP zone name -o, --output <path>Write output to file --jsonForce JSON output --prettyPretty-print JSON output
Basic search
Localized search
News search
Pagination
Extract URLs with jq
Bing search
brightdata search "typescript best practices"
brightdata pipelines <type> [params...] [options]Extract structured data from 40+ platforms. Triggers an async collection job, polls until results are ready, and returns the data.
Flag Description --format <fmt>json (default), csv, ndjson, jsonl--timeout <seconds>Polling timeout (default: 600) -o, --output <path>Write output to file --jsonForce JSON output --prettyPretty-print JSON output
# List all available pipeline types brightdata pipelines list
LinkedIn profile
Amazon product
Amazon search
Instagram profile
YouTube comments
CSV export
brightdata pipelines linkedin_person_profile "https://linkedin.com/in/username"
Type Platform Parameters amazon_productAmazon product page <url>amazon_product_reviewsAmazon reviews <url>amazon_product_searchAmazon search results <keyword> <domain_url>walmart_productWalmart product page <url>walmart_sellerWalmart seller profile <url>ebay_producteBay listing <url>bestbuy_productsBest Buy <url>etsy_productsEtsy <url>homedepot_productsHome Depot <url>zara_productsZara <url>google_shoppingGoogle Shopping <url>
Type Platform Parameters linkedin_person_profileLinkedIn person <url>linkedin_company_profileLinkedIn company <url>linkedin_job_listingsLinkedIn jobs <url>linkedin_postsLinkedIn posts <url>linkedin_people_searchLinkedIn people search <url> <first_name> <last_name>crunchbase_companyCrunchbase <url>zoominfo_company_profileZoomInfo <url>
Type Platform Parameters google_maps_reviewsGoogle Maps reviews <url> [days_limit]google_play_storeGoogle Play <url>apple_app_storeApple App Store <url>reuter_newsReuters news <url>github_repository_fileGitHub repository files <url>yahoo_finance_businessYahoo Finance <url>zillow_properties_listingZillow <url>booking_hotel_listingsBooking.com <url>
Run brightdata pipelines list in your terminal to see all available types at any time.
brightdata status <job-id>Check the status of an async snapshot job (from --async scrapes or pipeline collections).
Flag Description --waitPoll until the job completes --timeout <seconds>Polling timeout (default: 600) -o, --output <path>Write output to file --json / --prettyJSON output
brightdata status s_abc123xyz brightdata status s_abc123xyz --wait --pretty brightdata status s_abc123xyz --wait --timeout 300
brightdata zonesList and inspect Bright Data proxy zones.
brightdata zones # List all active zones brightdata zones info < nam e > # Full details for a zone brightdata zones --json -o zones.json # Export as JSON brightdata zones info my_zone --pretty # Pretty-print zone info
brightdata budgetView account balance and per-zone cost/bandwidth. Read-only.
Subcommand Description (none) Quick account balance balanceBalance + pending charges zonesCost & bandwidth table for all zones zone <name>Detailed cost & bandwidth for one zone
Flag Description --from <datetime>Start of date range (e.g. 2024-01-01T00:00:00) --to <datetime>End of date range --json / --prettyJSON output
brightdata budget brightdata budget balance brightdata budget zones brightdata budget zone my_zone brightdata budget zones --from 2024-01-01T00:00:00 --to 2024-02-01T00:00:00
brightdata configView and manage CLI configuration.
Subcommand Description (none) Show all config get <key>Get a single value set <key> <value>Set a value
Config Key Description default_zone_unlockerDefault zone for scrape and search default_zone_serpOverride zone for search only default_formatDefault output format: markdown or json api_urlOverride API base URL
brightdata config brightdata config set default_zone_unlocker my_zone brightdata config set default_format json brightdata config get default_zone_unlocker
brightdata initInteractive setup wizard. Walks through authentication, zone selection, and default configuration.
Flag Description --skip-authSkip the authentication step -k, --api-key <key>Provide API key directly
brightdata skillInstall Bright Data AI agent skills into coding agents (Claude Code, Cursor, Copilot, etc.).
Subcommand Description addInteractive picker - choose skills + target agents add <name>Install a specific skill directly listList all available skills
Available skills: search, scrape, data-feeds, bright-data-mcp, bright-data-best-practices
brightdata skill add # Interactive picker brightdata skill add scrape # Direct install brightdata skill list # See what's available
instagram_profiles<url>instagram_posts<url>instagram_reels<url>instagram_comments<url>facebook_posts<url>facebook_marketplace_listings<url>facebook_company_reviews<url> [num_reviews]facebook_events<url>tiktok_profiles<url>tiktok_posts<url>tiktok_shop<url>tiktok_comments<url>x_posts<url>youtube_profiles<url>youtube_videos<url>youtube_comments<url> [num_comments]reddit_posts<url>