界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
开发与工程 · SKILL.md

firecrawl-build-onboarding

firecrawl-build-onboarding

【开发与工程】Get Firecrawl credentials and SDK setup into a project. Use when an application needs `FIRECRAWL_API_KEY`, when an agent should add Firecrawl to `.env`, when the user wants to authenticate Firecrawl for app code, or when choosing the first SDK and docs for a new Firecrawl integration. This skill includes its own browser auth flow, so it does not depe…

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: firecrawl-build-onboarding description: Get Firecrawl credentials and SDK setup into a project. Use when an application needs FIRECRAWL_API_KEY, when an agent should add Firecrawl to .env, when the user wants to authenticate Firecrawl for app code, or when choosing the first SDK and docs for a new Firecrawl integration. This skill includes its own browser auth flow, so it does not depend on the website onboarding skill. license: ISC metadata: author: firecrawl version: "0.1.0" homepage: https://www.firecrawl.dev source: https://github.com/firecrawl/skills inputs:

  • name: FIRECRAWL_API_KEY description: Firecrawl API key used for hosted Firecrawl API requests. required: true
  • name: FIRECRAWL_API_URL description: Optional base URL for self-hosted Firecrawl deployments. required: false references:
  • references/auth-flow.md
  • references/sdk-installation.md
  • references/project-setup.md

Firecrawl Build Onboarding

Use this skill for the application-integration path from Firecrawl's onboarding flow.

Install

If you haven't installed yet, one command sets up both the CLI tools (for live web work) and the build skills (for app integration):

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

This installs the Firecrawl CLI, the CLI skills, and these build skills together. It also opens browser auth so the human can sign in or create an account. No separate npx skills add step is needed.

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.

If the project already uses Stripe Projects (a .projects/ directory, or stripe projects status succeeds), the key can come from there instead of the browser flow:

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

--name firecrawl is what puts the key in FIRECRAWL_API_KEY; without it the CLI writes FIRECRAWL_API_API_KEY, which the SDKs do not read. Ignore the FIRECRAWL_API_BASE_URL the CLI also writes: the SDKs read FIRECRAWL_API_URL, and only for self-hosted deployments, so leave it unset for a hosted account. Paid plans are the human's call, since stripe projects upgrade firecrawl charges their card. The docs page carries the catalog and troubleshooting.

Quick Start

If the user already has an API key, place it in .env:

FIRECRAWL_API_KEY=fc-...

If the project is self-hosted, also set:

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

What Do You Need?

TaskReference
Run the browser auth flow and save FIRECRAWL_API_KEYreferences/auth-flow.md
Provision the key through Stripe Projectsdocs.firecrawl.dev/integrations/stripe-projects
Install the right SDKreferences/sdk-installation.md
Put credentials into .env or project configreferences/project-setup.md
Choose the right endpoint after setupfirecrawl-build
Need live web tooling during this taskThe CLI skills are already installed from the same command
Start implementation from a known URLfirecrawl-build-scrape
Start implementation from a queryfirecrawl-build-search

Docs (Source of Truth)

Read the source-of-truth page for your project language for SDK usage, schemas, and examples:

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. read the source-of-truth page for the project language before writing code
  5. add the SDK or REST call in code
  6. run a smoke test that proves one real Firecrawl request succeeds
  7. use the endpoint-specific skills in this repo for implementation guidance
  8. if you also need live web tooling during the current task, the CLI skills are already installed — use firecrawl/cli
我的收藏