CLI - Firecrawl Docs

直接在终端中执行搜索、抓取、交互、爬取、Map，并运行代理任务。Firecrawl CLI 既可独立使用，也可结合技能；Codex、Claude Code、Cursor 和 OpenCode 等 AI 编码代理可以自动发现并使用这些技能。

安装#

如果你正在使用某个 AI 代理，例如 Codex、Claude Code、Cursor 或 OpenCode，你可以安装下面的 Firecrawl 技能，代理将为你完成设置。

npx -y firecrawl-cli@latest init --all --browser

--all 会跳过代理选择，并初始化所有检测到的代理
--browser 会自动打开浏览器以完成 Firecrawl 身份验证

Note

安装这些技能后，请重启你的代理，以便其发现它们。

你也可以使用 npm 手动全局安装 Firecrawl CLI：

CLI

# 使用 npm 全局安装npm install -g firecrawl-cli

身份验证#

使用 CLI 之前，您需要使用 Firecrawl API 密钥进行身份验证。

Note

某些 CLI 命令无需登录即可使用。 如果未配置 API 密钥，受支持的命令会自动使用免密钥免费档位——免费，但会按 IP 限流。有关当前免密钥命令列表和注意事项，请参见限流。注册获取免费密钥，即可获得 1,000 额度和更高限额；配置完成后，CLI 会自动使用它。

CLI

# 交互式登录(打开浏览器或提示输入 API 密钥)firecrawl login# 使用浏览器身份验证登录(推荐用于代理)firecrawl login --browser# 直接使用 API 密钥登录firecrawl login --api-key fc-YOUR-API-KEY# 或通过环境变量设置export FIRECRAWL_API_KEY=fc-YOUR-API-KEY

查看配置#

CLI

# 查看当前配置和身份验证状态firecrawl view-config

退出登录#

CLI

# 清除已存储的凭据firecrawl logout

将 CLI 连接到自托管的 Firecrawl#

首先，按照自托管指南完成一次抓取。然后通过 --api-url 或 FIRECRAWL_API_URL 将 CLI 指向该 API：

CLI

# 使用本地 Firecrawl 实例(无需 API 密钥)firecrawl --api-url http://localhost:3002 scrape https://example.com# Or set via environment variableexport FIRECRAWL_API_URL=http://localhost:3002firecrawl scrape https://example.com# Configure and persist the custom API URLfirecrawl config --api-url http://localhost:3002

使用自定义 API URL 而非 https://api.firecrawl.dev 时，CLI 会跳过 Firecrawl Cloud API 密钥身份验证。这与受信任网络快速入门中的设置一致：USE_DB_AUTHENTICATION=false。

Warning

请仅在受信任网络中运行未经身份验证的 API。如果添加身份验证代理或其他访问控制层，请先确认 CLI 能够发送该层所需的凭据，再采用此方式。

CLI 只能调用部署中已启用的功能。使用仅限 Cloud 或依赖提供商的命令前，请查看自托管功能支持。

检查状态#

验证安装和身份验证，并查看速率限制：

CLI

firecrawl --status

就绪时的输出：

  🔥 firecrawl cli v1.16.2  ● Authenticated via FIRECRAWL_API_KEY  Concurrency: 0/100 jobs (parallel scrape limit)  Credits: 500,000 remaining

并发数 (Concurrency) ：最大并行任务数。并行操作应尽量接近该上限，但不要超过。
额度 (Credits) ：剩余 API 额度。每次抓取/爬取都会消耗额度。

命令#

Note

隐藏的 firecrawl browser 命令已弃用，不再用于代理工作流。请先使用 firecrawl scrape <url>，再结合生成的抓取会话使用 firecrawl interact ...。

Scrape#

抓取单个 URL，并以多种 formats 输出其内容。

Tip

使用 --only-main-content 即可获取不含导航栏、页脚和广告的干净输出。对于大多数只需要文章或主页面内容的用例，推荐使用该选项。

CLI

# 抓取 URL(默认:markdown 输出)firecrawl https://example.com# 或使用显式的 scrape 命令firecrawl scrape https://example.com# 推荐:使用 --only-main-content 获取不含导航/页脚的干净输出firecrawl https://example.com --only-main-content

输出 formats 类型#

CLI

# 获取 HTML 输出firecrawl https://example.com --html# 多种格式（返回 JSON）firecrawl https://example.com --format markdown,links# 获取页面中的图片firecrawl https://example.com --format images# 获取页面内容摘要firecrawl https://example.com --format summary# 跟踪页面变化firecrawl https://example.com --format changeTracking# 可用格式：markdown, html, rawHtml, links, screenshot, json, images, summary, changeTracking, attributes, branding, product

抓取选项#

CLI

# 仅提取主要内容(移除导航和页脚)firecrawl https://example.com --only-main-content# Wait for JavaScript renderingfirecrawl https://example.com --wait-for 3000# Take a screenshotfirecrawl https://example.com --screenshot# 使用 schema 提取结构化 JSONfirecrawl https://example.com --format json --schema '{"type":"object","properties":{"title":{"type":"string"}}}'# 在提取前执行轻量级 scrape actionsfirecrawl https://example.com --actions '[{"type":"wait","milliseconds":1000}]'# 选择代理模式firecrawl https://example.com --proxy basic# 脱敏个人身份信息firecrawl https://example.com --redact-pii# Include/exclude specific HTML tagsfirecrawl https://example.com --include-tags article,mainfirecrawl https://example.com --exclude-tags nav,footer# Save output to filefirecrawl https://example.com -o output.md# Pretty print JSON outputfirecrawl https://example.com --format markdown,links --pretty# Force JSON output even with single formatfirecrawl https://example.com --json# Show request timing informationfirecrawl https://example.com --timing

可用选项：

选项	简写	描述
`--url <url>`	`-u`	要抓取的 URL (位置参数的替代方式)
`--format <formats>`	`-f`	输出 formats (逗号分隔) ：`markdown`, `html`, `rawHtml`, `links`, `screenshot`, `json`, `images`, `summary`, `changeTracking`, `attributes`, `branding`
`--html`	`-H`	`--format html` 的快捷方式
`--only-main-content`		仅提取主要内容
`--wait-for <ms>`		等待 JS 渲染的时间 (毫秒)
`--screenshot`		生成页面截图
`--full-page-screenshot`		生成整页截图
`--include-tags <tags>`		要包含的 HTML 标签 (逗号分隔)
`--exclude-tags <tags>`		要排除的 HTML 标签 (逗号分隔)
`--schema <json>`		用于结构化提取的 JSON schema
`--schema-file <path>`		JSON schema 文件路径
`--actions <json>`		抓取期间要执行的 JSON actions 数组
`--actions-file <path>`		JSON actions 文件路径
`--proxy <proxy>`		抓取使用的代理模式 (例如 `auto` 或 `basic`)
`--redact-pii`		对返回内容中的个人身份识别信息进行脱敏处理
`--output <path>`	`-o`	将输出保存到文件
`--json`		即使只有单一 format 也强制输出 JSON
`--pretty`		对 JSON 输出进行格式化打印
`--timing`		显示请求耗时和其他有用信息

搜索#

搜索网页，并按需抓取结果。

CLI

# 搜索网络firecrawl search "web scraping tutorials"# 限制结果数量firecrawl search "AI news" --limit 10# 美化打印结果firecrawl search "machine learning" --pretty

搜索选项#

CLI

# Search specific sourcesfirecrawl search "AI" --sources web,news,images# Search with category filtersfirecrawl search "react hooks" --categories developerfirecrawl search "machine learning" --categories research,pdf# Time-based filteringfirecrawl search "tech news" --tbs qdr:h   # Last hourfirecrawl search "tech news" --tbs qdr:d   # Last dayfirecrawl search "tech news" --tbs qdr:w   # Last weekfirecrawl search "tech news" --tbs qdr:m   # 过去一个月firecrawl search "tech news" --tbs qdr:y   # Last year# Location-based searchfirecrawl search "restaurants" --location "Berlin,Germany" --country DE# Search and scrape resultsfirecrawl search "documentation" --scrape --scrape-formats markdown# Save to filefirecrawl search "firecrawl" --pretty -o results.json

