跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt

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

如果你在使用 AI 开发，Firecrawl 提供了多种资源来提升你的开发体验。Firecrawl 内置了 技能——可独立使用的知识包，AI 编码代理会自动发现并使用它们。只需一条安装命令，代理即可获得用于实时网页操作的 CLI 工具，以及将 Firecrawl 集成到应用代码中的相关技能。Claude Code、Cursor、Antigravity 和 OpenCode 等代理只需一条命令即可自行完成接入——有了 API 密钥后，无需人工额外配置。

​
前提条件：创建 API 密钥

目前，Firecrawl 账户需要由人工手动创建。创建好账户后，你需要创建 API 密钥。有了 API 密钥后，你的代理就能处理其余事项——安装技能、完成 CLI 身份验证、配置 MCP，并代表你发起调用。

获取 API 密钥

注册并获取 API 密钥，开始使用 Firecrawl。

​
Skill + CLI

Firecrawl CLI 让你的代理能够通过终端搜索、抓取、爬取、提取，并控制浏览器。它专为人类用户、AI 代理和 CI/CD 流水线打造。 Firecrawl 技能是一个自包含的知识包，Claude Code、Antigravity 和 OpenCode 等 AI 编码代理会自动发现并使用它。只需一条安装命令即可完成全部设置——既包括用于实时网页操作的 CLI 工具，也包括用于将 Firecrawl 集成到应用代码中的构建技能： 
npx -y firecrawl-cli@latest init --all --browser
  • --all 会将 Firecrawl 技能安装到此设备上检测到的每个 AI 编程代理
  • --browser 会打开浏览器，以便用户登录或创建账户
安装后，请确认一切运行正常： 
firecrawl --status
firecrawl scrape "https://firecrawl.dev"

​
安装后会提供什么

安装会配置两类技能，覆盖代理使用 Firecrawl 的全部方式： CLI 技能 — 用于代理会话期间进行实时网页操作：
技能Purpose
firecrawl/cli整体 CLI 命令工作流
firecrawl-search进行网页搜索并发现页面
firecrawl-scrape从已知 URL 提取干净内容
firecrawl-interact操作实时页面——点击、填写表单、登录
firecrawl-crawl从整个网站批量提取内容
firecrawl-map发现域名下的所有 URL
构建技能 — 用于将 Firecrawl 集成到应用代码中：
技能Purpose
firecrawl-build为你的产品选择合适的 Firecrawl 端点
firecrawl-build-onboarding身份验证和项目设置
firecrawl-build-scrape在应用代码中实现抓取
firecrawl-build-search在应用代码中实现搜索
firecrawl-build-interact在应用代码中实现浏览器交互
firecrawl-build-crawl在应用代码中实现爬取
firecrawl-build-map在应用代码中实现 URL 发现

​
选择你的路径

两类技能的安装方式相同。区别在于后续的使用场景：
1

实时网页工具（CLI 技能）

当你需要在当前会话中使用网页数据时，请选择这个——例如进行网页搜索、抓取已知 URL、与实时页面交互、爬取文档，或映射整个站点。默认流程：
  1. 需要先发现内容时，从 search 开始
  2. 已有 URL 时，切换到 scrape
  3. 只有在页面需要点击、填写表单或登录时，才使用 interact
# 进行网页搜索
firecrawl search "best open-source web crawlers"

# 将网页抓取为干净的 markdown
firecrawl scrape https://docs.firecrawl.dev

# 爬取整个站点
firecrawl crawl https://docs.firecrawl.dev
2

应用集成（构建技能）

当你在构建应用、代理或工作流，并需要通过代码调用 Firecrawl API 时，请选择这个。构建技能可帮助你选择合适的端点、接入 SDK，并运行一次冒烟测试。代理会回答一个关键问题——Firecrawl 应该在产品中执行什么任务？——然后构建技能会据此路由到 /search、/scrape、/interact、/crawl 或 /map。
3

REST API（无需安装）

如果你不想安装任何内容，代理也可以直接调用 Firecrawl REST API。设置 API 密钥后，直接调用这些端点：
  • POST https://api.firecrawl.dev/v2/search — 按查询发现页面
  • POST https://api.firecrawl.dev/v2/scrape — 从 URL 提取干净的 markdown
  • POST https://api.firecrawl.dev/v2/interact — 在实时页面上执行 browser actions
认证请求头：Authorization: Bearer fc-YOUR_API_KEY
完整的技能定义见 firecrawl.dev/agent-onboarding/SKILL.md——代理可直接获取它以完成自助 onboarding。

技能 + CLI

