Apify SOP

Appearance

Install ​

Apify CLI ​

The CLI is the primary local development tool. It scaffolds Actors, runs them locally, and pushes to the Apify cloud.

macOS / Linux (recommended - standalone binary via Bun, no Node.js required):

bash
curl -fsSL https://apify.com/install-cli.sh | bash

Windows (PowerShell):

powershell
irm https://apify.com/install-cli.ps1 | iex

Homebrew (macOS):

bash
brew install apify-cli

npm (requires Node.js 22+):

bash
npm install -g apify-cli

After installation, verify with:

bash
apify --version

Upgrade any time with:

bash
apify upgrade

Apify SDK (JavaScript / TypeScript) ​

For building Actors in Node.js or TypeScript:

bash
npm install apify

Apify SDK (Python) ​

For building Actors in Python:

bash
pip install apify-sdk

Apify API Client ​

For calling the Apify REST API directly from application code (not needed if you use the SDK):

JavaScript:

bash
npm install apify-client

Python:

bash
pip install apify-client

Prerequisites ​

  • npm install path: Node.js v22 or higher
  • Script install path: No Node.js required (uses Bun internally)
  • Python SDK: Python 3.8+

Actor Templates (Starter Boilerplate) ​

Apify publishes official Actor templates on GitHub:

Template repository: https://github.com/apify/actor-templates

The apify create CLI command interactively scaffolds a new Actor from these templates. Available templates include JavaScript web scraper, Python scraper, TypeScript Actor, and Crawlee-based crawlers.

Browse all published templates at: https://apify.com/templates