可用选项：

选项	描述
`--limit <number>`	结果数量上限 (默认：5，最大：100)
`--sources <sources>`	要搜索的数据源：`web`、`images`、`news` (逗号分隔)
`--categories <categories>`	按类别过滤：`research`、`pdf`、`developer` (逗号分隔)
`--tbs <value>`	时间过滤：`qdr:h` (小时) 、`qdr:d` (天) 、`qdr:w` (周) 、`qdr:m` (月) 、`qdr:y` (年)
`--location <location>`	地域定向 (例如："Berlin,Germany")
`--country <code>`	ISO 国家代码 (默认：US)
`--timeout <ms>`	以毫秒为单位的超时时间 (默认：60000)
`--ignore-invalid-urls`	排除对其他 Firecrawl 端点无效的 URL
`--scrape`	抓取搜索结果
`--scrape-formats <formats>`	抓取内容的 formats (默认：markdown)
`--only-main-content`	抓取时仅包含主要内容 (默认：true)
`--json`	以 JSON 格式输出
`--output <path>`	将输出保存到文件
`--pretty`	以易读格式打印 JSON 输出

开发者#

搜索 Developer Index——涵盖公开代码仓库中的 issue、已合并的 pull request 和 README，以及精选文档站点。

CLI

firecrawl developer "how do I configure retries" --limit 10

可用选项：

选项	描述
`--limit <number>`	返回结果数量 (默认值：10，最大值：100)
`--skills-only`	仅搜索已编入索引的 agent-skill 文件 (默认值：false)
`--json`	以紧凑的 JSON 格式输出
`--output <path>`	将输出保存到文件
`--pretty`	以易读格式打印 JSON 输出

Map#

快速发现站点中的所有 URL。

CLI

# 发现网站上的所有 URLfirecrawl map https://example.com# Output as JSONfirecrawl map https://example.com --json# Limit number of URLsfirecrawl map https://example.com --limit 500

Map 命令选项#

CLI

# Filter URLs by search queryfirecrawl map https://example.com --search "blog"# Include subdomainsfirecrawl map https://example.com --include-subdomains# 控制站点地图使用方式firecrawl map https://example.com --sitemap include   # 使用站点地图firecrawl map https://example.com --sitemap skip      # 跳过站点地图firecrawl map https://example.com --sitemap only      # 仅使用站点地图# Ignore query parameters (dedupe URLs)firecrawl map https://example.com --ignore-query-parameters# Wait for map to complete with timeoutfirecrawl map https://example.com --wait --timeout 60# Save to filefirecrawl map https://example.com -o urls.txtfirecrawl map https://example.com --json --pretty -o urls.json

可用选项：

选项	描述
`--url <url>`	要进行 Map 的 URL (可替代位置参数)
`--limit <number>`	要发现的最大 URL 数量
`--search <query>`	根据搜索查询筛选 URL
`--sitemap <mode>`	Sitemap 处理模式：`include`、`skip`、`only`
`--include-subdomains`	包含子域名
`--ignore-query-parameters`	将带有不同参数的 URL 视为同一 URL
`--wait`	等待 Map 完成
`--timeout <seconds>`	超时时间 (秒)
`--json`	以 JSON 格式输出
`--output <path>`	将输出保存到文件
`--pretty`	以易读格式打印 JSON 输出

交互#

先抓取网页，然后使用自然语言或代码与页面交互。交互默认使用最近一次抓取的结果，也可以传入指定的抓取 ID。

CLI

# 1. 抓取 Amazon 首页（scrape ID 自动保存）firecrawl scrape https://www.amazon.com# 2. 交互 — 搜索商品并获取价格firecrawl interact "Search for iPhone 16 Pro Max"firecrawl interact "Click on the first result and tell me the price"# 3. 停止会话firecrawl interact stop

可用选项：

选项	描述
`-p, --prompt <text>`	AI prompt (可替代位置参数)
`-c, --code <code>`	在当前页面会话中执行代码
`-s, --scrape-id <id>`	抓取任务 ID (默认：最近一次抓取)
`--python`	以 Python/Playwright 执行代码
`--node`	以 Node.js/Playwright 执行代码 (默认)
`--bash`	以 Bash 执行代码
`--timeout <seconds>`	超时时间 (秒) (1-300，默认：30)
`--output <path>`	将输出保存到文件
`--json`	以 JSON 格式输出

