firecrawl-build-onboarding

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Firecrawl Build Onboarding

Firecrawl 构建上手指南

Use this skill for the application-integration path from Firecrawl's onboarding flow.
本技能适用于Firecrawl上手指南中的应用集成路径。

Use This When

适用场景

  • a project needs
    FIRECRAWL_API_KEY
  • the user wants Firecrawl wired into
    .env
  • you are adding Firecrawl to an app for the first time
  • you need to choose the first SDK or REST path
If the human still needs to sign up, sign in, or authorize access in the browser, use the auth flow reference in this skill.
Do not use this skill for CLI install flows beyond a brief pointer. That belongs to
firecrawl/cli
.
  • 项目需要
    FIRECRAWL_API_KEY
  • 用户希望将Firecrawl配置写入
    .env
  • 你首次为应用集成Firecrawl
  • 你需要选择首个SDK或REST集成路径
如果用户仍需要在浏览器中完成注册、登录或授权访问,请使用本技能提供的身份验证流程参考。
请勿将本技能用于CLI安装流程,仅可提供简短指引,CLI安装相关内容归属于
firecrawl/cli
范畴。

Quick Start

快速开始

If the user already has an API key, place it in
.env
:
dotenv
FIRECRAWL_API_KEY=fc-...
If the project is self-hosted, also set:
dotenv
FIRECRAWL_API_URL=https://your-firecrawl-instance.example.com
Then decide which integration path applies:
  • Fresh project -> choose the target stack, install the SDK, add the first Firecrawl call, and run a smoke test
  • Existing project -> inspect the repo first, then integrate Firecrawl where the project already handles third-party APIs and env vars
如果用户已经拥有API key,请将其添加到
.env
文件中:
dotenv
FIRECRAWL_API_KEY=fc-...
如果是自托管项目,还需要额外配置:
dotenv
FIRECRAWL_API_URL=https://your-firecrawl-instance.example.com
之后选择适用的集成路径:
  • 全新项目 -> 选择目标技术栈,安装SDK,添加第一个Firecrawl调用,运行冒烟测试
  • 现有项目 -> 先检视代码仓库,在项目已处理第三方API和环境变量的位置集成Firecrawl

What Do You Need?

资源参考

TaskReference
Run the browser auth flow and save
FIRECRAWL_API_KEY
references/auth-flow.md
Install the right SDKreferences/sdk-installation.md
Put credentials into
.env
or project config
references/project-setup.md
Choose the right endpoint after setupfirecrawl-build
Need live web tooling during this task instead
firecrawl/cli
Start implementation from a known URLfirecrawl-build-scrape
Start implementation from a queryfirecrawl-build-search
任务参考链接
运行浏览器身份验证流程并保存
FIRECRAWL_API_KEY
references/auth-flow.md
安装对应SDKreferences/sdk-installation.md
将凭证写入
.env
或项目配置
references/project-setup.md
配置完成后选择合适的端点firecrawl-build
当前任务需要使用实时网页工具
firecrawl/cli
从已知URL开始实现功能firecrawl-build-scrape
从查询请求开始实现功能firecrawl-build-search

After Setup

配置完成后

Once the key is present:
  1. decide whether this is a fresh project or an existing codebase
  2. ask what Firecrawl should do in the product
  3. pick the narrowest endpoint that matches that behavior
  4. add the SDK or REST call in code
  5. run a smoke test that proves one real Firecrawl request succeeds
  6. use the endpoint-specific skills in this repo for implementation guidance
  7. if you also need live web tooling during the current task, use
    firecrawl/cli
    alongside this repo
成功添加密钥后:
  1. 确认当前是全新项目还是现有代码库
  2. 询问产品中需要Firecrawl实现的具体功能
  3. 选择最匹配该功能的最小范围端点
  4. 在代码中添加SDK或REST调用
  5. 运行冒烟测试,验证至少一个真实的Firecrawl请求可以成功执行
  6. 参考本仓库中对应端点的技能文档获取实现指引
  7. 如果当前任务还需要使用实时网页工具,请同时使用
    firecrawl/cli
    和本仓库内容