apify-cli 0.21.0-beta.10 → 0.21.0-beta.11

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 CHANGED
@@ -289,6 +289,7 @@ This section contains printouts of `apify help` for all commands.
289
289
  * [`apify actor set-value KEY [VALUE]`](#apify-actor-set-value-key-value)
290
290
  * [`apify actors`](#apify-actors)
291
291
  * [`apify actors build [ACTOR]`](#apify-actors-build-actor)
292
+ * [`apify actors pull [ACTORID]`](#apify-actors-pull-actorid)
292
293
  * [`apify actors rm ACTORID`](#apify-actors-rm-actorid)
293
294
  * [`apify builds`](#apify-builds)
294
295
  * [`apify builds create [ACTOR]`](#apify-builds-create-actor)
@@ -335,7 +336,7 @@ DESCRIPTION
335
336
  Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
336
337
  ```
337
338
 
338
- _See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actor/index.ts)_
339
+ _See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actor/index.ts)_
339
340
 
340
341
  ## `apify actor get-input`
341
342
 
@@ -349,7 +350,7 @@ DESCRIPTION
349
350
  Gets the Actor input value from the default key-value store associated with the Actor run.
350
351
  ```
351
352
 
352
- _See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actor/get-input.ts)_
353
+ _See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actor/get-input.ts)_
353
354
 
354
355
  ## `apify actor get-value KEY`
355
356
 
@@ -366,7 +367,7 @@ DESCRIPTION
366
367
  Gets a value from the default key-value store associated with the Actor run.
367
368
  ```
368
369
 
369
- _See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actor/get-value.ts)_
370
+ _See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actor/get-value.ts)_
370
371
 
371
372
  ## `apify actor push-data [ITEM]`
372
373
 
@@ -388,7 +389,7 @@ DESCRIPTION
388
389
  $ cat ./test.json | apify actor push-data
389
390
  ```
390
391
 
391
- _See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actor/push-data.ts)_
392
+ _See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actor/push-data.ts)_
392
393
 
393
394
  ## `apify actor set-value KEY [VALUE]`
394
395
 
@@ -417,7 +418,7 @@ DESCRIPTION
417
418
  $ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
418
419
  ```
419
420
 
420
- _See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actor/set-value.ts)_
421
+ _See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actor/set-value.ts)_
421
422
 
422
423
  ## `apify actors`
423
424
 
@@ -431,7 +432,7 @@ DESCRIPTION
431
432
  Commands are designed to be used with Actors.
432
433
  ```
433
434
 
434
- _See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actors/index.ts)_
435
+ _See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actors/index.ts)_
435
436
 
436
437
  ## `apify actors build [ACTOR]`
437
438
 
@@ -457,7 +458,30 @@ DESCRIPTION
457
458
  Creates a new build of the Actor.
458
459
  ```
459
460
 
460
- _See code: [src/commands/actors/build.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actors/build.ts)_
461
+ _See code: [src/commands/actors/build.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actors/build.ts)_
462
+
463
+ ## `apify actors pull [ACTORID]`
464
+
465
+ Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be cloned. If it is defined as Web IDE, it will fetch the files.
466
+
467
+ ```
468
+ USAGE
469
+ $ apify actors pull [ACTORID] [-v <value>] [--dir <value>]
470
+
471
+ ARGUMENTS
472
+ ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
473
+ command will update the Actor in the current directory based on its name in ".actor/actor.json" file.
474
+
475
+ FLAGS
476
+ -v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
477
+ --dir=<value> Directory where the Actor should be pulled to
478
+
479
+ DESCRIPTION
480
+ Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
481
+ cloned. If it is defined as Web IDE, it will fetch the files.
482
+ ```
483
+
484
+ _See code: [src/commands/actors/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actors/pull.ts)_
461
485
 
462
486
  ## `apify actors rm ACTORID`
463
487
 
@@ -474,7 +498,7 @@ DESCRIPTION
474
498
  Deletes an Actor.
475
499
  ```
476
500
 
477
- _See code: [src/commands/actors/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/actors/rm.ts)_
501
+ _See code: [src/commands/actors/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/actors/rm.ts)_
478
502
 
479
503
  ## `apify builds`
480
504
 
@@ -488,7 +512,7 @@ DESCRIPTION
488
512
  Commands are designed to be used with Actor Builds.
489
513
  ```
490
514
 
491
- _See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/builds/index.ts)_
515
+ _See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/builds/index.ts)_
492
516
 
493
517
  ## `apify builds create [ACTOR]`
494
518
 
@@ -514,7 +538,7 @@ DESCRIPTION
514
538
  Creates a new build of the Actor.
515
539
  ```
516
540
 
517
- _See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/builds/create.ts)_
541
+ _See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/builds/create.ts)_
518
542
 
519
543
  ## `apify builds info BUILDID`
520
544
 
@@ -534,7 +558,7 @@ DESCRIPTION
534
558
  Prints information about a specific build.