Crawl#

从单个 URL 出发爬取整个网站。

CLI

# Start a crawl (returns job ID immediately)firecrawl crawl https://example.com# Wait for crawl to completefirecrawl crawl https://example.com --wait# 等待并显示进度指示器firecrawl crawl https://example.com --wait --progress

查看抓取状态#

CLI

# 使用作业 ID 检查爬取状态firecrawl crawl <job-id># 真实作业 ID 示例firecrawl crawl 550e8400-e29b-41d4-a716-446655440000

Crawl 选项#

CLI

# Limit crawl depth and pagesfirecrawl crawl https://example.com --limit 100 --max-depth 3 --wait# Include only specific pathsfirecrawl crawl https://example.com --include-paths /blog,/docs --wait# Exclude specific pathsfirecrawl crawl https://example.com --exclude-paths /admin,/login --wait# Include subdomainsfirecrawl crawl https://example.com --allow-subdomains --wait# Crawl entire domainfirecrawl crawl https://example.com --crawl-entire-domain --wait# Rate limitingfirecrawl crawl https://example.com --delay 1000 --max-concurrency 2 --wait# 将爬取选项传递给每个已爬取的页面firecrawl crawl https://example.com --scrape-options '{"formats":["markdown"],"onlyMainContent":true}'# 将爬取完成事件发送到 webhookfirecrawl crawl https://example.com --webhook '{"url":"https://example.com/webhook","events":["completed"]}'# 取消正在进行的爬取任务firecrawl crawl <job-id> --cancel# 自定义轮询间隔和超时时间firecrawl crawl https://example.com --wait --poll-interval 10 --timeout 300# Save results to filefirecrawl crawl https://example.com --wait --pretty -o results.json

可用选项：

选项	描述
`--url <url>`	要爬取的 URL (位置参数的替代方式)
`--wait`	等待爬取完成
`--progress`	等待期间显示进度指示器
`--poll-interval <seconds>`	轮询间隔 (默认：5 秒)
`--timeout <seconds>`	等待时的超时时长
`--status`	检查已有爬取任务的状态
`--limit <number>`	最大爬取页面数
`--max-depth <number>`	最大爬取深度
`--include-paths <paths>`	要包含的路径 (逗号分隔)
`--exclude-paths <paths>`	要排除的路径 (逗号分隔)
`--sitemap <mode>`	Sitemap 处理方式：`include`、`skip`、`only`
`--allow-subdomains`	包含子域名
`--allow-external-links`	跟随外部链接
`--crawl-entire-domain`	爬取整个域名
`--ignore-query-parameters`	将具有不同参数的 URL 视为相同
`--delay <ms>`	请求之间的延迟
`--max-concurrency <n>`	最大并发请求数
`--scrape-options <json>`	传递给每个页面的 JSON 抓取选项
`--scrape-options-file <path>`	抓取选项 JSON 文件路径
`--webhook <url-or-json>`	Webhook URL 或配置
`--cancel`	通过 job ID 取消活动中的爬取任务
`--output <path>`	将输出保存到文件
`--pretty`	以更易读的格式输出 JSON

监控#

创建周期性抓取或爬取任务，并将每次运行结果与上一次快照进行差异比对。当你希望 Firecrawl 判断哪些页面变化对你的用例真正有意义时，可添加目标。

CLI

firecrawl monitor create --name "Hacker News AI" \  --schedule "every 30 minutes" \  --goal "Alert when a new Hacker News story related to AI enters the top 10. Ignore changes to stories that are not about AI. Do not alert on changes outside the top 10." \  --page https://news.ycombinator.comfirecrawl monitor run <monitorId>firecrawl monitor checks <monitorId> --limit 10firecrawl monitor check <monitorId> <checkId> --page-status changedfirecrawl monitor update <monitorId> \  --goal "Alert when a new Hacker News story related to AI enters the top 10. Do not alert on changes outside the top 10."firecrawl monitor delete <monitorId>

