Skip to content

Setup Apify CLI

Actions

About

Install and configure the Apify CLI for use in GitHub Actions
v1.0.0
Latest
Star (1)

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

Setup Apify CLI GitHub Action

What is Apify?

Apify is a full-stack web scraping and automation platform where developers can build, deploy, and publish serverless microapps called Actors.

What does Setup Apify CLI GitHub Action do?

This GitHub action sets up the Apify CLI in your GitHub Actions workflow. It installs the specified version of Apify CLI and logs you in with your Apify token, making it ready for use in subsequent workflow steps.

Inputs

version (optional): Version of Apify CLI to install (e.g. "1.1.1", "latest", "beta"). Defaults to the latest stable version. Use "beta" to install the latest prerelease version.

token (required): Your Apify token for authentication. The CLI will be automatically logged in with this token. See the Apify integration docs for instructions on how to find it.

Example usage

Basic setup with latest CLI version

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Setup Apify CLI
        uses: apify/setup-apify-cli-action@main
        with:
          token: ${{ secrets.APIFY_TOKEN }}

      - name: Use Apify CLI
        run: |
          apify --version
          apify create my-actor

Setup with specific version

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Setup Apify CLI
        uses: apify/setup-apify-cli-action@main
        with:
          version: '1.1.1'
          token: ${{ secrets.APIFY_TOKEN }}

Setup with latest beta (prerelease) version

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Setup Apify CLI
        uses: apify/setup-apify-cli-action@main
        with:
          version: 'beta'
          token: ${{ secrets.APIFY_TOKEN }}

Examples of top Actors on Apify Store

There are thousands of pre-built Actors on Apify Store. Check out some of the most popular:

  • Website Content Crawler: Crawl websites and extract text content to feed AI models, LLM applications, vector databases, or RAG pipelines.
  • Google Search Results Scraper: Extract organic and paid results, AI overviews, ads, queries, People Also Ask, prices, reviews, like a Google SERP API.
  • Instagram Scraper: Scrape and download Instagram posts, profiles, places, hashtags, photos, and comments.
  • Google Maps Email Extractor: Scrape websites of Google Maps places for contact details and get email addresses, website, location, address, zipcode, phone number, social media links.

Additional resources

Setup Apify CLI is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Install and configure the Apify CLI for use in GitHub Actions
v1.0.0
Latest

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

Setup Apify CLI is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.