apify-cli 1.0.0-beta.112 → 1.0.0-beta.113
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 +26 -21
- package/dist/.tsbuildinfo +1 -1
- package/dist/commands/run.d.ts +3 -0
- package/dist/commands/run.d.ts.map +1 -1
- package/dist/commands/run.js +190 -64
- package/dist/commands/run.js.map +1 -1
- package/dist/lib/consts.d.ts +2 -1
- package/dist/lib/consts.d.ts.map +1 -1
- package/dist/lib/consts.js +1 -0
- package/dist/lib/consts.js.map +1 -1
- package/dist/lib/input_schema.d.ts +2 -0
- package/dist/lib/input_schema.d.ts.map +1 -1
- package/dist/lib/input_schema.js +34 -1
- package/dist/lib/input_schema.js.map +1 -1
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +2 -0
- package/dist/lib/utils.js.map +1 -1
- package/oclif.manifest.json +27 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -309,7 +309,7 @@ DESCRIPTION
|
|
|
309
309
|
Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
|
|
310
310
|
```
|
|
311
311
|
|
|
312
|
-
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
312
|
+
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/actor/index.ts)_
|
|
313
313
|
|
|
314
314
|
## `apify actor get-input`
|
|
315
315
|
|
|
@@ -323,7 +323,7 @@ DESCRIPTION
|
|
|
323
323
|
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
324
324
|
```
|
|
325
325
|
|
|
326
|
-
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
326
|
+
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/actor/get-input.ts)_
|
|
327
327
|
|
|
328
328
|
## `apify actor get-value KEY`
|
|
329
329
|
|
|
@@ -340,7 +340,7 @@ DESCRIPTION
|
|
|
340
340
|
Gets a value from the default key-value store associated with the Actor run.
|
|
341
341
|
```
|
|
342
342
|
|
|
343
|
-
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
343
|
+
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/actor/get-value.ts)_
|
|
344
344
|
|
|
345
345
|
## `apify actor push-data [ITEM]`
|
|
346
346
|
|
|
@@ -362,7 +362,7 @@ DESCRIPTION
|
|
|
362
362
|
$ cat ./test.json | apify actor push-data
|
|
363
363
|
```
|
|
364
364
|
|
|
365
|
-
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
365
|
+
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/actor/push-data.ts)_
|
|
366
366
|
|
|
367
367
|
## `apify actor set-value KEY [VALUE]`
|
|
368
368
|
|
|
@@ -391,7 +391,7 @@ DESCRIPTION
|
|
|
391
391
|
$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
|
|
392
392
|
```
|
|
393
393
|
|
|
394
|
-
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
394
|
+
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/actor/set-value.ts)_
|
|
395
395
|
|
|
396
396
|
## `apify call [ACTORID]`
|
|
397
397
|
|
|
@@ -417,7 +417,7 @@ DESCRIPTION
|
|
|
417
417
|
takes input for the Actor from the default local key-value store by default.
|
|
418
418
|
```
|
|
419
419
|
|
|
420
|
-
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
420
|
+
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/call.ts)_
|
|
421
421
|
|
|
422
422
|
## `apify create [ACTORNAME]`
|
|
423
423
|
|
|
@@ -442,7 +442,7 @@ DESCRIPTION
|
|
|
442
442
|
Creates a new Actor project directory from a selected boilerplate template.
|
|
443
443
|
```
|
|
444
444
|
|
|
445
|
-
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
445
|
+
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/create.ts)_
|
|
446
446
|
|
|
447
447
|
## `apify help [COMMAND]`
|
|
448
448
|
|
|
@@ -477,7 +477,7 @@ DESCRIPTION
|
|
|
477
477
|
The information is printed to the console.
|
|
478
478
|
```
|
|
479
479
|
|
|
480
|
-
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
480
|
+
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/info.ts)_
|
|
481
481
|
|
|
482
482
|
## `apify init [ACTORNAME]`
|
|
483
483
|
|
|
@@ -505,7 +505,7 @@ DESCRIPTION
|
|
|
505
505
|
WARNING: The directory at "storage" will be overwritten if it already exists.
|
|
506
506
|
```
|
|
507
507
|
|
|
508
|
-
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
508
|
+
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/init.ts)_
|
|
509
509
|
|
|
510
510
|
## `apify login`
|
|
511
511
|
|
|
@@ -526,7 +526,7 @@ DESCRIPTION
|
|
|
526
526
|
"apify" commands. To log out, call "apify logout".
|
|
527
527
|
```
|
|
528
528
|
|
|
529
|
-
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
529
|
+
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/login.ts)_
|
|
530
530
|
|
|
531
531
|
## `apify logout`
|
|
532
532
|
|
|
@@ -542,7 +542,7 @@ DESCRIPTION
|
|
|
542
542
|
call "apify login".
|
|
543
543
|
```
|
|
544
544
|
|
|
545
|
-
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
545
|
+
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/logout.ts)_
|
|
546
546
|
|
|
547
547
|
## `apify pull [ACTORID]`
|
|
548
548
|
|
|
@@ -564,7 +564,7 @@ DESCRIPTION
|
|
|
564
564
|
cloned. If it is defined as Web IDE, it will fetch the files.
|
|
565
565
|
```
|
|
566
566
|
|
|
567
|
-
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
567
|
+
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/pull.ts)_
|
|
568
568
|
|
|
569
569
|
## `apify push [ACTORID]`
|
|
570
570
|
|
|
@@ -602,7 +602,7 @@ DESCRIPTION
|
|
|
602
602
|
overwritten with --force flag.
|
|
603
603
|
```
|
|
604
604
|
|
|
605
|
-
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
605
|
+
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/push.ts)_
|
|
606
606
|
|
|
607
607
|
## `apify run`
|
|
608
608
|
|
|
@@ -610,15 +610,20 @@ Runs the Actor locally in the current directory.
|
|
|
610
610
|
|
|
611
611
|
```
|
|
612
612
|
USAGE
|
|
613
|
-
$ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store] [--entrypoint <value>]
|
|
613
|
+
$ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store] [--entrypoint <value>] [-i
|
|
614
|
+
<value> | --input-file <value>]
|
|
614
615
|
|
|
615
616
|
FLAGS
|
|
617
|
+
-i, --input=<value> Optional JSON input to be given to the Actor. You can either provide the JSON string as a
|
|
618
|
+
value to this, or `-` to read from standard input.
|
|
616
619
|
-p, --purge Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store
|
|
617
620
|
options.
|
|
618
621
|
--entrypoint=<value> Optional entrypoint for running with injected environment variables.
|
|
619
622
|
For Python, it is the module name, or a path to a file.
|
|
620
623
|
For node.js, it is the npm script name, or a path to a JS/MJS file. You can also pass in
|
|
621
624
|
a directory name, provided that directory contains an "index.js" file.
|
|
625
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a
|
|
626
|
+
valid JSON file.
|
|
622
627
|
--purge-dataset Deletes the local directory containing the default dataset before the run starts.
|
|
623
628
|
--purge-key-value-store Deletes all records from the default key-value store in the local directory before the
|
|
624
629
|
run starts, except for the "INPUT" key.
|
|
@@ -634,7 +639,7 @@ DESCRIPTION
|
|
|
634
639
|
package.json file. You can set up your own main file or environment variables by changing it.
|
|
635
640
|
```
|
|
636
641
|
|
|
637
|
-
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
642
|
+
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/run.ts)_
|
|
638
643
|
|
|
639
644
|
## `apify secrets`
|
|
640
645
|
|
|
@@ -664,7 +669,7 @@ DESCRIPTION
|
|
|
664
669
|
of the Actor.
|
|
665
670
|
```
|
|
666
671
|
|
|
667
|
-
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
672
|
+
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/secrets/index.ts)_
|
|
668
673
|
|
|
669
674
|
## `apify secrets add NAME VALUE`
|
|
670
675
|
|
|
@@ -683,7 +688,7 @@ DESCRIPTION
|
|
|
683
688
|
The secrets are stored to a file at ~/.apify
|
|
684
689
|
```
|
|
685
690
|
|
|
686
|
-
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
691
|
+
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/secrets/add.ts)_
|
|
687
692
|
|
|
688
693
|
## `apify secrets rm NAME`
|
|
689
694
|
|
|
@@ -700,7 +705,7 @@ DESCRIPTION
|
|
|
700
705
|
Removes the secret.
|
|
701
706
|
```
|
|
702
707
|
|
|
703
|
-
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
708
|
+
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/secrets/rm.ts)_
|
|
704
709
|
|
|
705
710
|
## `apify task`
|
|
706
711
|
|
|
@@ -714,7 +719,7 @@ DESCRIPTION
|
|
|
714
719
|
Commands are designed to be used to interact with Tasks.
|
|
715
720
|
```
|
|
716
721
|
|
|
717
|
-
_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
722
|
+
_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/task/index.ts)_
|
|
718
723
|
|
|
719
724
|
## `apify task run TASKID`
|
|
720
725
|
|
|
@@ -739,7 +744,7 @@ DESCRIPTION
|
|
|
739
744
|
takes input for the Actor from the default local key-value store by default.
|
|
740
745
|
```
|
|
741
746
|
|
|
742
|
-
_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
747
|
+
_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/task/run.ts)_
|
|
743
748
|
|
|
744
749
|
## `apify validate-schema [PATH]`
|
|
745
750
|
|
|
@@ -764,5 +769,5 @@ DESCRIPTION
|
|
|
764
769
|
You can also pass any custom path to your input schema to have it validated instead.
|
|
765
770
|
```
|
|
766
771
|
|
|
767
|
-
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
772
|
+
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.113/src/commands/validate-schema.ts)_
|
|
768
773
|
<!-- commandsstop -->
|