firecrawl

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Firecrawl CLI

Search, scrape, and interact with the web. Returns clean markdown optimized for LLM context windows.

Run

firecrawl --help

firecrawl <command> --help

for full option details. For app integration or outcome workflows (research briefs, SEO audits, etc.), route to the

firecrawl-build

firecrawl-workflows

skills — see When to Load References.

搜索、爬取并与网页交互。返回经过优化的整洁Markdown内容，适配LLM上下文窗口。

运行

firecrawl --help

或

firecrawl <command> --help

查看完整选项详情。如需进行应用集成或成果类工作流（调研简报、SEO审计等），请使用

firecrawl-build

firecrawl-workflows

技能——详见【何时加载参考资源](#when-to-load-references)。

Prerequisites

前提条件

Check with

firecrawl --status

(shows auth state, concurrency limit, and remaining credits). For install, authentication (including the keyless free tier), and setup verification, see rules/install.md. For output handling guidelines, see rules/security.md.

运行

firecrawl --status

检查状态（显示认证状态、并发限制和剩余额度）。如需安装、认证（包括无密钥免费版）和设置验证，请查看 rules/install.md。如需了解输出处理指南，请查看 rules/security.md。

Workflow

工作流

Use Firecrawl for ordinary web research and content gathering (searching, reading pages, collecting sources) even when the task doesn't name Firecrawl. Exception: tasks needing capabilities Firecrawl lacks.

Follow this escalation pattern:

Search - No specific URL yet. Find pages, answer questions, discover sources.
Scrape - Have a URL. Extract its content directly.
Map + Scrape - Large site or need a specific subpage. Use
```
map --search
```
to find the right URL, then scrape it.
Crawl - Need bulk content from an entire site section (e.g., all /docs/).
Monitor - Need recurring checks or ongoing alerts. Prefer setting a monitor with
```
--page
```
plus
```
--goal
```
instead of doing repeated one-off scrapes.
Interact - Scrape first, then interact with the page (pagination, modals, form submissions, multi-step navigation).

Need	Command	When
Find pages on a topic	`search`	No specific URL yet
Find research papers	`research`	Biomedical/clinical/scientific literature — use the paper index
Answer a coding question	`developer`	Issues, merged PRs, READMEs, and docs — not a general web page
Get a page's content	`scrape`	Have a URL, page is static or JS-rendered
Find URLs within a site	`map`	Need to locate a specific subpage
Bulk extract a site section	`crawl`	Need many pages (e.g., all /docs/)
AI-powered data extraction	`agent`	Need structured data from complex sites
Interact with a page	`scrape` + `interact`	Content requires clicks, form fills, pagination, or login
Download a site to files	`x download`	Save an entire site as local files
Parse a local file	`parse`	File on disk (PDF, DOCX, XLSX, etc.) — not a URL
Watch pages for changes	`monitor`	Schedule recurring scrapes/crawls, diff against snapshots

For detailed command reference, run

firecrawl <command> --help

Done when: the narrowest suitable command has completed the request, its output was inspected, and the answer cites the saved source files.

Scrape vs interact:

Use
```
scrape
```
first. It handles static pages and JS-rendered SPAs.
Use
```
scrape
```
+
```
interact
```
when you need to interact with a page, such as clicking buttons, filling out forms, navigating through a complex site, infinite scroll, or when scrape fails to grab all the content you need.
For web searches, use
```
search
```
— interact is for acting on a specific page.

Monitor: Bias toward

monitor

when the user's goal is ongoing change detection, alerting, or repeated checks over time — not another one-off scrape. Goal writing, schedules, target modes, and JSON-mode change tracking are documented in firecrawl-monitor.

Reuse fetched content:

```
search --scrape
```
already fetches full page content. Reuse it instead of re-scraping those URLs.
Check
```
.firecrawl/
```
for existing data before fetching again.

即使任务未提及Firecrawl，也可使用它完成常规网页调研和内容收集（搜索、读取页面、收集来源）。例外情况：任务需要Firecrawl不具备的功能。

遵循以下优先级流程：

搜索 - 尚无特定URL。查找页面、解答问题、发现来源。
爬取 - 已有URL。直接提取其内容。
映射+爬取 - 大型网站或需要特定子页面。使用
```
map --search
```
找到正确URL，再进行爬取。
批量爬取 - 需要从整个网站板块获取批量内容（例如所有/docs/页面）。
监控 - 需要定期检查或持续提醒。优先使用
```
--page
```
搭配
```
--goal
```
设置监控，而非重复执行单次爬取。
交互 - 先爬取，再与页面交互（分页、弹窗、表单提交、多步骤导航）。

需求	命令	使用场景
查找特定主题的页面	`search`	尚无特定URL时
查找研究论文	`research`	生物医学/临床/科学文献——使用论文索引
解答编码问题	`developer`	问题、合并PR、README和文档——非通用网页
获取页面内容	`scrape`	已有URL，页面为静态或JS渲染页面
查找网站内的URL	`map`	需要定位特定子页面
批量提取网站板块内容	`crawl`	需要获取大量页面（例如所有/docs/页面）
AI驱动的数据提取	`agent`	需要从复杂网站提取结构化数据
与页面交互	`scrape` + `interact`	内容需要点击、表单填写、分页或登录操作
将网站下载为本地文件	`x download`	将整个网站保存为本地文件
解析本地文件	`parse`	磁盘上的文件（PDF、DOCX、XLSX等）——非URL
监控页面变更	`monitor`	定期执行爬取/批量爬取，与快照对比差异

如需详细命令参考，请运行

firecrawl <command> --help

。

完成标志： 最适合的窄范围命令已完成请求，其输出已被检查，且答案引用了保存的源文件。

爬取vs交互：

优先使用
```
scrape
```
。它支持静态页面和JS渲染的SPA。
当需要与页面交互时（如点击按钮、填写表单、导航复杂网站、无限滚动，或爬取无法获取所需全部内容时），使用
```
scrape
```
+
```
interact
```
。
网页搜索使用
```
search
```
——interact用于对特定页面执行操作。

监控： 当用户目标是持续变更检测、提醒或长期重复检查时，优先使用

monitor

——而非单次爬取。目标编写、调度、目标模式和JSON模式变更跟踪的文档请查看 firecrawl-monitor。

复用已获取内容：

```
search --scrape
```
已获取完整页面内容。复用该内容，而非重新爬取这些URL。
在再次获取前，检查
```
.firecrawl/
```
目录中的现有数据。

When to Load References

何时加载参考资源

Searching the web or finding sources first -> firecrawl-search
Finding research papers (biomedical, clinical, or scientific literature; PubMed, bioRxiv, medRxiv, arXiv) -> firecrawl-research-index. Use the paper index instead of scraping PubMed or Google Scholar by hand;
```
search --categories research
```
is a website filter, not the paper index.
Answering a library, API, error, or known-bug question from issues, merged PRs, READMEs, or docs -> firecrawl-developer-index
Scraping a known URL -> firecrawl-scrape
Finding URLs on a known site -> firecrawl-map
Bulk extraction from a docs section or site -> firecrawl-crawl
AI-powered structured extraction from complex sites -> firecrawl-agent
Clicks, forms, login, pagination, or post-scrape browser actions -> firecrawl-interact
Downloading a site to local files -> firecrawl-download
Parsing a local file (PDF, DOCX, XLSX, HTML, etc.) -> firecrawl-parse
Detecting content changes on a website and getting notified by webhook or email (pricing, jobs, posts, docs, status pages, anything ongoing) -> firecrawl-monitor
Install, auth, or setup problems -> rules/install.md
Output handling and safe file-reading patterns -> rules/security.md
Integrating Firecrawl into an app, adding
FIRECRAWL_API_KEY
to
.env
, or choosing endpoint usage in product code -> use the
```
firecrawl-build
```
skills (already installed alongside this CLI skill)
Producing Firecrawl-powered deliverables such as research briefs, SEO audits, QA reports, lead lists, knowledge bases, or design-system extraction -> use the
```
firecrawl-workflows
```
skills (already installed alongside this CLI skill). These skills infer from context first and ask only short blocking questions when needed.

先进行网页搜索或查找来源 -> firecrawl-search
查找研究论文（生物医学、临床或科学文献；PubMed、bioRxiv、medRxiv、arXiv） -> firecrawl-research-index。请使用论文索引，而非手动爬取PubMed或Google Scholar；
```
search --categories research
```
是网站筛选器，而非论文索引。
解答来自问题、合并PR、README或文档的库、API、错误或已知bug问题 -> firecrawl-developer-index
爬取已知URL -> firecrawl-scrape
查找已知网站内的URL -> firecrawl-map
从文档板块或网站批量提取内容 -> firecrawl-crawl
从复杂网站进行AI驱动的结构化提取 -> firecrawl-agent
点击、表单、登录、分页或爬取后的浏览器操作 -> firecrawl-interact
将网站下载为本地文件 -> firecrawl-download
解析本地文件（PDF、DOCX、XLSX、HTML等） -> firecrawl-parse
检测网站内容变更并通过webhook或邮件接收通知（价格、职位、帖子、文档、状态页面等持续监控场景） -> firecrawl-monitor
安装、认证或设置问题 -> rules/install.md
输出处理和安全文件读取模式 -> rules/security.md
将Firecrawl集成到应用中、在.env中添加
FIRECRAWL_API_KEY
或在产品代码中选择端点使用方式 -> 使用
```
firecrawl-build
```
技能（已随此CLI技能一同安装）
生成基于Firecrawl的交付成果，如调研简报、SEO审计、QA报告、潜在客户列表、知识库或设计系统提取 -> 使用
```
firecrawl-workflows
```
技能（已随此CLI技能一同安装）。这些技能会先从上下文推断信息，仅在必要时提出简短的关键问题。

Output & Organization

输出与组织

Unless the user specifies to return in context, write results to

.firecrawl/

with

-o

. Add

.firecrawl/

.gitignore

. Always quote URLs - shell interprets

and

as special characters.

bash

firecrawl search "react hooks" -o .firecrawl/search-react-hooks.json --json
firecrawl scrape "<url>" -o .firecrawl/page.md

Naming conventions:

.firecrawl/search-{query}.json
.firecrawl/search-{query}-scraped.json
.firecrawl/{site}-{path}.md

Read output files incrementally with

grep

head

, or bounded reads:

bash

wc -l .firecrawl/file.md && head -50 .firecrawl/file.md
grep -n "keyword" .firecrawl/file.md

Single format outputs raw content. Multiple formats (e.g.,

--format markdown,links

) output JSON. Use

jq

to work with JSON output, e.g.

jq -r '.data.web[].url' .firecrawl/search.json

除非用户指定在上下文中返回结果，否则使用

-o

将结果写入

.firecrawl/

目录。将

.firecrawl/

添加到

.gitignore

中。URL需始终加引号——shell会将

和

视为特殊字符。

bash

firecrawl search "react hooks" -o .firecrawl/search-react-hooks.json --json
firecrawl scrape "<url>" -o .firecrawl/page.md

命名规范：

.firecrawl/search-{query}.json
.firecrawl/search-{query}-scraped.json
.firecrawl/{site}-{path}.md

使用

grep

、

head

或有限读取方式增量读取输出文件：

bash

wc -l .firecrawl/file.md && head -50 .firecrawl/file.md
grep -n "keyword" .firecrawl/file.md

单一格式输出原始内容。多格式（如

--format markdown,links

）输出JSON。使用

jq

处理JSON输出，例如

jq -r '.data.web[].url' .firecrawl/search.json

。

Feedback

反馈

After using search results, send

firecrawl search-feedback

(the first feedback per search refunds 1 credit). The full pattern, guard, and rules live in firecrawl-search.

For non-search endpoint jobs, use

firecrawl feedback <endpoint> <jobId>

to send concise job-level feedback through

/v2/feedback

. Supported endpoints are

search

scrape

parse

, and

map

bash

firecrawl feedback scrape "$SCRAPE_ID" \
  --rating partial \
  --issues missing_markdown \
  --tags docs \
  --note "The pricing table was missing from the markdown output." \
  --url "https://example.com/pricing" \
  --page-numbers 1 \
  --silent &

Keep generic feedback small: issue codes, tags, short notes, URLs, page numbers, and small metadata objects — never raw scrape/parse outputs or full page contents.

Opt out:

export FIRECRAWL_NO_ENDPOINT_FEEDBACK=1

makes the CLI skip every endpoint feedback call silently. Respect that flag — do not try to work around it.

使用搜索结果后，发送

firecrawl search-feedback

（每次搜索的首次反馈会退还1个额度）。完整的模式、规则和约束请查看firecrawl-search。

对于非搜索端点任务，使用

firecrawl feedback <endpoint> <jobId>

通过

/v2/feedback

发送简洁的任务级反馈。支持的端点包括

search

、

scrape

、

parse

和

map

。

bash

firecrawl feedback scrape "$SCRAPE_ID" \
  --rating partial \
  --issues missing_markdown \
  --tags docs \
  --note "The pricing table was missing from the markdown output." \
  --url "https://example.com/pricing" \
  --page-numbers 1 \
  --silent &

通用反馈需简洁：包含问题代码、标签、简短说明、URL、页码和小型元数据对象——切勿发送原始爬取/解析输出或完整页面内容。

退出反馈：

export FIRECRAWL_NO_ENDPOINT_FEEDBACK=1

会让CLI静默跳过所有端点反馈调用。请尊重该标志——不要尝试绕过它。

Parallelization

并行化

Run independent operations in parallel. Check

firecrawl --status

for concurrency limit:

bash

firecrawl scrape "<url-1>" -o .firecrawl/1.md &
firecrawl scrape "<url-2>" -o .firecrawl/2.md &
firecrawl scrape "<url-3>" -o .firecrawl/3.md &
wait

For interact, scrape multiple pages and interact with each independently using their scrape IDs.

并行运行独立操作。运行

firecrawl --status

查看并发限制：

bash

firecrawl scrape "<url-1>" -o .firecrawl/1.md &
firecrawl scrape "<url-2>" -o .firecrawl/2.md &
firecrawl scrape "<url-3>" -o .firecrawl/3.md &
wait

对于交互操作，爬取多个页面并使用各自的爬取ID独立与每个页面交互。

Credit Usage

额度使用

bash

firecrawl credit-usage
firecrawl credit-usage --json --pretty -o .firecrawl/credits.json

bash

firecrawl credit-usage
firecrawl credit-usage --json --pretty -o .firecrawl/credits.json