535
559
  ```
536
560
 
537
- _See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/builds/info.ts)_
561
+ _See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/builds/info.ts)_
538
562
 
539
563
  ## `apify builds log BUILDID`
540
564
 
@@ -551,7 +575,7 @@ DESCRIPTION
551
575
  Prints the log of a specific build.
552
576
  ```
553
577
 
554
- _See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/builds/log.ts)_
578
+ _See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/builds/log.ts)_
555
579
 
556
580
  ## `apify builds ls`
557
581
 
@@ -576,7 +600,7 @@ DESCRIPTION
576
600
  Lists all builds of the Actor.
577
601
  ```
578
602
 
579
- _See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/builds/ls.ts)_
603
+ _See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/builds/ls.ts)_
580
604
 
581
605
  ## `apify builds rm BUILDID`
582
606
 
@@ -593,7 +617,7 @@ DESCRIPTION
593
617
  Deletes an Actor Build.
594
618
  ```
595
619
 
596
- _See code: [src/commands/builds/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/builds/rm.ts)_
620
+ _See code: [src/commands/builds/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/builds/rm.ts)_
597
621
 
598
622
  ## `apify call [ACTORID]`
599
623
 
@@ -625,7 +649,7 @@ DESCRIPTION
625
649
  takes input for the Actor from the default local key-value store by default.
626
650
  ```
627
651
 
628
- _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/call.ts)_
652
+ _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/call.ts)_
629
653
 
630
654
  ## `apify create [ACTORNAME]`
631
655
 
@@ -650,7 +674,7 @@ DESCRIPTION
650
674
  Creates a new Actor project directory from a selected boilerplate template.
651
675
  ```
652
676
 
653
- _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/create.ts)_
677
+ _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/create.ts)_
654
678
 
655
679
  ## `apify datasets`
656
680
 
@@ -664,7 +688,7 @@ DESCRIPTION
664
688
  Commands are designed to be used with Datasets.
665
689
  ```
666
690
 
667
- _See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/datasets/index.ts)_
691
+ _See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/datasets/index.ts)_
668
692
 
669
693
  ## `apify help [COMMAND]`
670
694
 
@@ -699,7 +723,7 @@ DESCRIPTION
699
723
  The information is printed to the console.
700
724
  ```
701
725
 
702
- _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/info.ts)_
726
+ _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/info.ts)_
703
727
 
704
728
  ## `apify init [ACTORNAME]`
705
729
 
@@ -727,7 +751,7 @@ DESCRIPTION
727
751
  WARNING: The directory at "storage" will be overwritten if it already exists.
728
752
  ```
729
753
 
730
- _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/init.ts)_
754
+ _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/init.ts)_
731
755
 
732
756
  ## `apify key-value-stores`
733
757
 
@@ -741,7 +765,7 @@ DESCRIPTION
741
765
  Commands are designed to be used with Key Value Stores.
742
766
  ```
743
767
 
744
- _See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/key-value-stores/index.ts)_
768
+ _See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/key-value-stores/index.ts)_
745
769
 
746
770
  ## `apify login`
747
771
 
@@ -762,7 +786,7 @@ DESCRIPTION
762
786
  "apify" commands. To log out, call "apify logout".
763
787
  ```
764
788
 
765
- _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/login.ts)_
789
+ _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/login.ts)_
766
790
 
767
791
  ## `apify logout`
768
792
 
@@ -778,7 +802,7 @@ DESCRIPTION
778
802
  call "apify login".
779
803
  ```
780
804
 
781
- _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/logout.ts)_
805
+ _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/logout.ts)_
782
806
 
783
807
  ## `apify pull [ACTORID]`
784
808
 
@@ -786,7 +810,7 @@ Pulls an Actor from the Apify platform to the current directory. If it is define
786
810
 
787
811
  ```
788
812
  USAGE
789
- $ apify pull [ACTORID] [-v <value>]
813
+ $ apify pull [ACTORID] [-v <value>] [--dir <value>]
790
814
 
791
815
  ARGUMENTS
792
816
  ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
@@ -794,13 +818,14 @@ ARGUMENTS
794
818
 
795
819
  FLAGS
796
820
  -v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
821
+ --dir=<value> Directory where the Actor should be pulled to
797
822
 
798
823
  DESCRIPTION
799
824
  Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
800
825
  cloned. If it is defined as Web IDE, it will fetch the files.
801
826
  ```
802
827
 
803
- _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/pull.ts)_
828
+ _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/pull.ts)_
804
829
 
805
830
  ## `apify push [ACTORID]`
806
831
 
@@ -838,7 +863,7 @@ DESCRIPTION
838
863
  overwritten with --force flag.
839
864
  ```
840
865
 
841
- _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/push.ts)_
866
+ _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/push.ts)_
842
867
 
843
868
  ## `apify request-queues`
844
869
 
@@ -852,7 +877,7 @@ DESCRIPTION
852
877
  Commands are designed to be used with Request Queues.
853
878
  ```
854
879
 
855
- _See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/request-queues/index.ts)_
880
+ _See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/request-queues/index.ts)_
856
881
 
