Skip to content

docs: improve overview page #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: improve overview page #963

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
021a65f
docs: improve intro page
marcel-rbro Nov 12, 2025
17a0c31
docs: change intro to overview
marcel-rbro Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
---
title: Overview
title: Apify CLI overview
description: An introduction to Apify CLI, a command-line interface for creating, developing, building, and running Apify Actors and managing the Apify cloud platform.
sidebar_label: Overview
---

Apify command-line interface (Apify CLI) helps you create, develop, build and run
[Apify Actors](https://apify.com/actors),
and manage the Apify cloud platform from any computer.
Apify command-line interface (Apify CLI) helps you create, develop, build and run [Apify Actors](https://apify.com/actors), and manage the Apify cloud platform from any computer.

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 directly in the [Apify web application](https://console.apify.com/),
for complex projects it is more convenient to develop Actors locally on your computer
using <a href="https://github.com/apify/apify-sdk-js">Apify SDK</a>
and only push the Actors to the Apify cloud during deployment.
This is where the Apify CLI comes in.
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. The Apify CLI enables you to develop Actors locally on your computer using your preferred code editor, version control system, and development tools. This approach gives you full control over your development environment, makes it easier to work on complex projects, and allows you to leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features. When you're ready, simply push your Actor to the Apify cloud for deployment.

:::note Run Actors in Docker
:::note Actor Development Environment

Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile`
you can build your Actors in any programming language.
However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support.
Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile` you can build your Actors in any programming language. However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support.

:::

## Learn more

Learn everything you need to use the Apify CLI effectively:

- Learn how to [install](./installation.md) the CLI on your system
- Get started with your [first Actor project](./quick-start.md)
- See the complete [reference of all CLI commands](./reference.md) and options
- Find [solutions to common issues](./troubleshooting.md)