apify-cli 0.14.1 → 0.14.2-beta.1
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 +25 -21
- package/npm-shrinkwrap.json +1102 -536
- package/oclif.manifest.json +1 -1
- package/package.json +104 -104
- package/src/commands/create.js +22 -52
- package/src/commands/login-new.js +164 -0
- package/src/lib/create-utils.js +175 -0
- package/src/lib/utils.js +8 -4
- package/src/lib/version_check.js +17 -5
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Apify command-line interface (Apify CLI)
|
|
2
2
|
|
|
3
|
-
<a href="https://www.npmjs.com/package/apify-cli"><img src="https://badge.fury.io/js/apify-cli.svg" alt="npm version" loading="lazy" style="display:inherit;"
|
|
4
|
-
<a href="https://travis-ci.com/apify/apify-cli?branch=master"><img src="https://travis-ci.com/apify/apify-cli.svg?branch=master" loading="lazy" alt="Build Status" style="display:inherit;"
|
|
3
|
+
<a href="https://www.npmjs.com/package/apify-cli"><img src="https://badge.fury.io/js/apify-cli.svg" alt="npm version" loading="lazy" style="display:inherit;" /></a>
|
|
4
|
+
<a href="https://travis-ci.com/apify/apify-cli?branch=master"><img src="https://travis-ci.com/apify/apify-cli.svg?branch=master" loading="lazy" alt="Build Status" style="display:inherit;" /></a>
|
|
5
5
|
|
|
6
6
|
Apify command-line interface (Apify CLI) helps you create, develop, build and run
|
|
7
7
|
[Apify actors](https://www.apify.com/actors),
|
|
@@ -11,7 +11,7 @@ Apify actors are cloud programs that can perform arbitrary web scraping, automat
|
|
|
11
11
|
They accept input, perform their job and generate output.
|
|
12
12
|
While you can develop actors in an online IDE directly in the [Apify web application](https://console.apify.com/),
|
|
13
13
|
for complex projects it is more convenient to develop actors locally on your computer
|
|
14
|
-
using <a href="https://github.com/apify/apify-js">Apify SDK</a>
|
|
14
|
+
using <a href="https://github.com/apify/apify-sdk-js">Apify SDK</a>
|
|
15
15
|
and only push the actors to the Apify cloud during deployment.
|
|
16
16
|
This is where the Apify CLI comes in.
|
|
17
17
|
|
|
@@ -60,6 +60,8 @@ which should print something like:
|
|
|
60
60
|
apify-cli/0.10.0 darwin-x64 node-v16.14.2
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
+
> You can also skip the manual global installation altogether and use `npx apify-cli` with all the following commands instead.
|
|
64
|
+
|
|
63
65
|
## Basic usage
|
|
64
66
|
|
|
65
67
|
The following examples demonstrate the basic usage of Apify CLI.
|
|
@@ -74,6 +76,8 @@ First, you will be prompted to select a template with the boilerplate for the ac
|
|
|
74
76
|
The command will create a directory called `my-hello-world` that contains a Node.js project
|
|
75
77
|
for the actor and a few configuration files.
|
|
76
78
|
|
|
79
|
+
> If you decided to skip the installation and go with `npx`, the command will be `npx apify-cli create my-hello-world`.
|
|
80
|
+
|
|
77
81
|
### Create a new actor from existing project
|
|
78
82
|
|
|
79
83
|
```bash
|
|
@@ -162,7 +166,7 @@ For example, `.actor/actor.json` file can look as follows:
|
|
|
162
166
|
"readme": "./ACTOR.md",
|
|
163
167
|
"input": "./input_schema.json",
|
|
164
168
|
"storages": {
|
|
165
|
-
"dataset": "./dataset_schema.json"
|
|
169
|
+
"dataset": "./dataset_schema.json"
|
|
166
170
|
}
|
|
167
171
|
}
|
|
168
172
|
```
|
|
@@ -284,7 +288,7 @@ USAGE
|
|
|
284
288
|
$ apify actor
|
|
285
289
|
```
|
|
286
290
|
|
|
287
|
-
_See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
291
|
+
_See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/actor/index.js)_
|
|
288
292
|
|
|
289
293
|
## `apify actor:get-input`
|
|
290
294
|
|
|
@@ -295,7 +299,7 @@ USAGE
|
|
|
295
299
|
$ apify actor:get-input
|
|
296
300
|
```
|
|
297
301
|
|
|
298
|
-
_See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
302
|
+
_See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/actor/get-input.js)_
|
|
299
303
|
|
|
300
304
|
## `apify actor:get-value KEY`
|
|
301
305
|
|
|
@@ -309,7 +313,7 @@ ARGUMENTS
|
|
|
309
313
|
KEY Key of the record in key-value store
|
|
310
314
|
```
|
|
311
315
|
|
|
312
|
-
_See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
316
|
+
_See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/actor/get-value.js)_
|
|
313
317
|
|
|
314
318
|
## `apify actor:push-data [ITEM]`
|
|
315
319
|
|
|
@@ -330,7 +334,7 @@ DESCRIPTION
|
|
|
330
334
|
$ cat ./test.json | apify actor:push-data
|
|
331
335
|
```
|
|
332
336
|
|
|
333
|
-
_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
337
|
+
_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/actor/push-data.js)_
|
|
334
338
|
|
|
335
339
|
## `apify actor:set-value KEY [VALUE]`
|
|
336
340
|
|
|
@@ -360,7 +364,7 @@ DESCRIPTION
|
|
|
360
364
|
$ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain
|
|
361
365
|
```
|
|
362
366
|
|
|
363
|
-
_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
367
|
+
_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/actor/set-value.js)_
|
|
364
368
|
|
|
365
369
|
## `apify call [ACTID]`
|
|
366
370
|
|
|
@@ -385,7 +389,7 @@ DESCRIPTION
|
|
|
385
389
|
takes input for the actor from the default local key-value store by default.
|
|
386
390
|
```
|
|
387
391
|
|
|
388
|
-
_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
392
|
+
_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/call.js)_
|
|
389
393
|
|
|
390
394
|
## `apify create [ACTORNAME]`
|
|
391
395
|
|
|
@@ -407,7 +411,7 @@ OPTIONS
|
|
|
407
411
|
--skip-dependency-install Skip installing actor dependencies.
|
|
408
412
|
```
|
|
409
413
|
|
|
410
|
-
_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
414
|
+
_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/create.js)_
|
|
411
415
|
|
|
412
416
|
## `apify info`
|
|
413
417
|
|
|
@@ -421,7 +425,7 @@ DESCRIPTION
|
|
|
421
425
|
The information is printed to the console.
|
|
422
426
|
```
|
|
423
427
|
|
|
424
|
-
_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
428
|
+
_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/info.js)_
|
|
425
429
|
|
|
426
430
|
## `apify init [ACTORNAME]`
|
|
427
431
|
|
|
@@ -441,7 +445,7 @@ DESCRIPTION
|
|
|
441
445
|
WARNING: The directory at "storage" will be overwritten if it already exists.
|
|
442
446
|
```
|
|
443
447
|
|
|
444
|
-
_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
448
|
+
_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/init.js)_
|
|
445
449
|
|
|
446
450
|
## `apify login`
|
|
447
451
|
|
|
@@ -459,7 +463,7 @@ DESCRIPTION
|
|
|
459
463
|
"apify" commands. To log out, call "apify logout".
|
|
460
464
|
```
|
|
461
465
|
|
|
462
|
-
_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
466
|
+
_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/login.js)_
|
|
463
467
|
|
|
464
468
|
## `apify logout`
|
|
465
469
|
|
|
@@ -474,7 +478,7 @@ DESCRIPTION
|
|
|
474
478
|
call "apify login".
|
|
475
479
|
```
|
|
476
480
|
|
|
477
|
-
_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
481
|
+
_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/logout.js)_
|
|
478
482
|
|
|
479
483
|
## `apify push [ACTORID]`
|
|
480
484
|
|
|
@@ -509,7 +513,7 @@ DESCRIPTION
|
|
|
509
513
|
WARNING: If the target actor already exists in your Apify account, it will be overwritten!
|
|
510
514
|
```
|
|
511
515
|
|
|
512
|
-
_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
516
|
+
_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/push.js)_
|
|
513
517
|
|
|
514
518
|
## `apify run`
|
|
515
519
|
|
|
@@ -539,7 +543,7 @@ DESCRIPTION
|
|
|
539
543
|
You can set up your own main file or environment variables by changing it.
|
|
540
544
|
```
|
|
541
545
|
|
|
542
|
-
_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
546
|
+
_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/run.js)_
|
|
543
547
|
|
|
544
548
|
## `apify secrets`
|
|
545
549
|
|
|
@@ -567,7 +571,7 @@ DESCRIPTION
|
|
|
567
571
|
of the actor.
|
|
568
572
|
```
|
|
569
573
|
|
|
570
|
-
_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
574
|
+
_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/secrets/index.js)_
|
|
571
575
|
|
|
572
576
|
## `apify secrets:add NAME VALUE`
|
|
573
577
|
|
|
@@ -585,7 +589,7 @@ DESCRIPTION
|
|
|
585
589
|
The secrets are stored to a file at ~/.apify
|
|
586
590
|
```
|
|
587
591
|
|
|
588
|
-
_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
592
|
+
_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/secrets/add.js)_
|
|
589
593
|
|
|
590
594
|
## `apify secrets:rm NAME`
|
|
591
595
|
|
|
@@ -599,7 +603,7 @@ ARGUMENTS
|
|
|
599
603
|
NAME Name of the secret
|
|
600
604
|
```
|
|
601
605
|
|
|
602
|
-
_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
606
|
+
_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/secrets/rm.js)_
|
|
603
607
|
|
|
604
608
|
## `apify vis [PATH]`
|
|
605
609
|
|
|
@@ -623,5 +627,5 @@ DESCRIPTION
|
|
|
623
627
|
You can also pass any custom path to your input schema to have it validated instead.
|
|
624
628
|
```
|
|
625
629
|
|
|
626
|
-
_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.14.
|
|
630
|
+
_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.14.2/src/commands/vis.js)_
|
|
627
631
|
<!-- commandsstop -->
|