apify-cli 0.7.4 → 0.8.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -30
- package/npm-shrinkwrap.json +1458 -1942
- package/oclif.manifest.json +1 -1
- package/package.json +98 -98
- package/src/commands/push.js +1 -1
- package/src/commands/run.js +10 -4
- package/src/lib/actor.js +5 -8
- package/src/lib/consts.js +3 -1
- package/src/lib/utils.js +4 -4
- package/CHANGELOG.md +0 -200
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ However, we recommend using JavaScript / Node.js, for which we provide most libr
|
|
|
22
22
|
|
|
23
23
|
## Installation
|
|
24
24
|
|
|
25
|
-
First, make sure you have [Node.js](https://nodejs.org) version
|
|
25
|
+
First, make sure you have [Node.js](https://nodejs.org) version 16 or higher with NPM installed on your computer:
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
28
|
node --version
|
|
@@ -44,8 +44,8 @@ sudo npm -g install apify-cli
|
|
|
44
44
|
Alternativaly, 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:
|
|
45
45
|
|
|
46
46
|
```
|
|
47
|
-
nvm install
|
|
48
|
-
nvm use
|
|
47
|
+
nvm install 16
|
|
48
|
+
nvm use 16
|
|
49
49
|
npm -g install apify-cli
|
|
50
50
|
```
|
|
51
51
|
|
|
@@ -57,7 +57,7 @@ apify --version
|
|
|
57
57
|
|
|
58
58
|
which should print something like:
|
|
59
59
|
```
|
|
60
|
-
apify-cli/0.
|
|
60
|
+
apify-cli/0.8.0 darwin-x64 node-v16.16.0
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
## Basic usage
|
|
@@ -262,7 +262,7 @@ USAGE
|
|
|
262
262
|
$ apify actor
|
|
263
263
|
```
|
|
264
264
|
|
|
265
|
-
_See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.
|
|
265
|
+
_See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/actor/index.js)_
|
|
266
266
|
|
|
267
267
|
## `apify actor:get-input`
|
|
268
268
|
|
|
@@ -273,7 +273,7 @@ USAGE
|
|
|
273
273
|
$ apify actor:get-input
|
|
274
274
|
```
|
|
275
275
|
|
|
276
|
-
_See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.
|
|
276
|
+
_See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/actor/get-input.js)_
|
|
277
277
|
|
|
278
278
|
## `apify actor:get-value KEY`
|
|
279
279
|
|
|
@@ -287,7 +287,7 @@ ARGUMENTS
|
|
|
287
287
|
KEY Key of the record in key-value store
|
|
288
288
|
```
|
|
289
289
|
|
|
290
|
-
_See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.
|
|
290
|
+
_See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/actor/get-value.js)_
|
|
291
291
|
|
|
292
292
|
## `apify actor:push-data [ITEM]`
|
|
293
293
|
|
|
@@ -308,7 +308,7 @@ DESCRIPTION
|
|
|
308
308
|
$ cat ./test.json | apify actor:push-data
|
|
309
309
|
```
|
|
310
310
|
|
|
311
|
-
_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.
|
|
311
|
+
_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/actor/push-data.js)_
|
|
312
312
|
|
|
313
313
|
## `apify actor:set-value KEY [VALUE]`
|
|
314
314
|
|
|
@@ -338,7 +338,7 @@ DESCRIPTION
|
|
|
338
338
|
$ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain
|
|
339
339
|
```
|
|
340
340
|
|
|
341
|
-
_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.
|
|
341
|
+
_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/actor/set-value.js)_
|
|
342
342
|
|
|
343
343
|
## `apify call [ACTID]`
|
|
344
344
|
|
|
@@ -359,11 +359,11 @@ OPTIONS
|
|
|
359
359
|
-w, --wait-for-finish=wait-for-finish Seconds for waiting to run to finish, if no value passed, it waits forever.
|
|
360
360
|
|
|
361
361
|
DESCRIPTION
|
|
362
|
-
The actor is run under your current Apify account, therefore you need to be logged in by calling "apify login". It
|
|
362
|
+
The actor is run under your current Apify account, therefore you need to be logged in by calling "apify login". It
|
|
363
363
|
takes input for the actor from the default local key-value store by default.
|
|
364
364
|
```
|
|
365
365
|
|
|
366
|
-
_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.
|
|
366
|
+
_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/call.js)_
|
|
367
367
|
|
|
368
368
|
## `apify create [ACTORNAME]`
|
|
369
369
|
|
|
@@ -382,7 +382,7 @@ OPTIONS
|
|
|
382
382
|
find available template names.
|
|
383
383
|
```
|
|
384
384
|
|
|
385
|
-
_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.
|
|
385
|
+
_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/create.js)_
|
|
386
386
|
|
|
387
387
|
## `apify info`
|
|
388
388
|
|
|
@@ -396,7 +396,7 @@ DESCRIPTION
|
|
|
396
396
|
The information is printed to the console.
|
|
397
397
|
```
|
|
398
398
|
|
|
399
|
-
_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.
|
|
399
|
+
_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/info.js)_
|
|
400
400
|
|
|
401
401
|
## `apify init [ACTORNAME]`
|
|
402
402
|
|
|
@@ -410,13 +410,13 @@ ARGUMENTS
|
|
|
410
410
|
ACTORNAME Name of the actor. If not provided, you will be prompted for it.
|
|
411
411
|
|
|
412
412
|
DESCRIPTION
|
|
413
|
-
The command only creates the "apify.json" file and the "
|
|
414
|
-
|
|
413
|
+
The command only creates the "apify.json" file and the "storage" directory in the current directory, but will not
|
|
414
|
+
touch anything else.
|
|
415
415
|
|
|
416
|
-
WARNING: The directory at "
|
|
416
|
+
WARNING: The directory at "storage" will be overwritten if it already exists.
|
|
417
417
|
```
|
|
418
418
|
|
|
419
|
-
_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.
|
|
419
|
+
_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/init.js)_
|
|
420
420
|
|
|
421
421
|
## `apify login`
|
|
422
422
|
|
|
@@ -430,11 +430,11 @@ OPTIONS
|
|
|
430
430
|
-t, --token=token [Optional] Apify API token
|
|
431
431
|
|
|
432
432
|
DESCRIPTION
|
|
433
|
-
The API token and other account information is stored in the ~/.apify directory, from where it is read by all other
|
|
433
|
+
The API token and other account information is stored in the ~/.apify directory, from where it is read by all other
|
|
434
434
|
"apify" commands. To log out, call "apify logout".
|
|
435
435
|
```
|
|
436
436
|
|
|
437
|
-
_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.
|
|
437
|
+
_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/login.js)_
|
|
438
438
|
|
|
439
439
|
## `apify logout`
|
|
440
440
|
|
|
@@ -449,7 +449,7 @@ DESCRIPTION
|
|
|
449
449
|
call "apify login".
|
|
450
450
|
```
|
|
451
451
|
|
|
452
|
-
_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.
|
|
452
|
+
_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/logout.js)_
|
|
453
453
|
|
|
454
454
|
## `apify push [ACTORID]`
|
|
455
455
|
|
|
@@ -476,15 +476,15 @@ OPTIONS
|
|
|
476
476
|
should be pushed. By default, it is taken from the "apify.json" file.
|
|
477
477
|
|
|
478
478
|
DESCRIPTION
|
|
479
|
-
The actor settings are read from the "apify.json" file in the current directory, but they can be overridden using
|
|
479
|
+
The actor settings are read from the "apify.json" file in the current directory, but they can be overridden using
|
|
480
480
|
command-line options.
|
|
481
|
-
NOTE: If the source files are smaller than 3 MB then they are uploaded as
|
|
481
|
+
NOTE: If the source files are smaller than 3 MB then they are uploaded as
|
|
482
482
|
"Multiple source files", otherwise they are uploaded as "Zip file".
|
|
483
483
|
|
|
484
484
|
WARNING: If the target actor already exists in your Apify account, it will be overwritten!
|
|
485
485
|
```
|
|
486
486
|
|
|
487
|
-
_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.
|
|
487
|
+
_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/push.js)_
|
|
488
488
|
|
|
489
489
|
## `apify run`
|
|
490
490
|
|
|
@@ -508,13 +508,13 @@ OPTIONS
|
|
|
508
508
|
DESCRIPTION
|
|
509
509
|
It sets various APIFY_XYZ environment variables in order to provide a working execution environment for the actor. For
|
|
510
510
|
example, this causes the actor input, as well as all other data in key-value stores, datasets or request queues to be
|
|
511
|
-
stored in the "
|
|
511
|
+
stored in the "storage" directory, rather than on the Apify platform.
|
|
512
512
|
|
|
513
|
-
NOTE: You can override the default behaviour of command overriding npm start script value in a package.json file. You
|
|
513
|
+
NOTE: You can override the default behaviour of command overriding npm start script value in a package.json file. You
|
|
514
514
|
can set up your own main file or environment variables by changing it.
|
|
515
515
|
```
|
|
516
516
|
|
|
517
|
-
_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.
|
|
517
|
+
_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/run.js)_
|
|
518
518
|
|
|
519
519
|
## `apify secrets`
|
|
520
520
|
|
|
@@ -540,7 +540,7 @@ DESCRIPTION
|
|
|
540
540
|
of the actor.
|
|
541
541
|
```
|
|
542
542
|
|
|
543
|
-
_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.
|
|
543
|
+
_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/secrets/index.js)_
|
|
544
544
|
|
|
545
545
|
## `apify secrets:add NAME VALUE`
|
|
546
546
|
|
|
@@ -558,7 +558,7 @@ DESCRIPTION
|
|
|
558
558
|
The secrets are stored to a file at ~/.apify
|
|
559
559
|
```
|
|
560
560
|
|
|
561
|
-
_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.
|
|
561
|
+
_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/secrets/add.js)_
|
|
562
562
|
|
|
563
563
|
## `apify secrets:rm NAME`
|
|
564
564
|
|
|
@@ -572,7 +572,7 @@ ARGUMENTS
|
|
|
572
572
|
NAME Name of the secret
|
|
573
573
|
```
|
|
574
574
|
|
|
575
|
-
_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.
|
|
575
|
+
_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/secrets/rm.js)_
|
|
576
576
|
|
|
577
577
|
## `apify vis [PATH]`
|
|
578
578
|
|
|
@@ -586,5 +586,5 @@ ARGUMENTS
|
|
|
586
586
|
PATH Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
|
|
587
587
|
```
|
|
588
588
|
|
|
589
|
-
_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.
|
|
589
|
+
_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.8.0/src/commands/vis.js)_
|
|
590
590
|
<!-- commandsstop -->
|