安装 CLI 和技能，完成身份验证后，即可在终端运行 scrape、search、crawl、extract 和浏览器命令。

​
将 Firecrawl 作为工具使用

Firecrawl 为代理提供了 5 个处理网页的核心工具。每个工具都对应一个 API 端点和一条 CLI 命令。代理会根据需求选择合适的工具：
如果你还没有 URL，就从这里开始。搜索会根据自然语言查询返回相关网页，并可选择在结果中附带完整页面内容。
# CLI
firecrawl search "latest OpenAI API pricing"

# REST API
curl -X POST https://api.firecrawl.dev/v2/search \
  -H "Authorization: Bearer fc-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "latest OpenAI API pricing"}'
适用场景： 研究任务、查找文档、竞品分析、回答需要最新网页信息的问题。
如果你已经有 URL，并且需要干净、适合 LLM 使用的内容，就用这个工具。抓取 可以将任意网页转换为 markdown、HTML 或结构化数据，并自动处理 JavaScript 渲染、反爬措施以及杂乱的 HTML。
# CLI
firecrawl scrape https://docs.stripe.com/api/charges

# REST API
curl -X POST https://api.firecrawl.dev/v2/scrape \
  -H "Authorization: Bearer fc-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://docs.stripe.com/api/charges"}'
适用场景： 阅读文档、提取文章内容、从已知页面抓取数据、将网页转换为供 LLM 使用的上下文。
爬取 会从起始 URL 递归跟踪链接，并抓取发现的每一个页面。当你需要整个站点或整套文档的内容，而不只是单个页面时，就用它。
# CLI
firecrawl crawl https://docs.firecrawl.dev --limit 50

# REST API
curl -X POST https://api.firecrawl.dev/v2/crawl \
  -H "Authorization: Bearer fc-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://docs.firecrawl.dev", "limit": 50}'
适用场景： 导入完整文档站点、构建知识库、迁移内容、收集训练数据。
Map 可以在不抓取内容的情况下，快速找出某个域名下所有已索引的 URL。如果你需要先了解站点结构，或在抓取前定位特定页面，就用它。
# CLI
firecrawl map https://docs.firecrawl.dev

# REST API
curl -X POST https://api.firecrawl.dev/v2/map \
  -H "Authorization: Bearer fc-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://docs.firecrawl.dev"}'
适用场景： 站点审计、在大型站点中查找特定页面、在定向爬取前了解站点结构。
交互 让代理能够控制远程浏览器会话。当页面需要点击、填写表单、登录，或执行任何超出被动读取范围的操作时，就用它。
# CLI
firecrawl interact https://example.com --instruction "Click the login button, fill in the email field"

# REST API
curl -X POST https://api.firecrawl.dev/v2/interact \
  -H "Authorization: Bearer fc-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "instruction": "Click the login button"}'
适用场景： 需要登录后访问的页面、填写表单、处理多步骤流程、与动态 SPA 交互。

​
代理如何串联使用工具

大多数代理工作流都会结合使用多个工具。典型模式如下：
  1. 搜索 以查找相关页面 → 获取 URL 列表
  2. 抓取 最相关的 URL → 获取清洗后的内容
  3. 仅在页面需要点击或登录时才 交互 → 处理动态内容
对于批量任务，代理通常会先使用 Map 发现 URL，然后再对所需页面执行 爬取 或有选择地 抓取。

​
Firecrawl MCP Server

MCP 是一种开放协议，规范了应用如何向 LLM 提供上下文。除此之外，它还为 LLM 提供了可代表你执行操作的工具。我们的 MCP server 是开源的，覆盖了完整的 API 能力——search、scrape、爬取、map、extract、agent 和 browser sessions。 使用远程托管 URL： 
https://mcp.firecrawl.dev/{FIRECRAWL_API_KEY}/v2/mcp
或者将本地服务器添加到任意 MCP 客户端： 
{
  "mcpServers": {
    "firecrawl": {
      "command": "npx",
      "args": ["-y", "firecrawl-mcp"],
      "env": {
        "FIRECRAWL_API_KEY": "fc-YOUR-API-KEY"
      }
    }
  }
}

MCP Server

查看 Cursor、Claude Desktop、Windsurf、VS Code 等平台的安装说明。

​
面向代理的 Firecrawl 文档

你可以用结合上下文的方式，向你的代理提供最新的 Firecrawl 文档。代理可以直接拉取这些资源，自行完成接入——无需人工手动配置。
1

Markdown 文档

