Skip to content

Commit 374b97f

Browse files
TC-MOvladfrangu
andauthored
docs: update readme (#889)
Co-authored-by: Vlad Frangu <me@vladfrangu.dev>
1 parent bbe2038 commit 374b97f

File tree

3 files changed

+31
-21
lines changed

3 files changed

+31
-21
lines changed

.github/workflows/check.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ jobs:
9696
fail-fast: false
9797
matrix:
9898
os: [ubuntu-latest, windows-2025]
99-
node-version: [18, 20, 22, 24]
99+
node-version: [20, 22, 24]
100100

101101
runs-on: ${{ matrix.os }}
102102

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ However, we recommend using JavaScript / Node.js, for which we provide most libr
2121

2222
## Installation
2323

24+
### Via bundles
25+
26+
#### MacOS / Unix
27+
28+
```bash
29+
curl -fsSL https://apify.com/install-cli.sh | bash
30+
```
31+
32+
#### Windows
33+
34+
```powershell
35+
irm https://apify.com/install-cli.ps1 | iex
36+
```
37+
2438
### Via Homebrew
2539

2640
On macOS (or Linux), you can install the Apify CLI via the [Homebrew package manager](https://brew.sh).
@@ -31,7 +45,7 @@ brew install apify-cli
3145

3246
### Via NPM
3347

34-
First, make sure you have [Node.js](https://nodejs.org) version 16 or higher with NPM installed on your computer:
48+
First, make sure you have [Node.js](https://nodejs.org) version 22 or higher with NPM installed on your computer:
3549

3650
```bash
3751
node --version
@@ -41,21 +55,15 @@ npm --version
4155
Install or upgrade Apify CLI by running:
4256

4357
```bash
44-
npm -g install apify-cli
58+
npm install -g apify-cli
4559
```
4660

47-
If you receive an `EACCES` error, you might need to run the command as root:
61+
Alternatively, you can use [fnm (Fast Node Manager)](https://github.com/Schniz/fnm) and install Apify CLI only into a selected user-level Node version without requiring root privileges:
4862

4963
```bash
50-
sudo npm -g install apify-cli
51-
```
52-
53-
Alternatively, you can use [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm) and install Apify CLI only into a selected user-level Node version without requiring root privileges:
54-
55-
```
56-
nvm install 16
57-
nvm use 16
58-
npm -g install apify-cli
64+
fnm install 22
65+
fnm use 22
66+
npm install -g apify-cli
5967
```
6068

6169
Finally, verify that Apify CLI was installed correctly by running:
@@ -64,12 +72,6 @@ Finally, verify that Apify CLI was installed correctly by running:
6472
apify --version
6573
```
6674

67-
which should print something like:
68-
69-
```
70-
apify-cli/0.10.0 darwin-x64 node-v16.14.2
71-
```
72-
7375
> You can also skip the manual global installation altogether and use `npx apify-cli` with all the following commands instead.
7476
7577
## Basic usage
@@ -114,7 +116,7 @@ You can find more information about by running `apify help run`.
114116

115117
### Create a new Actor from Scrapy project
116118

117-
If you want to run a Scrapy project on Apify platform, follow the Scrapy integration guide [here](https://docs.apify.com/cli/docs/integrating-scrapy).
119+
If you want to run a Scrapy project on Apify platform, follow the [Scrapy integration guide](https://docs.apify.com/cli/docs/integrating-scrapy).
118120

119121
### Run the Actor locally
120122

@@ -278,4 +280,4 @@ or [contact us](https://www.apify.com/contact).
278280

279281
## Command reference
280282

281-
This section contains printouts of `apify help` for all commands.
283+
See a list of all our commands on the [reference page](https://docs.apify.com/cli/docs/reference)

docs/installation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,11 @@ The output should resemble the following (exact details like version or platform
6565
```bash
6666
apify-cli/1.0.1 (0dfcfd8) running on darwin-arm64 with bun-1.2.19 (emulating node 24.3.0), installed via bundle
6767
```
68+
69+
## Upgrading
70+
71+
Upgrading Apify CLI is as simple as running the following command:
72+
73+
```bash
74+
apify upgrade
75+
```

0 commit comments

Comments
 (0)