监控目标应简短，并忠实反映用户意图：说明什么情况应触发告警，重述已说明的范围，并且仅在排除条件显而易见或被明确要求时才写出。如果用户要求“任何变化”，请保持目标宽泛。

可用选项：

Option	Description
`--name <name>`	监控名称
`--goal <goal>`	用于判断是否为有意义变更的目标
`--cron <expression>`	Cron 调度表达式，例如 `/30 * * *`
`--schedule <text>`	自然语言调度，例如 `hourly`
`--timezone <tz>`	调度时区，默认 `UTC`
`--page <url>`	每次检查时要抓取的单个页面 URL
`--scrape-urls <list>`	每次检查时要抓取的页面 URL，多个值以逗号分隔
`--crawl-url <url>`	爬取目标的根 URL
`--webhook-url <url>`	Webhook 接收地址
`--webhook-events <list>`	以逗号分隔的监控事件列表
`--email <list>`	以逗号分隔的电子邮件收件人
`--retention-days <n>`	快照保留时长
`--page-status <state>`	在 `monitor check` 时按状态筛选页面
`--state <state>`	在 `monitor update` 时设置监控状态：active/paused

Agent#

使用自然语言指令在网上搜索和获取数据。

CLI

# 基本用法 - URL 是可选的firecrawl agent "Find the top 5 AI startups and their funding amounts" --wait# 聚焦特定 URLfirecrawl agent "Compare pricing plans" --urls https://slack.com/pricing,https://teams.microsoft.com/pricing --wait# 使用 schema 实现结构化输出firecrawl agent "Get company information" --urls https://example.com --schema '{"type":"object","properties":{"name":{"type":"string"},"founded":{"type":"number"}}}' --wait# 从文件加载 schemafirecrawl agent "Get product details" --urls https://example.com --schema-file schema.json --wait

代理选项#

CLI

# Spark 2 为默认值 — 每次运行均使用该模型firecrawl agent "Competitive analysis across multiple domains" --model spark-2 --wait# 已弃用：仍接受 Spark 1 的模型名称，但会路由到 spark-2。# Set max credits to limit costsfirecrawl agent "Gather contact information from company websites" --max-credits 100 --wait# Check status of an existing jobfirecrawl agent <job-id> --status# 将代理事件发送到 webhookfirecrawl agent "Extract product details" --urls https://example.com --webhook '{"url":"https://example.com/webhook","events":["completed","failed"]}'# 取消活跃的代理任务firecrawl agent <job-id> --cancel# Custom polling interval and timeoutfirecrawl agent "Summarize recent blog posts" --wait --poll-interval 10 --timeout 300# Save output to filefirecrawl agent "Find pricing information" --urls https://example.com --wait -o pricing.json --pretty

可用选项：

选项	说明
`--urls <urls>`	可选的 URL 列表，用于限定代理的处理范围 (用逗号分隔)
`--model <model>`	要使用的模型。默认值为 `spark-2`，所有运行均使用该模型。Spark 1 模型已弃用，并会路由到 `spark-2`
`--schema <json>`	用于结构化输出的 JSON schema (内联 JSON 字符串)
`--schema-file <path>`	用于结构化输出的 JSON schema 文件路径
`--max-credits <number>`	最多可消耗的额度 (达到上限时任务失败)
`--webhook <url-or-json>`	Webhook URL 或配置
`--status`	检查已有代理任务的状态
`--cancel`	通过任务 ID 取消正在运行的代理任务
`--wait`	等待代理任务完成后再返回结果
`--poll-interval <seconds>`	等待时的轮询间隔 (默认：5)
`--timeout <seconds>`	等待时的超时时间 (默认：无限制)
`--output <path>`	将输出保存到文件
`--json`	以 JSON 格式输出

额度使用情况#

查看你团队的额度余额和使用明细。

CLI

# View credit usagefirecrawl credit-usage# 以 JSON 格式输出firecrawl credit-usage --json --pretty

Version#

显示 CLI 的版本。

CLI

firecrawl version# 或firecrawl --version

全局选项#

以下选项适用于所有命令：

选项	简写	说明
`--status`		显示版本、认证状态、并发数和额度
`--api-key <key>`	`-k`	在此命令中临时覆盖已保存的 API 密钥
`--api-url <url>`		使用自定义 API URL (用于自托管/本地开发)
`--help`	`-h`	显示命令帮助信息
`--version`	`-V`	显示 CLI 版本

init 还接受 --skip-auth、--skip-install、--skip-skills 和 --agent <name>。请参见 firecrawl init --help。

输出处理#

CLI 默认将结果输出到 stdout，便于通过管道或重定向进行处理：

CLI

# 将 Markdown 通过管道传递给另一个命令firecrawl https://example.com | head -50# 重定向到文件firecrawl https://example.com > output.md# 保存格式化后的 JSONfirecrawl https://example.com --format markdown,links --pretty -o data.json

formats 的行为#

单一 format：输出原始内容 (markdown 文本、HTML 等)
多个 formats：输出包含所有请求数据的 JSON

CLI

# 原始 markdown 输出firecrawl https://example.com --format markdown# 使用多个 formats 的 JSON 输出firecrawl https://example.com --format markdown,links

示例#

快速抓取#

CLI

# 从 URL 获取 Markdown 内容(使用 --only-main-content 获取简洁输出)firecrawl https://docs.firecrawl.dev --only-main-content# Get HTML contentfirecrawl https://example.com --html -o page.html

整站爬取#

CLI

# 爬取文档站点并设置限制firecrawl crawl https://docs.example.com --limit 50 --max-depth 2 --wait --progress -o docs.json

站点发现#

CLI

# 查找所有博客文章firecrawl map https://example.com --search "blog" -o blog-urls.txt

研究工作流#

CLI

# 搜索并抓取结果用于研究firecrawl search "machine learning best practices 2024" --scrape --scrape-formats markdown --pretty

智能体#

CLI

# URL 可选firecrawl agent "Find the top 5 AI startups and their funding amounts" --wait# 针对特定 URLfirecrawl agent "Compare pricing plans" --urls https://slack.com/pricing,https://teams.microsoft.com/pricing --wait

与其他工具结合使用#

CLI

# Extract URLs from search resultsjq -r '.data.web[].url' search-results.json# Get titles from search resultsjq -r '.data.web[] | "\(.title): \(.url)"' search-results.json# 以 JSON 形式提取链接，并逐行打印 URLfirecrawl https://example.com --format links --json | jq -r '.links[]'# Count URLs from mapfirecrawl map https://example.com | wc -l

遥测#

CLI 在身份验证过程中会收集匿名使用数据，以帮助改进产品：

CLI 版本、操作系统和 Node.js 版本
检测到的开发工具 (例如 Cursor、VS Code、Claude Code)

CLI 不会收集任何命令数据、URL 或文件内容。

如需禁用遥测，请设置以下环境变量：

CLI

export FIRECRAWL_NO_TELEMETRY=1

开源#

Firecrawl CLI 和全部三个技能分段都已开源，并可在 GitHub 上获取：

firecrawl/cli — CLI 和 CLI 技能 (实时网页工作)
firecrawl/skills — 构建技能 (将 Firecrawl 集成到应用程序代码中)
firecrawl/firecrawl-workflows — 工作流技能 (可重复生成的交付成果，例如研究简报、SEO 审计、潜在客户列表和设计克隆)

你是需要 Firecrawl API 密钥的 AI 代理吗？请参见 firecrawl.dev/agent-onboarding/SKILL.md 获取自动化入门说明。

安装#

身份验证#

登录#

查看配置#

退出登录#

将 CLI 连接到自托管的 Firecrawl#

检查状态#

命令#

Scrape#

输出 formats 类型#

抓取选项#

搜索#

搜索选项#

开发者#

Map#

Map 命令选项#

交互#

Crawl#

查看抓取状态#

Crawl 选项#

监控#

Agent#

代理 选项#

额度使用情况#

Version#

全局选项#

输出处理#

formats 的行为#

示例#

快速抓取#

整站爬取#

站点发现#

研究工作流#

智能体#

与其他工具结合使用#

遥测#

开源#

代理选项#