apify-cli 0.20.7 → 0.21.0-beta.0

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.
Files changed (56) hide show
  1. package/README.md +158 -26
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/commands/builds/create.d.ts +13 -0
  4. package/dist/commands/builds/create.d.ts.map +1 -0
  5. package/dist/commands/builds/create.js +130 -0
  6. package/dist/commands/builds/create.js.map +1 -0
  7. package/dist/commands/builds/index.d.ts +6 -0
  8. package/dist/commands/builds/index.d.ts.map +1 -0
  9. package/dist/commands/builds/index.js +13 -0
  10. package/dist/commands/builds/index.js.map +1 -0
  11. package/dist/commands/builds/info.d.ts +10 -0
  12. package/dist/commands/builds/info.d.ts.map +1 -0
  13. package/dist/commands/builds/info.js +92 -0
  14. package/dist/commands/builds/info.js.map +1 -0
  15. package/dist/commands/builds/log.d.ts +9 -0
  16. package/dist/commands/builds/log.d.ts.map +1 -0
  17. package/dist/commands/builds/log.js +41 -0
  18. package/dist/commands/builds/log.js.map +1 -0
  19. package/dist/commands/builds/ls.d.ts +15 -0
  20. package/dist/commands/builds/ls.d.ts.map +1 -0
  21. package/dist/commands/builds/ls.js +144 -0
  22. package/dist/commands/builds/ls.js.map +1 -0
  23. package/dist/commands/create.js +3 -3
  24. package/dist/commands/run.js +3 -3
  25. package/dist/commands/runs/ls.d.ts +14 -0
  26. package/dist/commands/runs/ls.d.ts.map +1 -0
  27. package/dist/commands/runs/ls.js +117 -0
  28. package/dist/commands/runs/ls.js.map +1 -0
  29. package/dist/lib/apify_command.d.ts.map +1 -1
  30. package/dist/lib/apify_command.js +1 -0
  31. package/dist/lib/apify_command.js.map +1 -1
  32. package/dist/lib/commands/pretty-print-bytes.d.ts +2 -0
  33. package/dist/lib/commands/pretty-print-bytes.d.ts.map +1 -0
  34. package/dist/lib/commands/pretty-print-bytes.js +9 -0
  35. package/dist/lib/commands/pretty-print-bytes.js.map +1 -0
  36. package/dist/lib/commands/pretty-print-status.d.ts +3 -0
  37. package/dist/lib/commands/pretty-print-status.d.ts.map +1 -0
  38. package/dist/lib/commands/pretty-print-status.js +29 -0
  39. package/dist/lib/commands/pretty-print-status.js.map +1 -0
  40. package/dist/lib/commands/resolve-actor-context.d.ts +22 -0
  41. package/dist/lib/commands/resolve-actor-context.d.ts.map +1 -0
  42. package/dist/lib/commands/resolve-actor-context.js +70 -0
  43. package/dist/lib/commands/resolve-actor-context.js.map +1 -0
  44. package/dist/lib/commands/responsive-table.d.ts +23 -0
  45. package/dist/lib/commands/responsive-table.d.ts.map +1 -0
  46. package/dist/lib/commands/responsive-table.js +58 -0
  47. package/dist/lib/commands/responsive-table.js.map +1 -0
  48. package/dist/lib/consts.d.ts +1 -1
  49. package/dist/lib/consts.js +1 -1
  50. package/dist/lib/utils.d.ts +9 -0
  51. package/dist/lib/utils.d.ts.map +1 -1
  52. package/dist/lib/utils.js +45 -0
  53. package/dist/lib/utils.js.map +1 -1
  54. package/dist/typechecking.tsbuildinfo +1 -1
  55. package/oclif.manifest.json +269 -1
  56. package/package.json +5 -2
