apify-cli 1.0.0-beta.98 → 1.0.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 (61) hide show
  1. package/README.md +33 -24
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/commands/actor/get-value.d.ts +1 -1
  4. package/dist/commands/actor/push-data.d.ts +1 -1
  5. package/dist/commands/actor/set-value.d.ts +3 -3
  6. package/dist/commands/call.d.ts +8 -5
  7. package/dist/commands/call.d.ts.map +1 -1
  8. package/dist/commands/call.js +88 -3
  9. package/dist/commands/call.js.map +1 -1
  10. package/dist/commands/check-version.d.ts +1 -1
  11. package/dist/commands/create.d.ts +5 -5
  12. package/dist/commands/edit-input-schema.d.ts +1 -1
  13. package/dist/commands/init-wrap-scrapy.d.ts +1 -1
  14. package/dist/commands/init.d.ts +2 -2
  15. package/dist/commands/login.d.ts +2 -2
  16. package/dist/commands/login.js +3 -3
  17. package/dist/commands/login.js.map +1 -1
  18. package/dist/commands/pull.d.ts +2 -2
  19. package/dist/commands/push.d.ts +7 -7
  20. package/dist/commands/run.d.ts +8 -5
  21. package/dist/commands/run.d.ts.map +1 -1
  22. package/dist/commands/run.js +190 -64
  23. package/dist/commands/run.js.map +1 -1
  24. package/dist/commands/secrets/add.d.ts +2 -2
  25. package/dist/commands/secrets/rm.d.ts +1 -1
  26. package/dist/commands/task/run.d.ts +5 -5
  27. package/dist/commands/validate-schema.d.ts +1 -1
  28. package/dist/lib/actor.d.ts.map +1 -1
  29. package/dist/lib/apify_command.d.ts +0 -1
  30. package/dist/lib/apify_command.d.ts.map +1 -1
  31. package/dist/lib/apify_command.js +4 -3
  32. package/dist/lib/apify_command.js.map +1 -1
  33. package/dist/lib/commands/resolve-input.d.ts +5 -0
  34. package/dist/lib/commands/resolve-input.d.ts.map +1 -0
  35. package/dist/lib/commands/resolve-input.js +29 -0
  36. package/dist/lib/commands/resolve-input.js.map +1 -0
  37. package/dist/lib/commands/run-on-cloud.d.ts +6 -5
  38. package/dist/lib/commands/run-on-cloud.d.ts.map +1 -1
  39. package/dist/lib/commands/run-on-cloud.js +7 -8
  40. package/dist/lib/commands/run-on-cloud.js.map +1 -1
  41. package/dist/lib/consts.d.ts +2 -1
  42. package/dist/lib/consts.d.ts.map +1 -1
  43. package/dist/lib/consts.js +1 -0
  44. package/dist/lib/consts.js.map +1 -1
  45. package/dist/lib/create-utils.d.ts.map +1 -1
  46. package/dist/lib/exec.d.ts +0 -1
  47. package/dist/lib/exec.d.ts.map +1 -1
  48. package/dist/lib/files.d.ts.map +1 -1
  49. package/dist/lib/input_schema.d.ts +2 -0
  50. package/dist/lib/input_schema.d.ts.map +1 -1
  51. package/dist/lib/input_schema.js +34 -1
  52. package/dist/lib/input_schema.js.map +1 -1
  53. package/dist/lib/local_state.d.ts.map +1 -1
  54. package/dist/lib/secrets.d.ts.map +1 -1
  55. package/dist/lib/telemetry.d.ts.map +1 -1
  56. package/dist/lib/utils.d.ts +1 -4
  57. package/dist/lib/utils.d.ts.map +1 -1
  58. package/dist/lib/utils.js +2 -0
  59. package/dist/lib/utils.js.map +1 -1
  60. package/oclif.manifest.json +53 -1
  61. package/package.json +10 -7
package/README.md CHANGED
@@ -131,7 +131,7 @@ apify login
131
131
 
