跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt

Use this file to discover all available pages before exploring further.

​
全局选项

这些标志适用于任何命令：
标志说明
-k, --api-key <key>覆盖此请求的 API 密钥
--timing显示请求计时信息
-v, --version显示 CLI 版本

​
brightdata login

使用 Bright Data 进行身份验证。默认在浏览器中打开 OAuth。
标志说明
-k, --api-key <key>直接使用 API 密钥（跳过浏览器）
-c, --customer-id <id>Bright Data 账户 ID（可选）
-d, --device为 SSH/无头环境使用设备流
brightdata login                        # Browser OAuth (recommended)
brightdata login --device               # Headless/SSH environments
brightdata login --api-key <key>        # Direct API key
首次登录时，CLI 会自动创建 cli_unlocker 和 cli_browser 代理区域并设置合理的默认值。

​
brightdata logout

清除存储的凭证。 
brightdata logout

​
brightdata scrape <url>

使用 Bright Data 的 Web Unlocker 抓取任何 URL。自动处理验证码、JavaScript 渲染和反爬虫保护。
标志说明
-f, --format <fmt>markdown（默认）、html、screenshot、json
--country <code>ISO 国家代码用于地理定位（例如 us、de、jp）
--zone <name>Web Unlocker 区域名称
--mobile使用移动用户代理
--async异步提交，返回快照 ID
-o, --output <path>将输出写入文件
--json强制 JSON 输出
--pretty格式化打印 JSON 输出
brightdata scrape https://news.ycombinator.com

​
brightdata search <query>

通过 Bright Data 的 SERP API 搜索 Google、Bing 或 Yandex。Google 返回带有有机结果、广��、相关问题和相关搜索的结构化 JSON。Bing 和 Yandex 默认返回 markdown。
标志说明
--engine <name>google（默认）、bing、yandex
--country <code>本地化结果（例如 us、de）
--language <code>语言代码（例如 en、fr）
--page <n>页码，从 0 开始（默认：0）
--type <type>web（默认）、news、images、shopping
--device <type>desktop、mobile
--zone <name>SERP 区域名称
-o, --output <path>将输出写入文件
--json强制 JSON 输出
--pretty格式化打印 JSON 输出
brightdata search "typescript best practices"

​
brightdata pipelines <type> [params...] [options]

从 40 多个平台提取结构化数据。触发异步收集作业，轮询直到结果准备就绪，然后返回数据。
标志说明
--format <fmt>json（默认）、csv、ndjson、jsonl
--timeout <seconds>轮询超时（默认：600）
-o, --output <path>将输出写入文件
--json强制 JSON 输出
--pretty格式化打印 JSON 输出
# List all available pipeline types
brightdata pipelines list

brightdata pipelines linkedin_person_profile "https://linkedin.com/in/username"

​
支持的平台

类型平台参数
amazon_productAmazon 产品页面<url>
amazon_product_reviewsAmazon 评论<url>
amazon_product_searchAmazon 搜索结果<keyword> <domain_url>
walmart_productWalmart 产品页面<url>
walmart_sellerWalmart 卖家资料<url>
ebay_producteBay 产品列表<url>
bestbuy_productsBest Buy<url>
etsy_productsEtsy<url>
homedepot_productsHome Depot<url>
zara_productsZara<url>
google_shoppingGoogle Shopping<url>
类型平台参数
linkedin_person_profileLinkedIn 个人资料<url>
linkedin_company_profileLinkedIn 公司资料<url>
linkedin_job_listingsLinkedIn 职位列表<url>
linkedin_postsLinkedIn 帖子<url>
linkedin_people_searchLinkedIn 人员搜索<url> <first_name> <last_name>
crunchbase_companyCrunchbase<url>
zoominfo_company_profileZoomInfo<url>
类型平台参数
instagram_profilesInstagram 资料<url>
instagram_postsInstagram 帖子<url>
instagram_reelsInstagram 短视频<url>
instagram_commentsInstagram 评论<url>
facebook_postsFacebook 帖子<url>
facebook_marketplace_listingsFacebook Marketplace<url>
facebook_company_reviewsFacebook 评论<url> [num_reviews]
facebook_eventsFacebook 活动<url>
tiktok_profilesTikTok 资料<url>
tiktok_postsTikTok 帖子<url>
tiktok_shopTikTok 店铺<url>
tiktok_commentsTikTok 评论<url>
x_postsX（Twitter）帖子<url>
youtube_profilesYouTube 频道<url>
youtube_videosYouTube 视频<url>
youtube_commentsYouTube 评论<url> [num_comments]
reddit_postsReddit 帖子<url>
类型平台参数
google_maps_reviewsGoogle Maps 评论<url> [days_limit]
google_play_storeGoogle Play<url>
apple_app_storeApple App Store<url>
github_repository_fileGitHub 仓库文件<url>
yahoo_finance_businessYahoo Finance<url>
zillow_properties_listingZillow<url>
booking_hotel_listingsBooking.com<url>
随时在终端中运行 brightdata pipelines list 查看所有可用类型。

​
brightdata status <job-id>

检查异步快照作业的状态（来自 --async 抓取或管道收集）。
标志说明
--wait轮询直到作业完成
--timeout <seconds>轮询超时（默认：600）
-o, --output <path>将输出写入文件
--json / --prettyJSON 输出
brightdata status s_abc123xyz
brightdata status s_abc123xyz --wait --pretty
brightdata status s_abc123xyz --wait --timeout 300

​
brightdata zones

列出并检查 Bright Data 代理区域。 
brightdata zones                        # List all active zones
brightdata zones info <name>            # 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 budget

查看账户余额和按区域的成本/带宽。只读。
子命令说明
（无）快速账户余额
balance余额 + 待定费用
zones所有区域的成本和带宽表
zone <name>一个区域的详细成本和带宽
标志说明
--from <datetime>日期范围的开始（例如 2024-01-01T00:00:00）
--to <datetime>日期范围的结束
--json / --prettyJSON 输出
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 config

查看和管理 CLI 配置。
子命令说明
（无）显示所有配置
get <key>获取单个值
set <key> <value>设置一个值
配置键说明
default_zone_unlockerscrape 和 search 的默认区域
default_zone_serp仅 search 的覆盖区域
default_format默认输出格式：markdown 或 json
api_url覆盖 API 基础 URL
brightdata config
brightdata config set default_zone_unlocker my_zone
brightdata config set default_format json
brightdata config get default_zone_unlocker

​
brightdata init

交互式设置向导。引导完成身份验证、区域选择和默认配置。
标志说明
--skip-auth跳过身份验证步骤
-k, --api-key <key>直接提供 API 密钥
brightdata init

​
brightdata skill

将 Bright Data AI 代理技能安装到编码代理中（Claude Code、Cursor、Copilot 等）。
子命令说明
add交互式选择器 - 选择技能 + 目标代理
add <name>直接安装特定技能
list列出所有可用技能
可用技能：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