package/README.md CHANGED
@@ -288,6 +288,11 @@ This section contains printouts of `apify help` for all commands.
288
288
  * [`apify actor push-data [ITEM]`](#apify-actor-push-data-item)
289
289
  * [`apify actor set-value KEY [VALUE]`](#apify-actor-set-value-key-value)
290
290
  * [`apify actors`](#apify-actors)
291
+ * [`apify builds`](#apify-builds)
292
+ * [`apify builds create`](#apify-builds-create)
293
+ * [`apify builds info BUILDID`](#apify-builds-info-buildid)
294
+ * [`apify builds log BUILDID`](#apify-builds-log-buildid)
295
+ * [`apify builds ls`](#apify-builds-ls)
291
296
  * [`apify call [ACTORID]`](#apify-call-actorid)
292
297
  * [`apify create [ACTORNAME]`](#apify-create-actorname)
293
298
  * [`apify datasets`](#apify-datasets)
@@ -302,6 +307,7 @@ This section contains printouts of `apify help` for all commands.
302
307
  * [`apify request-queues`](#apify-request-queues)
303
308
  * [`apify run`](#apify-run)
304
309
  * [`apify runs`](#apify-runs)
310
+ * [`apify runs ls`](#apify-runs-ls)
305
311
  * [`apify secrets`](#apify-secrets)
306
312
  * [`apify secrets add NAME VALUE`](#apify-secrets-add-name-value)
307
313
  * [`apify secrets rm NAME`](#apify-secrets-rm-name)
@@ -321,7 +327,7 @@ DESCRIPTION
321
327
  Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
322
328
  ```
323
329
 
324
- _See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/actor/index.ts)_
330
+ _See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/actor/index.ts)_
325
331
 
326
332
  ## `apify actor get-input`
327
333
 
@@ -335,7 +341,7 @@ DESCRIPTION
335
341
  Gets the Actor input value from the default key-value store associated with the Actor run.
336
342
  ```
337
343
 
338
- _See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/actor/get-input.ts)_
344
+ _See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/actor/get-input.ts)_
339
345
 
340
346
  ## `apify actor get-value KEY`
341
347
 
@@ -352,7 +358,7 @@ DESCRIPTION
352
358
  Gets a value from the default key-value store associated with the Actor run.
353
359
  ```
354
360
 
355
- _See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/actor/get-value.ts)_
361
+ _See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/actor/get-value.ts)_
356
362
 
357
363
  ## `apify actor push-data [ITEM]`
358
364
 
@@ -374,7 +380,7 @@ DESCRIPTION
374
380
  $ cat ./test.json | apify actor push-data
375
381
  ```
376
382
 
377
- _See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/actor/push-data.ts)_
383
+ _See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/actor/push-data.ts)_
378
384
 
379
385
  ## `apify actor set-value KEY [VALUE]`
380
386
 
@@ -403,7 +409,7 @@ DESCRIPTION
403
409
  $ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
404
410
  ```
405
411
 
406
- _See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/actor/set-value.ts)_
412
+ _See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/actor/set-value.ts)_
407
413
 
408
414
  ## `apify actors`
409
415
 
@@ -417,7 +423,108 @@ DESCRIPTION
417
423
  Commands are designed to be used with Actors.
418
424
  ```
419
425
 
420
- _See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/actors/index.ts)_
426
+ _See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/actors/index.ts)_
427
+
428
+ ## `apify builds`
429
+
430
+ Commands are designed to be used with Actor Builds.
431
+
432
+ ```
433
+ USAGE
434
+ $ apify builds
435
+
436
+ DESCRIPTION
437
+ Commands are designed to be used with Actor Builds.
438
+ ```
439
+
440
+ _See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/builds/index.ts)_
441
+
442
+ ## `apify builds create`
443
+
444
+ Creates a new build of the Actor.
445
+
446
+ ```
447
+ USAGE
448
+ $ apify builds create [--json] [--actor <value>] [--tag <value>] [--version <value>] [--log]
449
+
450
+ FLAGS
451
+ --actor=<value> Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the
452
+ current directory.
453
+ --log Whether to print out the build log after the build is triggered.
454
+ --tag=<value> Build tag to be applied to the successful Actor build. By default, this is "latest".
455
+ --version=<value> Optional Actor Version to build. By default, this will be inferred from the tag, but this flag is
456
+ required when multiple versions have the same tag.
457
+
458
+ GLOBAL FLAGS
459
+ --json Format output as json.
460
+
461
+ DESCRIPTION
462
+ Creates a new build of the Actor.
463
+ ```
464
+
465
+ _See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/builds/create.ts)_
466
+
467
+ ## `apify builds info BUILDID`
468
+
469
+ Prints information about a specific build.
470
+
471
+ ```
472
+ USAGE
473
+ $ apify builds info BUILDID [--json]
474
+
475
+ ARGUMENTS
476
+ BUILDID The build ID to get information about.
477
+
478
+ GLOBAL FLAGS
479
+ --json Format output as json.
480
+
481
+ DESCRIPTION
482
+ Prints information about a specific build.
483
+ ```
484
+
485
+ _See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/builds/info.ts)_
486
+
487
+ ## `apify builds log BUILDID`
488
+
489
+ Prints the log of a specific build.
490
+
491
+ ```
492
+ USAGE
493
+ $ apify builds log BUILDID
494
+
495
+ ARGUMENTS
496
+ BUILDID The build ID to get the log from.
497
+
498
+ DESCRIPTION
499
+ Prints the log of a specific build.
500
+ ```
501
+
502
+ _See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/builds/log.ts)_
503
+
504
+ ## `apify builds ls`
505
+
506
+ Lists all builds of the Actor.
507
+
508
+ ```
509
+ USAGE
510
+ $ apify builds ls [--json] [--actor <value>] [--offset <value>] [--limit <value>] [--desc] [-c]
511
+
512
+ FLAGS
513
+ -c, --compact Display a compact table.
514
+ --actor=<value> Optional Actor ID or Name to list builds for. By default, it will use the Actor from the current
515
+ directory.
516
+ --desc Sort builds in descending order.
517
+ --limit=<value> [default: 10] Number of builds that will be listed.
518
+ --offset=<value> Number of builds that will be skipped.
519
+
520
+ GLOBAL FLAGS
521
+ --json Format output as json.
522
+
523
+ DESCRIPTION
524
+ Lists all builds of the Actor.
525
+ ```
526
+
527
+ _See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/builds/ls.ts)_
421
528
 
422
529
  ## `apify call [ACTORID]`
423
530
 
@@ -449,7 +556,7 @@ DESCRIPTION
449
556
  takes input for the Actor from the default local key-value store by default.
450
557
  ```
451
558
 
452
- _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/call.ts)_
559
+ _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/call.ts)_
453
560
 
454
561
  ## `apify create [ACTORNAME]`
455
562
 
@@ -474,7 +581,7 @@ DESCRIPTION
474
581
  Creates a new Actor project directory from a selected boilerplate template.
475
582
  ```
476
583
 
477
- _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/create.ts)_
584
+ _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/create.ts)_
478
585
 
479
586
  ## `apify datasets`
480
587
 
@@ -488,7 +595,7 @@ DESCRIPTION
488
595
  Commands are designed to be used with Datasets.
489
596
  ```
490
597
 
491
- _See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/datasets/index.ts)_
598
+ _See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/datasets/index.ts)_
492
599
 
493
600
  ## `apify help [COMMAND]`
494
601
 
@@ -508,7 +615,7 @@ DESCRIPTION
508
615
  Display help for apify.
509
616
  ```
510
617
 
511
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.10/src/commands/help.ts)_
618
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.11/src/commands/help.ts)_
512
619
 
513
620
  ## `apify info`
514
621
 
@@ -523,7 +630,7 @@ DESCRIPTION
523
630
  The information is printed to the console.
524
631
  ```
525
632
 
526
- _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/info.ts)_
633
+ _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/info.ts)_
527
634
 
528
635
  ## `apify init [ACTORNAME]`
529
636
 
@@ -551,7 +658,7 @@ DESCRIPTION
551
658
  WARNING: The directory at "storage" will be overwritten if it already exists.
552
659
  ```
553
660
 
554
- _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/init.ts)_
661
+ _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/init.ts)_
555
662
 
556
663
  ## `apify key-value-stores`
557
664
 
@@ -565,7 +672,7 @@ DESCRIPTION
565
672
  Commands are designed to be used with Key Value Stores.
566
673
  ```
567
674
 
568
- _See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/key-value-stores/index.ts)_
675
+ _See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/key-value-stores/index.ts)_
569
676
 
570
677
  ## `apify login`
571
678
 
@@ -586,7 +693,7 @@ DESCRIPTION
586
693
  "apify" commands. To log out, call "apify logout".
587
694
  ```
588
695
 
589
- _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/login.ts)_
696
+ _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/login.ts)_
590
697
 