132
132
  Before you can interact with the Apify cloud, you need to [create an Apify account](https://console.apify.com/)
133
133
  and log in to it using the above command. You will be prompted for
134
- your [Apify API token](https://console.apify.com/account#/integrations).
134
+ your [Apify API token](https://console.apify.com/settings/integrations).
135
135
  Note that the command will store the API token and other sensitive information to `~/.apify`.
136
136
 
137
137
 
@@ -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.98/src/commands/actor/index.ts)_
312
+ _See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0/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.98/src/commands/actor/get-input.ts)_
326
+ _See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0/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.98/src/commands/actor/get-value.ts)_
343
+ _See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0/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.98/src/commands/actor/push-data.ts)_
365
+ _See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0/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.98/src/commands/actor/set-value.ts)_
394
+ _See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/actor/set-value.ts)_
395
395
 
396
396
  ## `apify call [ACTORID]`
397
397
 
@@ -399,7 +399,8 @@ Runs a specific Actor remotely on the Apify cloud platform.
399
399
 
400
400
  ```
401
401
  USAGE
402
- $ apify call [ACTORID] [-b <value>] [-t <value>] [-m <value>] [-w <value>]
402
+ $ apify call [ACTORID] [-b <value>] [-t <value>] [-m <value>] [-w <value>] [-i <value> | --input-file
403
+ <value>]
403
404
 
404
405
  ARGUMENTS
405
406
  ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
@@ -407,9 +408,12 @@ ARGUMENTS
407
408
 
408
409
  FLAGS
409
410
  -b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
411
+ -i, --input=<value> Optional JSON input to be given to the Actor.
410
412
  -m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
411
413
  -t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
412
414
  -w, --wait-for-finish=<value> Seconds for waiting to run to finish, if no value passed, it waits forever.
415
+ --input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a
416
+ valid JSON file. You can also specify `-` to read from standard input.
413
417
 
414
418
  DESCRIPTION
415
419
  Runs a specific Actor remotely on the Apify cloud platform.
@@ -417,7 +421,7 @@ DESCRIPTION
417
421
  takes input for the Actor from the default local key-value store by default.
418
422
  ```
419
423
 
420
- _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/call.ts)_
424
+ _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/call.ts)_
421
425
 
422
426
  ## `apify create [ACTORNAME]`
423
427
 
@@ -442,7 +446,7 @@ DESCRIPTION
442
446
  Creates a new Actor project directory from a selected boilerplate template.
443
447
  ```
444
448
 
445
- _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/create.ts)_
449
+ _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/create.ts)_
446
450
 
447
451
  ## `apify help [COMMAND]`
448
452
 
@@ -462,7 +466,7 @@ DESCRIPTION
462
466
  Display help for apify.
463
467
  ```
464
468
 
465
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.1/src/commands/help.ts)_
469
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.3/src/commands/help.ts)_
466
470
 
467
471
  ## `apify info`
468
472
 
@@ -477,7 +481,7 @@ DESCRIPTION
477
481
  The information is printed to the console.
478
482
  ```
479
483
 
480
- _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/info.ts)_
484
+ _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/info.ts)_
481
485
 
482
486
  ## `apify init [ACTORNAME]`
483
487
 
@@ -505,7 +509,7 @@ DESCRIPTION
505
509
  WARNING: The directory at "storage" will be overwritten if it already exists.
506
510
  ```
507
511
 
508
- _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/init.ts)_
512
+ _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/init.ts)_
509
513
 
510
514
  ## `apify login`
511
515
 
@@ -526,7 +530,7 @@ DESCRIPTION
526
530
  "apify" commands. To log out, call "apify logout".
527
531
  ```
528
532
 
529
- _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/login.ts)_
533
+ _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/login.ts)_
530
534
 
531
535
  ## `apify logout`
532
536
 
@@ -542,7 +546,7 @@ DESCRIPTION
542
546
  call "apify login".
543
547
  ```
544
548
 
545
- _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/logout.ts)_
549
+ _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/logout.ts)_
546
550
 
