Skip to content

quick-start.md

Latest commit

 

History

History
84 lines (54 loc) · 2.44 KB

quick-start.md

File metadata and controls

84 lines (54 loc) · 2.44 KB
title Quick start
description Learn how to create, run, and manage Actors using Apify CLI.

Learn how to create, run, and manage Actors using Apify CLI.

Prerequisites

Before you begin, make sure you have the Apify CLI installed on your system. If you haven't installed it yet, follow the installation guide.

Step 1: Create your Actor

Run the following command in your terminal. It will guide you step by step through the creation process.

apify create

:::info Explore Actor templates

The Apify CLI will prompt you to choose a template. Browse the full list of templates to find the best fit for your Actor.

:::

Step 2: Run your Actor

Once the Actor is initialized, you can run it:

apify run

You'll see output similar to this in your terminal:

INFO  System info {"apifyVersion":"3.4.3","apifyClientVersion":"2.12.6","crawleeVersion":"3.13.10","osType":"Darwin","nodeVersion":"v22.17.0"}
Extracted heading { level: 'h1', text: 'Your full‑stack platform for web scraping' }
Extracted heading { level: 'h3', text: 'TikTok Scraper' }
Extracted heading { level: 'h3', text: 'Google Maps Scraper' }
Extracted heading { level: 'h3', text: 'Instagram Scraper' }

Step 3: Push your Actor

Once you are ready, you can push your Actor to the Apify platform, where you can schedule runs, or make the Actor public for other developers.

Login to Apify Console

apify login

:::note Create an Apify account

Before you can interact with the Apify Console, create an Apify account. When you run apify login, you can choose one of the following methods:

  • Sign in via the Apify Console in your browser — recommended.
  • Provide an Apify API token — alternative method.

The interactive prompt will guide you through either option.

:::

Push to Apify Console

apify push

Step 4: Call your Actor (optional)

You can run your Actor on the Apify platform. In the following example, the command runs apify/hello-world on the Apify platform.

apify call apify/hello-world

Next steps