591
698
  ## `apify logout`
592
699
 
@@ -602,7 +709,7 @@ DESCRIPTION
602
709
  call "apify login".
603
710
  ```
604
711
 
605
- _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/logout.ts)_
712
+ _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/logout.ts)_
606
713
 
607
714
  ## `apify pull [ACTORID]`
608
715
 
@@ -624,7 +731,7 @@ DESCRIPTION
624
731
  cloned. If it is defined as Web IDE, it will fetch the files.
625
732
  ```
626
733
 
627
- _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/pull.ts)_
734
+ _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/pull.ts)_
628
735
 
629
736
  ## `apify push [ACTORID]`
630
737
 
@@ -662,7 +769,7 @@ DESCRIPTION
662
769
  overwritten with --force flag.
663
770
  ```
664
771
 
665
- _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/push.ts)_
772
+ _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/push.ts)_
666
773
 
667
774
  ## `apify request-queues`
668
775
 
@@ -676,7 +783,7 @@ DESCRIPTION
676
783
  Commands are designed to be used with Request Queues.
677
784
  ```
678
785
 
679
- _See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/request-queues/index.ts)_
786
+ _See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/request-queues/index.ts)_
680
787
 
681
788
  ## `apify run`
682
789
 
@@ -712,7 +819,7 @@ DESCRIPTION
712
819
  package.json file. You can set up your own main file or environment variables by changing it.
713
820
  ```
714
821
 
715
- _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/run.ts)_
822
+ _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/run.ts)_
716
823
 
717
824
  ## `apify runs`
718
825
 
@@ -726,7 +833,32 @@ DESCRIPTION
726
833
  Commands are designed to be used with Actor Runs.
727
834
  ```
728
835
 
729
- _See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/runs/index.ts)_
836
+ _See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/runs/index.ts)_
837
+
838
+ ## `apify runs ls`
839
+
840
+ Lists all runs of the Actor.
841
+
842
+ ```
843
+ USAGE
844
+ $ apify runs ls [--json] [--actor <value>] [--offset <value>] [--limit <value>] [--desc] [-c]
845
+
846
+ FLAGS
847
+ -c, --compact Display a compact table.
848
+ --actor=<value> Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current
849
+ directory.
850
+ --desc Sort runs in descending order.
851
+ --limit=<value> [default: 10] Number of runs that will be listed.
852
+ --offset=<value> Number of runs that will be skipped.
853
+
854
+ GLOBAL FLAGS
855
+ --json Format output as json.
856
+
857
+ DESCRIPTION
858
+ Lists all runs of the Actor.
859
+ ```
860
+
861
+ _See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/runs/ls.ts)_
730
862
 
731
863
  ## `apify secrets`
732
864
 
@@ -756,7 +888,7 @@ DESCRIPTION
756
888
  of the Actor.
757
889
  ```
758
890
 
759
- _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/secrets/index.ts)_
891
+ _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/secrets/index.ts)_
760
892
 
761
893
  ## `apify secrets add NAME VALUE`
762
894
 
@@ -775,7 +907,7 @@ DESCRIPTION
775
907
  The secrets are stored to a file at ~/.apify
776
908
  ```
777
909
 
778
- _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/secrets/add.ts)_
910
+ _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/secrets/add.ts)_
779
911
 
780
912
  ## `apify secrets rm NAME`
781
913
 
@@ -792,7 +924,7 @@ DESCRIPTION
792
924
  Removes the secret.
793
925
  ```
794
926
 
795
- _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/secrets/rm.ts)_
927
+ _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/secrets/rm.ts)_
796
928
 
797
929
  ## `apify task`
798
930
 
@@ -806,7 +938,7 @@ DESCRIPTION
806
938
  Commands are designed to be used to interact with Tasks.
807
939
  ```
808
940
 
809
- _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/task/index.ts)_
941
+ _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/task/index.ts)_
810
942
 
811
943
  ## `apify task run TASKID`
812
944
 
@@ -831,7 +963,7 @@ DESCRIPTION
831
963
  takes input for the Actor from the default local key-value store by default.
832
964
  ```
833
965
 
834
- _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/task/run.ts)_
966
+ _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/task/run.ts)_
835
967
 
836
968
  ## `apify validate-schema [PATH]`
837
969
 
@@ -856,6 +988,6 @@ DESCRIPTION
856
988
  You can also pass any custom path to your input schema to have it validated instead.
857
989
  ```
858
990
 
859
- _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.20.7/src/commands/validate-schema.ts)_
991
+ _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.0/src/commands/validate-schema.ts)_
860
992
  <!-- commandsstop -->
861
993
  <!-- prettier-ignore-end -->