547
551
  ## `apify pull [ACTORID]`
548
552
 
@@ -564,7 +568,7 @@ DESCRIPTION
564
568
  cloned. If it is defined as Web IDE, it will fetch the files.
565
569
  ```
566
570
 
567
- _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/pull.ts)_
571
+ _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/pull.ts)_
568
572
 
569
573
  ## `apify push [ACTORID]`
570
574
 
@@ -602,7 +606,7 @@ DESCRIPTION
602
606
  overwritten with --force flag.
603
607
  ```
604
608
 
605
- _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/push.ts)_
609
+ _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/push.ts)_
606
610
 
607
611
  ## `apify run`
608
612
 
@@ -610,15 +614,20 @@ Runs the Actor locally in the current directory.
610
614
 
611
615
  ```
612
616
  USAGE
613
- $ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store] [--entrypoint <value>]
617
+ $ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store] [--entrypoint <value>] [-i
618
+ <value> | --input-file <value>]
614
619
 
615
620
  FLAGS
621
+ -i, --input=<value> Optional JSON input to be given to the Actor. You can either provide the JSON string as a
622
+ value to this, or `-` to read from standard input.
616
623
  -p, --purge Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store
617
624
  options.
618
625
  --entrypoint=<value> Optional entrypoint for running with injected environment variables.
619
626
  For Python, it is the module name, or a path to a file.
620
627
  For node.js, it is the npm script name, or a path to a JS/MJS file. You can also pass in
621
628
  a directory name, provided that directory contains an "index.js" file.
629
+ --input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a
630
+ valid JSON file.
622
631
  --purge-dataset Deletes the local directory containing the default dataset before the run starts.
623
632
  --purge-key-value-store Deletes all records from the default key-value store in the local directory before the
624
633
  run starts, except for the "INPUT" key.
@@ -634,7 +643,7 @@ DESCRIPTION
634
643
  package.json file. You can set up your own main file or environment variables by changing it.
635
644
  ```
636
645
 
637
- _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/run.ts)_
646
+ _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/run.ts)_
638
647
 
639
648
  ## `apify secrets`
640
649
 
@@ -664,7 +673,7 @@ DESCRIPTION
664
673
  of the Actor.
665
674
  ```
666
675
 
667
- _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/secrets/index.ts)_
676
+ _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/secrets/index.ts)_
668
677
 
669
678
  ## `apify secrets add NAME VALUE`
670
679
 
@@ -683,7 +692,7 @@ DESCRIPTION
683
692
  The secrets are stored to a file at ~/.apify
684
693
  ```
685
694
 
686
- _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/secrets/add.ts)_
695
+ _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/secrets/add.ts)_
687
696
 
688
697
  ## `apify secrets rm NAME`
689
698
 
@@ -700,7 +709,7 @@ DESCRIPTION
700
709
  Removes the secret.
701
710
  ```
702
711
 
703
- _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/secrets/rm.ts)_
712
+ _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/secrets/rm.ts)_
704
713
 
705
714
  ## `apify task`
706
715
 
@@ -714,7 +723,7 @@ DESCRIPTION
714
723
  Commands are designed to be used to interact with Tasks.
715
724
  ```
716
725
 
717
- _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/task/index.ts)_
726
+ _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/task/index.ts)_
718
727
 
719
728
  ## `apify task run TASKID`
720
729
 
@@ -739,7 +748,7 @@ DESCRIPTION
739
748
  takes input for the Actor from the default local key-value store by default.
740
749
  ```
741
750
 
742
- _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/task/run.ts)_
751
+ _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/task/run.ts)_
743
752
 
744
753
  ## `apify validate-schema [PATH]`
745
754
 
@@ -764,5 +773,5 @@ DESCRIPTION
764
773
  You can also pass any custom path to your input schema to have it validated instead.
765
774
  ```
766
775
 
767
- _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.98/src/commands/validate-schema.ts)_
776
+ _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v1.0.0/src/commands/validate-schema.ts)_
768
777
  <!-- commandsstop -->