857
882
  ## `apify run`
858
883
 
@@ -888,7 +913,7 @@ DESCRIPTION
888
913
  package.json file. You can set up your own main file or environment variables by changing it.
889
914
  ```
890
915
 
891
- _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/run.ts)_
916
+ _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/run.ts)_
892
917
 
893
918
  ## `apify runs`
894
919
 
@@ -902,7 +927,7 @@ DESCRIPTION
902
927
  Commands are designed to be used with Actor Runs.
903
928
  ```
904
929
 
905
- _See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/runs/index.ts)_
930
+ _See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/runs/index.ts)_
906
931
 
907
932
  ## `apify runs abort RUNID`
908
933
 
@@ -925,7 +950,7 @@ DESCRIPTION
925
950
  Aborts an Actor Run.
926
951
  ```
927
952
 
928
- _See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/runs/abort.ts)_
953
+ _See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/runs/abort.ts)_
929
954
 
930
955
  ## `apify runs info RUNID`
931
956
 
@@ -948,7 +973,7 @@ DESCRIPTION
948
973
  Prints information about an Actor Run.
949
974
  ```
950
975
 
951
- _See code: [src/commands/runs/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/runs/info.ts)_
976
+ _See code: [src/commands/runs/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/runs/info.ts)_
952
977
 
953
978
  ## `apify runs log RUNID`
954
979
 
@@ -965,7 +990,7 @@ DESCRIPTION
965
990
  Prints the log of a specific run.
966
991
  ```
967
992
 
968
- _See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/runs/log.ts)_
993
+ _See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/runs/log.ts)_
969
994
 
970
995
  ## `apify runs ls`
971
996
 
@@ -990,7 +1015,7 @@ DESCRIPTION
990
1015
  Lists all runs of the Actor.
991
1016
  ```
992
1017
 
993
- _See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/runs/ls.ts)_
1018
+ _See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/runs/ls.ts)_
994
1019
 
995
1020
  ## `apify runs resurrect RUNID`
996
1021
 
@@ -1010,7 +1035,7 @@ DESCRIPTION
1010
1035
  Resurrects an aborted or finished Actor Run.
1011
1036
  ```
1012
1037
 
1013
- _See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/runs/resurrect.ts)_
1038
+ _See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/runs/resurrect.ts)_
1014
1039
 
1015
1040
  ## `apify runs rm RUNID`
1016
1041
 
@@ -1027,7 +1052,7 @@ DESCRIPTION
1027
1052
  Deletes an Actor Run.
1028
1053
  ```
1029
1054
 
1030
- _See code: [src/commands/runs/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/runs/rm.ts)_
1055
+ _See code: [src/commands/runs/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/runs/rm.ts)_
1031
1056
 
1032
1057
  ## `apify secrets`
1033
1058
 
@@ -1057,7 +1082,7 @@ DESCRIPTION
1057
1082
  of the Actor.
1058
1083
  ```
1059
1084
 
1060
- _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/secrets/index.ts)_
1085
+ _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/secrets/index.ts)_
1061
1086
 
1062
1087
  ## `apify secrets add NAME VALUE`
1063
1088
 
@@ -1076,7 +1101,7 @@ DESCRIPTION
1076
1101
  The secrets are stored to a file at ~/.apify
1077
1102
  ```
1078
1103
 
1079
- _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/secrets/add.ts)_
1104
+ _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/secrets/add.ts)_
1080
1105
 
1081
1106
  ## `apify secrets rm NAME`
1082
1107
 
@@ -1093,7 +1118,7 @@ DESCRIPTION
1093
1118
  Removes the secret.
1094
1119
  ```
1095
1120
 
1096
- _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/secrets/rm.ts)_
1121
+ _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/secrets/rm.ts)_
1097
1122
 
1098
1123
  ## `apify task`
1099
1124
 
@@ -1107,7 +1132,7 @@ DESCRIPTION
1107
1132
  Commands are designed to be used to interact with Tasks.
1108
1133
  ```
1109
1134
 
1110
- _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/task/index.ts)_
1135
+ _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/task/index.ts)_
1111
1136
 
1112
1137
  ## `apify task run TASKID`
1113
1138
 
@@ -1132,7 +1157,7 @@ DESCRIPTION
1132
1157
  takes input for the Actor from the default local key-value store by default.
1133
1158
  ```
1134
1159
 
1135
- _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/task/run.ts)_
1160
+ _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/task/run.ts)_
1136
1161
 
1137
1162
  ## `apify validate-schema [PATH]`
1138
1163
 
@@ -1157,6 +1182,6 @@ DESCRIPTION
1157
1182
  You can also pass any custom path to your input schema to have it validated instead.
1158
1183
  ```
1159
1184
 
1160
- _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.10/src/commands/validate-schema.ts)_
1185
+ _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.11/src/commands/validate-schema.ts)_
1161
1186
  <!-- commandsstop -->
1162
1187
  <!-- prettier-ignore-end -->