mcpField
F
firecrawl-build-onboarding

firecrawl-build-onboarding

github.com/firecrawl开发13961.5k 次安装6 天前更新
代码仓库

关于 firecrawl-build-onboarding

用于将 Firecrawl 集成到应用的入门技能，涵盖获取 API 密钥、选择 SDK 或 REST 接入方式，以及测试请求。它适用于新项目和现有项目，并链接到配置与端点专项参考。

主要功能

  1. 01API 密钥配置指引
  2. 02浏览器授权与 Stripe Projects 密钥路径
  3. 03选择 SDK 或 REST 接入方式
  4. 04新项目和现有项目的配置步骤
  5. 05冒烟测试指引

适用场景

  1. 01首次在项目中接入 Firecrawl
  2. 02将凭据保存到 `.env`
  3. 03选择 SDK 或 REST 集成方式
  4. 04配置后验证 Firecrawl 请求

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/firecrawl/skills --skill firecrawl-build-onboarding

安装后在 Claude Code 中输入/firecrawl-build-onboarding确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
auth-flow.md
project-setup.md
sdk-installation.md

详细介绍

Firecrawl 构建接入引导

在 Firecrawl 引导流程中，应用集成路径请使用此技能。

安装

如果尚未安装，只需运行一条命令，即可设置 CLI 工具 （用于实时网页操作）和构建技能（用于应用集成）：

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

此命令会一并安装 Firecrawl CLI、CLI 技能和这些构建技能。它还会打开浏览器认证页面，以便用户登录或创建账户。无需单独运行 npx skills add。

适用场景

  • 项目需要 FIRECRAWL_API_KEY
  • 用户希望将 Firecrawl 接入 .env
  • 首次在应用中添加 Firecrawl
  • 需要选择首个 SDK 或 REST 接入路径

如果用户仍需注册、登录或在浏览器中授权访问，请使用此技能中的认证流程参考。

如果项目已经使用 Stripe Projects（存在 .projects/ 目录，或 stripe projects status 命令运行成功），则可以从那里获取密钥，无需使用浏览器流程：

stripe projects add firecrawl/api --name firecrawl
stripe projects env --pull

--name firecrawl 会将密钥写入 FIRECRAWL_API_KEY；如果不加此参数，CLI 会写入 FIRECRAWL_API_API_KEY，SDK 不会读取该变量。忽略 CLI 同时写入的 FIRECRAWL_API_BASE_URL：SDK 读取的是 FIRECRAWL_API_URL，且仅用于自托管部署，因此使用托管账户时应保持未设置。是否升级付费方案由用户自行决定，因为 stripe projects upgrade firecrawl 会向其信用卡扣费。文档页面包含目录和故障排除信息。

快速开始

如果用户已有 API 密钥，请将其放入 .env：

FIRECRAWL_API_KEY=fc-...

如果项目是自托管的，还需设置：

FIRECRAWL_API_URL=https://your-firecrawl-instance.example.com

然后确定适用的集成路径：

  • 全新项目 -> 选择目标技术栈、安装 SDK、添加首个 Firecrawl 调用，并运行冒烟测试
  • 现有项目 -> 先检查代码库，再根据项目现有的第三方 API 和环境变量处理方式集成 Firecrawl

你需要做什么？

任务参考资料
运行浏览器认证流程并保存 FIRECRAWL_API_KEYreferences/auth-flow.md
通过 Stripe Projects 配置密钥docs.firecrawl.dev/integrations/stripe-projects
安装合适的 SDKreferences/sdk-installation.md
将凭据写入 .env 或项目配置references/project-setup.md
设置完成后选择合适的端点firecrawl-build
此任务需要实时网页工具已通过同一条命令安装 CLI 技能
从已知 URL 开始实现firecrawl-build-scrape
从查询开始实现firecrawl-build-search

文档（权威来源）

请阅读与你的项目语言对应的权威来源页面，了解 SDK 用法、架构和示例：

设置完成后

密钥就位后：

  1. 判断这是一个新项目还是现有代码库
  2. 询问 Firecrawl 在产品中需要实现什么功能
  3. 选择与该行为匹配的最精简端点
  4. 编写代码前，阅读该项目语言的事实来源页面
  5. 在代码中添加 SDK 或 REST 调用
  6. 运行冒烟测试，确认至少一次真实的 Firecrawl 请求成功
  7. 参考此仓库中针对各端点的技能获取实现指导
  8. 如果当前任务还需要实时网页工具，CLI 技能已安装，可使用 firecrawl/cli

评论

支持 Markdown