| name | apify-upgrade-migration |
| description | Upgrade Apify SDK, apify-client, and Crawlee versions safely.
Use when migrating between SDK versions, handling breaking changes,
or updating from Apify SDK v2 to v3 (Crawlee split).
Trigger with "upgrade apify", "apify migration", "apify breaking changes",
"update apify SDK", "crawlee upgrade", "apify v2 to v3".
|
| allowed-tools | Read, Write, Edit, Bash(npm:*), Bash(npx:*), Bash(git:*), Grep |
| version | 1.5.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
| tags | ["saas","scraping","automation","apify"] |
| compatibility | Designed for Claude Code |
Apify Upgrade & Migration
Overview
Guide for upgrading apify, apify-client, and crawlee packages. The biggest
migration in Apify's history was SDK v2 to v3, which split crawling functionality
into the crawlee package. This skill covers that migration plus general upgrade
procedures. Read and edit source files with Grep/Read/Edit to apply the
rename-heavy changes, then verify with the packaged script.
Prerequisites
Before starting, confirm the working tree is in a recoverable state:
- A dedicated git branch for the upgrade, so a bad bump can be reverted cleanly.
- A runnable test suite (
npm test) plus a build step (npm run build) to catch
TypeScript interface changes.
- The current installed versions recorded (
npm list apify apify-client crawlee)
so rollback targets are known.
APIFY_TOKEN in the environment if the verification script's API-connection
check will run.
Instructions
Step 1: Check Current Versions
npm list apify apify-client crawlee 2>/dev/null
npm view apify version
npm view apify-client version
npm view crawlee version
npm outdated apify apify-client crawlee
Step 2: Create Upgrade Branch
git checkout -b upgrade/apify-packages
Step 3: Upgrade Packages
npm install apify@latest crawlee@latest apify-client@latest
npm install apify@3.2.0 crawlee@3.11.0
npm ls 2>&1 | grep "ERESOLVE\|peer dep"
Step 4: Apply Code Changes
If crossing the v2→v3 boundary, use Grep to find every Apify. reference and
Edit each call site. The full before/after set — imports, Actor.main, crawler
option renames (handlePageFunction → requestHandler), proxy config, request
queues, and the new router pattern — is in
. Minimal shape: