Skip to main content

Apify command-line interface (CLI)

Create, develop, build, and run Apify Actors from your terminal. Manage the Apify platform from shell scripts.

npx apify-cli create

Apify actors are cloud programs that can perform arbitrary web scraping, automation, or data processing job. They accept input, perform their job and generate output.

While you can develop actors in an online IDE in Apify Console, for larger projects, it is more convenient to develop actors locally on your computer using Apify SDK and only push the actors to the Apify platform during deployment. This is where the Apify CLI comes in to allow you to quickly develop locally and then deploy to the cloud with a single command.

# Create your first actor
npx apify-cli create my-actor

# Go into the project directory
cd my-actor

# Run it locally
npx apify-cli run

# Log into your Apify account and deploy it to Apify Platform
npx apify-cli login
npx apify-cli push