每个页面都有对应的 markdown 版本。只需在任意文档 URL 后追加 .md，或使用页面操作菜单将页面复制为 markdown。
Docs for this page: https://docs.firecrawl.dev/ai-onboarding.md
2

完整 llms.txt

将我们的全部文档以单个文件的形式提供给你的代理。
Here are the Firecrawl docs: https://docs.firecrawl.dev/llms-full.txt
也可使用更短的索引：https://docs.firecrawl.dev/llms.txt。
3

MCP 文档服务器

如果你想通过 MCP 工具以结构化方式接入，请在任意 MCP 客户端 (Cursor、Claude Code、Claude Desktop、Windsurf) 中连接 Firecrawl MCP 服务器。请参见 MCP Server 页面获取安装命令。
4

复制到 ChatGPT / Claude

每个页面都包含一个与上下文相关的操作菜单 (复制、以 markdown 查看、在 ChatGPT 中打开、在 Claude 中打开) ，让代理和用户都能一键在不同工具之间传递页面。

​
快速开始指南

为代理最常使用的技术栈提供可直接上手的快速开始指南。让代理使用其中任意一个，即可端到端快速搭建可运行的 Firecrawl 集成。 更想交给 Cursor 处理？一键安装 Firecrawl MCP 服务器，然后在 Cursor 中开始编写 prompt： 在 Cursor 中打开——添加 Firecrawl MCP 服务器

Node.js

借助 Firecrawl Node SDK 进行服务端 JavaScript 和 TypeScript 开发。

Next.js

在 Next.js 路由处理程序和 Server Actions 中进行抓取、搜索和爬取。

Python

在脚本、Notebook 和后端服务中使用 Firecrawl。

FastAPI

构建可进行搜索、抓取和提取的异步 Python API。

Cloudflare Workers

通过 Workers 在边缘运行 Firecrawl。

Vercel Functions

从 Vercel 无服务器函数中调用 Firecrawl。

AWS Lambda

从 Lambda 处理程序中调用 Firecrawl。

Supabase Edge Functions

在 Supabase Deno 运行时中使用 Firecrawl。

Go

用于搜索、抓取和爬取的惯用 Go SDK。

Rust

适用于 Firecrawl 的强类型 Rust SDK。

Laravel

通过 PHP SDK 将 Firecrawl 集成到 Laravel 应用中。

Rails

轻松将 Firecrawl 接入 Ruby on Rails。
请参见左侧边栏中的完整快速开始列表 (Express、NestJS、Fastify、Hono、Bun、Remix、Nuxt、SvelteKit、Astro、Mastra、Django、Flask、Elixir、Java、Spring Boot、.NET、ASP.NET Core 等) 。

​
代理接入

Firecrawl 可与代理实际所处的运行时和框架配合使用——包括代码代理、浏览器代理、代理 SDK 以及模型聚合器。大多数代码代理集成都可以通过 npx -y firecrawl-cli@latest init --all 自动发现 Firecrawl 技能；其余则通过 MCP 或 REST API 将 Firecrawl 作为工具调用。

OpenClaw

用于代理式浏览器控制的开放规范，支持沙箱会话。

Claude Code

Anthropic 的 CLI——在 Claude Code 中设置 Firecrawl MCP。

Cursor

IDE 代理——一键在 Cursor 中安装 Firecrawl MCP。

OpenCode

将 Firecrawl MCP 接入 OpenCode。

Codex CLI

将 Firecrawl MCP 接入 OpenAI Codex CLI。

OpenRouter

让任意 OpenRouter 模型搭配 Firecrawl 网页工具使用。

Amp

将 Firecrawl MCP 接入 Sourcegraph Amp。

Windsurf

代理式 IDE——在 Windsurf 中设置 Firecrawl MCP。

Antigravity

为 Google 的代理式 IDE 添加 Firecrawl MCP。

Gemini CLI

将 Firecrawl MCP 接入 Google Gemini CLI。

Nous Research

将 Firecrawl 作为工具与 Hermes 模型配合使用。

AutoGen

在 Microsoft AutoGen 多代理团队中接入 Firecrawl 工具。

​
SDKs

官方类型化 SDK，覆盖完整的 Firecrawl API。为你的代理选择与你技术栈相匹配的语言 SDK。

Python

Node

Go

Java

Ruby

Rust

.NET

PHP

Elixir

CLI

Firecrawl 还为主流 LLM SDK 和代理框架提供了原生 SDK 绑定——请参见 LLM SDKs and Frameworks，了解 OpenAI、Anthropic、Gemini、Google ADK、Vercel AI SDK、LangChain、LangGraph、LlamaIndex、Mastra 和 ElevenAgents。