Skip to content

Commit c2ed134

Browse files
authored
docs: improve overview page (#963)
Part of the fix for apify/apify-docs#1869
1 parent 3c8f687 commit c2ed134

File tree

1 file changed

+28
-15
lines changed

1 file changed

+28
-15
lines changed

docs/index.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,36 @@
11
---
2-
title: Overview
2+
title: Apify CLI overview
3+
description: An introduction to Apify CLI, a command-line interface for creating, developing, building, and running Apify Actors and managing the Apify cloud platform.
4+
sidebar_label: Overview
35
---
46

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

9-
Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job.
10-
They accept input, perform their job and generate output.
11-
While you can develop Actors in an online IDE directly in the [Apify web application](https://console.apify.com/),
12-
for complex projects it is more convenient to develop Actors locally on your computer
13-
using <a href="https://github.com/apify/apify-sdk-js">Apify SDK</a>
14-
and only push the Actors to the Apify cloud during deployment.
15-
This is where the Apify CLI comes in.
9+
## What are Apify Actors?
1610

17-
:::note Run Actors in Docker
11+
Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. They accept input, perform their job and generate output.
1812

19-
Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile`
20-
you can build your Actors in any programming language.
21-
However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support.
13+
## Why use Apify CLI?
14+
15+
The Apify CLI enables you to develop Actors locally on your computer using your preferred tools:
16+
17+
- Your favorite code editor
18+
- Version control system
19+
- Development tools and workflows
20+
21+
This gives you full control over your development environment and makes it easier to work on complex projects. You can leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features, then push your Actor to the Apify platform for deployment when ready.
22+
23+
:::note Actor development environment
24+
25+
Actors run in Docker containers on the Apify platform. With an appropriate `Dockerfile`, you can build Actors in any programming language. We recommend JavaScript/Node.js and Python, for which we have the most comprehensive libraries and support.
2226

2327
:::
28+
29+
## Learn more
30+
31+
Learn everything you need to use the Apify CLI effectively:
32+
33+
- Learn how to [install](./installation.md) the CLI on your system
34+
- Get started with your [first Actor project](./quick-start.md)
35+
- See the complete [reference of all CLI commands](./reference.md) and options
36+
- Find [solutions to common issues](./troubleshooting.md)

0 commit comments

Comments
 (0)