Analyze, plan, and execute FireCrawl SDK upgrades with breaking change detection.
Use when upgrading FireCrawl SDK versions, detecting deprecations,
or migrating to new API versions.
Trigger with phrases like "upgrade firecrawl", "firecrawl migration",
"firecrawl breaking changes", "update firecrawl SDK", "analyze firecrawl version".
Guide for upgrading @mendable/firecrawl-js SDK versions and migrating from Firecrawl API v0/v1 to v2. Covers breaking changes in import paths, method signatures, response formats, and the new extract v2 schema format.
Version History
SDK Version
API Version
Key Changes
1.x
v1
asyncCrawlUrl, checkCrawlStatus, mapUrl added
0.x
v0
Legacy crawlUrl with param
waitUntilDone
Instructions
Step 1: Check Current Version
set -euo pipefail
# Check installed version
npm list @mendable/firecrawl-js
# Check latest available
npm view @mendable/firecrawl-js version
Step 2: Create Upgrade Branch
set -euo pipefail
git checkout -b upgrade/firecrawl-sdk
npm install @mendable/firecrawl-js@latest
npm test
Step 3: Migration — v0 to v1/v2
Import Changes
// No change needed — import has been stable
import FirecrawlApp from "@mendable/firecrawl-js";
Crawl Method Changes (v0 -> v1)
// BEFORE (v0): crawlUrl with waitUntilDone
const result = await firecrawl.crawlUrl("https://example.com", {
crawlerOptions: { limit: 50 },
pageOptions: { onlyMainContent: true },
waitUntilDone: true,
});
// AFTER (v1+): crawlUrl returns synchronously, or use asyncCrawlUrl
const result = await firecrawl.crawlUrl("https://example.com", {
limit: 50,
scrapeOptions: {
formats: ["markdown"],
onlyMainContent: true,
},
});
// For large crawls, use async with polling
const job = await firecrawl.asyncCrawlUrl("https://example.com", {
limit: 500,
scrapeOptions: { formats: ["markdown"] },
});
const status = await firecrawl.checkCrawlStatus(job.id);
