Actor CLI starter template

Start a new Actorization project quickly and easily with this project template. It provides a basic structure for building an Actor with the Apify CLI and allows you to easily add your own functionality.

Included features

• Apify CLI - toolkit for building Actors that interact with the Apify platform.
• jq - a command line filter for working with JSON

How it works

This template is useful when you're already familiar with the Apify Platform and want to use the Apify CLI to turn almost any project into an Actor.

Resources

• Actor development in Apify documentation - see especially the actor.json part
• Actor whitepaper for a deep dive into the Actor computing model

Getting started

For complete information see this article. In short, you will:

1. Build the Actor
2. Run the Actor

Pull the Actor for local development

If you would like to develop locally, you can pull the existing Actor from Apify console using Apify CLI:

1. Install apify-cli

   Using Homebrew

   $brew install apify-cli
   

   Using NPM

   $npm -g install apify-cli
   

2. Pull the Actor by its unique <ActorId>, which is one of the following:

   • unique name of the Actor to pull (e.g. "apify/hello-world")
   • or ID of the Actor to pull (e.g. "E2jjCZBezvAZnX8Rb")

   You can find both by clicking on the Actor title at the top of the page, which will open a modal containing both Actor unique name and Actor ID.

   This command will copy the Actor into the current directory on your local machine.

   $apify pull <ActorId>
   

Documentation reference

To learn more about Apify and Actors, take a look at the following resources:

• Apify SDK for JavaScript documentation
• Apify SDK for Python documentation
• Apify Platform documentation
• Join our developer community on Discord