apify-cli 0.21.0-beta.91 → 0.21.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 (129) hide show
  1. package/CHANGELOG.md +2 -5
  2. package/README.md +214 -234
  3. package/dist/.tsbuildinfo +1 -1
  4. package/dist/commands/actor/index.d.ts.map +1 -1
  5. package/dist/commands/actor/index.js +1 -1
  6. package/dist/commands/actor/index.js.map +1 -1
  7. package/dist/commands/actor/push-data.js +6 -6
  8. package/dist/commands/actor/push-data.js.map +1 -1
  9. package/dist/commands/actor/set-value.d.ts.map +1 -1
  10. package/dist/commands/actor/set-value.js +4 -4
  11. package/dist/commands/actor/set-value.js.map +1 -1
  12. package/dist/commands/actors/call.d.ts.map +1 -1
  13. package/dist/commands/actors/call.js +3 -4
  14. package/dist/commands/actors/call.js.map +1 -1
  15. package/dist/commands/actors/index.d.ts.map +1 -1
  16. package/dist/commands/actors/index.js +1 -1
  17. package/dist/commands/actors/index.js.map +1 -1
  18. package/dist/commands/actors/ls.d.ts.map +1 -1
  19. package/dist/commands/actors/ls.js +1 -1
  20. package/dist/commands/actors/ls.js.map +1 -1
  21. package/dist/commands/actors/pull.d.ts.map +1 -1
  22. package/dist/commands/actors/pull.js +2 -2
  23. package/dist/commands/actors/pull.js.map +1 -1
  24. package/dist/commands/actors/push.d.ts.map +1 -1
  25. package/dist/commands/actors/push.js +7 -8
  26. package/dist/commands/actors/push.js.map +1 -1
  27. package/dist/commands/actors/rm.d.ts.map +1 -1
  28. package/dist/commands/actors/rm.js +1 -1
  29. package/dist/commands/actors/rm.js.map +1 -1
  30. package/dist/commands/actors/start.d.ts.map +1 -1
  31. package/dist/commands/actors/start.js +3 -4
  32. package/dist/commands/actors/start.js.map +1 -1
  33. package/dist/commands/builds/index.d.ts.map +1 -1
  34. package/dist/commands/builds/index.js +1 -1
  35. package/dist/commands/builds/index.js.map +1 -1
  36. package/dist/commands/builds/rm.d.ts.map +1 -1
  37. package/dist/commands/builds/rm.js +1 -1
  38. package/dist/commands/builds/rm.js.map +1 -1
  39. package/dist/commands/create.d.ts.map +1 -1
  40. package/dist/commands/create.js +1 -1
  41. package/dist/commands/create.js.map +1 -1
  42. package/dist/commands/datasets/create.d.ts.map +1 -1
  43. package/dist/commands/datasets/create.js +1 -1
  44. package/dist/commands/datasets/create.js.map +1 -1
  45. package/dist/commands/datasets/get-items.d.ts.map +1 -1
  46. package/dist/commands/datasets/get-items.js +1 -1
  47. package/dist/commands/datasets/get-items.js.map +1 -1
  48. package/dist/commands/datasets/index.d.ts.map +1 -1
  49. package/dist/commands/datasets/index.js +1 -1
  50. package/dist/commands/datasets/index.js.map +1 -1
  51. package/dist/commands/datasets/info.d.ts.map +1 -1
  52. package/dist/commands/datasets/info.js +1 -1
  53. package/dist/commands/datasets/info.js.map +1 -1
  54. package/dist/commands/datasets/ls.d.ts.map +1 -1
  55. package/dist/commands/datasets/ls.js +5 -5
  56. package/dist/commands/datasets/ls.js.map +1 -1
  57. package/dist/commands/datasets/push-items.d.ts.map +1 -1
  58. package/dist/commands/datasets/push-items.js +2 -2
  59. package/dist/commands/datasets/push-items.js.map +1 -1
  60. package/dist/commands/datasets/rename.d.ts.map +1 -1
  61. package/dist/commands/datasets/rename.js +8 -8
  62. package/dist/commands/datasets/rename.js.map +1 -1
  63. package/dist/commands/datasets/rm.d.ts.map +1 -1
  64. package/dist/commands/datasets/rm.js +3 -3
  65. package/dist/commands/datasets/rm.js.map +1 -1
  66. package/dist/commands/edit-input-schema.js +1 -1
  67. package/dist/commands/info.d.ts.map +1 -1
  68. package/dist/commands/info.js +1 -2
  69. package/dist/commands/info.js.map +1 -1
  70. package/dist/commands/init.d.ts.map +1 -1
  71. package/dist/commands/init.js +5 -6
  72. package/dist/commands/init.js.map +1 -1
  73. package/dist/commands/key-value-stores/create.d.ts.map +1 -1
  74. package/dist/commands/key-value-stores/create.js +3 -3
  75. package/dist/commands/key-value-stores/create.js.map +1 -1
  76. package/dist/commands/key-value-stores/get-value.d.ts.map +1 -1
  77. package/dist/commands/key-value-stores/get-value.js +1 -1
  78. package/dist/commands/key-value-stores/get-value.js.map +1 -1
  79. package/dist/commands/key-value-stores/index.d.ts.map +1 -1
  80. package/dist/commands/key-value-stores/index.js +1 -1
  81. package/dist/commands/key-value-stores/index.js.map +1 -1
  82. package/dist/commands/key-value-stores/ls.js +6 -6
  83. package/dist/commands/key-value-stores/rename.d.ts.map +1 -1
  84. package/dist/commands/key-value-stores/rename.js +8 -8
  85. package/dist/commands/key-value-stores/rename.js.map +1 -1
  86. package/dist/commands/key-value-stores/rm.d.ts.map +1 -1
  87. package/dist/commands/key-value-stores/rm.js +3 -3
  88. package/dist/commands/key-value-stores/rm.js.map +1 -1
  89. package/dist/commands/key-value-stores/set-value.d.ts.map +1 -1
  90. package/dist/commands/key-value-stores/set-value.js +1 -1
  91. package/dist/commands/key-value-stores/set-value.js.map +1 -1
  92. package/dist/commands/login.d.ts.map +1 -1
  93. package/dist/commands/login.js +3 -3
  94. package/dist/commands/login.js.map +1 -1
  95. package/dist/commands/logout.d.ts.map +1 -1
  96. package/dist/commands/logout.js +2 -2
  97. package/dist/commands/logout.js.map +1 -1
  98. package/dist/commands/request-queues/index.d.ts.map +1 -1
  99. package/dist/commands/request-queues/index.js +1 -1
  100. package/dist/commands/request-queues/index.js.map +1 -1
  101. package/dist/commands/run.d.ts.map +1 -1
  102. package/dist/commands/run.js +3 -8
  103. package/dist/commands/run.js.map +1 -1
  104. package/dist/commands/runs/abort.js +1 -1
  105. package/dist/commands/runs/index.d.ts.map +1 -1
  106. package/dist/commands/runs/index.js +1 -1
  107. package/dist/commands/runs/index.js.map +1 -1
  108. package/dist/commands/runs/info.js +2 -2
  109. package/dist/commands/secrets/add.d.ts.map +1 -1
  110. package/dist/commands/secrets/add.js +1 -1
  111. package/dist/commands/secrets/add.js.map +1 -1
  112. package/dist/commands/secrets/index.d.ts.map +1 -1
  113. package/dist/commands/secrets/index.js +13 -11
  114. package/dist/commands/secrets/index.js.map +1 -1
  115. package/dist/commands/secrets/rm.d.ts.map +1 -1
  116. package/dist/commands/secrets/rm.js +1 -1
  117. package/dist/commands/secrets/rm.js.map +1 -1
  118. package/dist/commands/task/index.d.ts.map +1 -1
  119. package/dist/commands/task/index.js +1 -1
  120. package/dist/commands/task/index.js.map +1 -1
  121. package/dist/commands/task/run.d.ts.map +1 -1
  122. package/dist/commands/task/run.js +2 -3
  123. package/dist/commands/task/run.js.map +1 -1
  124. package/dist/commands/validate-schema.d.ts.map +1 -1
  125. package/dist/commands/validate-schema.js +7 -10
  126. package/dist/commands/validate-schema.js.map +1 -1
  127. package/dist/typechecking.tsbuildinfo +1 -1
  128. package/oclif.manifest.json +75 -75
  129. package/package.json +1 -1
package/README.md CHANGED
@@ -347,17 +347,17 @@ This section contains printouts of `apify help` for all commands.
347
347
 
348
348
  ## `apify actor`
349
349
 
350
- Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
350
+ Manages runtime data operations inside of a running Actor.
351
351
 
352
352
  ```
353
353
  USAGE
354
354
  $ apify actor
355
355
 
356
356
  DESCRIPTION
357
- Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
357
+ Manages runtime data operations inside of a running Actor.
358
358
  ```
359
359
 
360
- _See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actor/index.ts)_
360
+ _See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actor/index.ts)_
361
361
 
362
362
  ## `apify actor get-input`
363
363
 
@@ -371,7 +371,7 @@ DESCRIPTION
371
371
  Gets the Actor input value from the default key-value store associated with the Actor run.
372
372
  ```
373
373
 
374
- _See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actor/get-input.ts)_
374
+ _See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actor/get-input.ts)_
375
375
 
376
376
  ## `apify actor get-value KEY`
377
377
 
@@ -388,11 +388,11 @@ DESCRIPTION
388
388
  Gets a value from the default key-value store associated with the Actor run.
389
389
  ```
390
390
 
391
- _See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actor/get-value.ts)_
391
+ _See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actor/get-value.ts)_
392
392
 
393
393
  ## `apify actor push-data [ITEM]`
394
394
 
395
- Stores an object or an array of objects to the default dataset of the Actor run.
395
+ Saves data to Actor's run default dataset.
396
396
 
397
397
  ```
398
398
  USAGE
@@ -402,19 +402,20 @@ ARGUMENTS
402
402
  ITEM JSON string with one object or array of objects containing data to be stored in the default dataset.
403
403
 
404
404
  DESCRIPTION
405
- Stores an object or an array of objects to the default dataset of the Actor run.
406
- It is possible to pass data using item argument or stdin.
407
- Passing data using argument:
408
- $ apify actor push-data {"foo": "bar"}
409
- Passing data using stdin with pipe:
405
+ Saves data to Actor's run default dataset.
406
+
407
+ Accept input as:
408
+ - JSON argument:
409
+ $ apify actor push-data {"key": "value"}
410
+ - Piped stdin:
410
411
  $ cat ./test.json | apify actor push-data
411
412
  ```
412
413
 
413
- _See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actor/push-data.ts)_
414
+ _See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actor/push-data.ts)_
414
415
 
415
416
  ## `apify actor set-value KEY [VALUE]`
416
417
 
417
- Sets or removes record into the default KeyValueStore associated with the Actor run.
418
+ Sets or removes record into the default key-value store associated with the Actor run.
418
419
 
419
420
  ```
420
421
  USAGE
@@ -431,29 +432,32 @@ FLAGS
431
432
  -c, --contentType=<value> Specifies a custom MIME content type of the record. By default "application/json" is used.
432
433
 
433
434
  DESCRIPTION
434
- Sets or removes record into the default KeyValueStore associated with the Actor run.
435
+ Sets or removes record into the default key-value store associated with the Actor run.
436
+
435
437
  It is possible to pass data using argument or stdin.
438
+
436
439
  Passing data using argument:
437
440
  $ apify actor set-value KEY my-value
441
+
438
442
  Passing data using stdin with pipe:
439
443
  $ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
440
444
  ```
441
445
 
442
- _See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actor/set-value.ts)_
446
+ _See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actor/set-value.ts)_
443
447
 
444
448
  ## `apify actors`
445
449
 
446
- Commands are designed to be used with Actors.
450
+ Manages Actor creation, deployment, and execution on the Apify platform.
447
451
 
448
452
  ```
449
453
  USAGE
450
454
  $ apify actors
451
455
 
452
456
  DESCRIPTION
453
- Commands are designed to be used with Actors.
457
+ Manages Actor creation, deployment, and execution on the Apify platform.
454
458
  ```
455
459
 
456
- _See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/index.ts)_
460
+ _See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/index.ts)_
457
461
 
458
462
  ## `apify actors build [ACTORID]`
459
463
 
@@ -480,11 +484,11 @@ DESCRIPTION
480
484
  Creates a new build of the Actor.
481
485
  ```
482
486
 
483
- _See code: [src/commands/actors/build.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/build.ts)_
487
+ _See code: [src/commands/actors/build.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/build.ts)_
484
488
 
485
489
  ## `apify actors call [ACTORID]`
486
490
 
487
- Runs a specific Actor remotely on the Apify cloud platform.
491
+ Executes Actor remotely using your authenticated account.
488
492
 
489
493
  ```
490
494
  USAGE
@@ -493,7 +497,7 @@ USAGE
493
497
 
494
498
  ARGUMENTS
495
499
  ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
496
- provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
500
+ provided, the command runs the remote Actor specified in the '.actor/actor.json' file.
497
501
 
498
502
  FLAGS
499
503
  -b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
@@ -509,12 +513,11 @@ GLOBAL FLAGS
509
513
  --json Format output as json.
510
514
 
511
515
  DESCRIPTION
512
- Runs a specific Actor remotely on the Apify cloud platform.
513
- The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
514
- takes input for the Actor from the default local key-value store by default.
516
+ Executes Actor remotely using your authenticated account.
517
+ Reads input from local key-value store by default.
515
518
  ```
516
519
 
517
- _See code: [src/commands/actors/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/call.ts)_
520
+ _See code: [src/commands/actors/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/call.ts)_
518
521
 
519
522
  ## `apify actors info ACTORID`
520
523
 
@@ -538,11 +541,11 @@ DESCRIPTION
538
541
  Get information about an Actor.
539
542
  ```
540
543
 
541
- _See code: [src/commands/actors/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/info.ts)_
544
+ _See code: [src/commands/actors/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/info.ts)_
542
545
 
543
546
  ## `apify actors ls`
544
547
 
545
- Lists all recently ran Actors or your own Actors.
548
+ Prints a list of recently executed Actors or Actors you own.
546
549
 
547
550
  ```
548
551
  USAGE
@@ -558,14 +561,14 @@ GLOBAL FLAGS
558
561
  --json Format output as json.
559
562
 
560
563
  DESCRIPTION
561
- Lists all recently ran Actors or your own Actors.
564
+ Prints a list of recently executed Actors or Actors you own.
562
565
  ```
563
566
 
564
- _See code: [src/commands/actors/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/ls.ts)_
567
+ _See code: [src/commands/actors/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/ls.ts)_
565
568
 
566
569
  ## `apify actors pull [ACTORID]`
567
570
 
568
- 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.
571
+ Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
569
572
 
570
573
  ```
571
574
  USAGE
@@ -580,15 +583,14 @@ FLAGS
580
583
  --dir=<value> Directory where the Actor should be pulled to
581
584
 
582
585
  DESCRIPTION
583
- Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
584
- cloned. If it is defined as Web IDE, it will fetch the files.
586
+ Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
585
587
  ```
586
588
 
587
- _See code: [src/commands/actors/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/pull.ts)_
589
+ _See code: [src/commands/actors/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/pull.ts)_
588
590
 
589
591
  ## `apify actors push [ACTORID]`
590
592
 
591
- Uploads the Actor to the Apify platform and builds it there.
593
+ Deploys Actor to Apify platform using settings from '.actor/actor.json'.
592
594
 
593
595
  ```
594
596
  USAGE
@@ -596,13 +598,13 @@ USAGE
596
598
 
597
599
  ARGUMENTS
598
600
  ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
599
- command will create or modify the Actor with the name specified in ".actor/actor.json" file.
601
+ command will create or modify the Actor with the name specified in '.actor/actor.json' file.
600
602
 
601
603
  FLAGS
602
604
  -b, --build-tag=<value> Build tag to be applied to the successful Actor build. By default, it is taken from the
603
- ".actor/actor.json" file
605
+ '.actor/actor.json' file
604
606
  -v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
605
- the ".actor/actor.json" file.
607
+ the '.actor/actor.json' file.
606
608
  -w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
607
609
  --dir=<value> Directory where the Actor is located
608
610
  --force Push an Actor even when the local files are older than the Actor on the platform.
@@ -610,21 +612,16 @@ FLAGS
610
612
  browser automatically.
611
613
 
612
614
  DESCRIPTION
613
- Uploads the Actor to the Apify platform and builds it there.
614
- The Actor settings are read from the ".actor/actor.json" file in the current directory, but they can be overridden
615
- using command-line options.
616
- NOTE: If the source files are smaller than 3 MB then they are uploaded as
617
- "Multiple source files", otherwise they are uploaded as "Zip file".
618
-
619
- When there's an attempt to push files that are older than the Actor on the platform, the command will fail. Can be
620
- overwritten with --force flag.
615
+ Deploys Actor to Apify platform using settings from '.actor/actor.json'.
616
+ Files under '3' MB upload as "Multiple source files"; larger projects upload as ZIP file.
617
+ Use --force to override newer remote versions.
621
618
  ```
622
619
 
623
- _See code: [src/commands/actors/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/push.ts)_
620
+ _See code: [src/commands/actors/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/push.ts)_
624
621
 
625
622
  ## `apify actors rm ACTORID`
626
623
 
627
- Deletes an Actor.
624
+ Permanently removes an Actor from your account.
628
625
 
629
626
  ```
630
627
  USAGE
@@ -634,14 +631,14 @@ ARGUMENTS
634
631
  ACTORID The Actor ID to delete.
635
632
 
636
633
  DESCRIPTION
637
- Deletes an Actor.
634
+ Permanently removes an Actor from your account.
638
635
  ```
639
636
 
640
- _See code: [src/commands/actors/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/rm.ts)_
637
+ _See code: [src/commands/actors/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/rm.ts)_
641
638
 
642
639
  ## `apify actors start [ACTORID]`
643
640
 
644
- Runs a specific Actor remotely on the Apify cloud platform and immediately returns information about the run.
641
+ Starts Actor remotely and returns run details immediately.
645
642
 
646
643
  ```
647
644
  USAGE
@@ -650,7 +647,7 @@ USAGE
650
647
 
651
648
  ARGUMENTS
652
649
  ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
653
- provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
650
+ provided, the command runs the remote Actor specified in the '.actor/actor.json' file.
654
651
 
655
652
  FLAGS
656
653
  -b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
@@ -664,26 +661,25 @@ GLOBAL FLAGS
664
661
  --json Format output as json.
665
662
 
666
663
  DESCRIPTION
667
- Runs a specific Actor remotely on the Apify cloud platform and immediately returns information about the run.
668
- The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
669
- takes input for the Actor from the default local key-value store by default.
664
+ Starts Actor remotely and returns run details immediately.
665
+ Uses authenticated account and local key-value store for input.
670
666
  ```
671
667
 
672
- _See code: [src/commands/actors/start.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/actors/start.ts)_
668
+ _See code: [src/commands/actors/start.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/actors/start.ts)_
673
669
 
674
670
  ## `apify builds`
675
671
 
676
- Commands are designed to be used with Actor Builds.
672
+ Manages Actor build processes and versioning.
677
673
 
678
674
  ```
679
675
  USAGE
680
676
  $ apify builds
681
677
 
682
678
  DESCRIPTION
683
- Commands are designed to be used with Actor Builds.
679
+ Manages Actor build processes and versioning.
684
680
  ```
685
681
 
686
- _See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/builds/index.ts)_
682
+ _See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/builds/index.ts)_
687
683
 
688
684
  ## `apify builds create [ACTORID]`
689
685
 
@@ -710,7 +706,7 @@ DESCRIPTION
710
706
  Creates a new build of the Actor.
711
707
  ```
712
708
 
713
- _See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/builds/create.ts)_
709
+ _See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/builds/create.ts)_
714
710
 
715
711
  ## `apify builds info BUILDID`
716
712
 
@@ -730,7 +726,7 @@ DESCRIPTION
730
726
  Prints information about a specific build.
731
727
  ```
732
728
 
733
- _See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/builds/info.ts)_
729
+ _See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/builds/info.ts)_
734
730
 
735
731
  ## `apify builds log BUILDID`
736
732
 
@@ -747,7 +743,7 @@ DESCRIPTION
747
743
  Prints the log of a specific build.
748
744
  ```
749
745
 
750
- _See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/builds/log.ts)_
746
+ _See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/builds/log.ts)_
751
747
 
752
748
  ## `apify builds ls [ACTORID]`
753
749
 
@@ -773,11 +769,11 @@ DESCRIPTION
773
769
  Lists all builds of the Actor.
774
770
  ```
775
771
 
776
- _See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/builds/ls.ts)_
772
+ _See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/builds/ls.ts)_
777
773
 
778
774
  ## `apify builds rm BUILDID`
779
775
 
780
- Deletes an Actor Build.
776
+ Permanently removes an Actor build from the Apify platform.
781
777
 
782
778
  ```
783
779
  USAGE
@@ -787,14 +783,14 @@ ARGUMENTS
787
783
  BUILDID The build ID to delete.
788
784
 
789
785
  DESCRIPTION
790
- Deletes an Actor Build.
786
+ Permanently removes an Actor build from the Apify platform.
791
787
  ```
792
788
 
793
- _See code: [src/commands/builds/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/builds/rm.ts)_
789
+ _See code: [src/commands/builds/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/builds/rm.ts)_
794
790
 
795
791
  ## `apify call [ACTORID]`
796
792
 
797
- Runs a specific Actor remotely on the Apify cloud platform.
793
+ Executes Actor remotely using your authenticated account.
798
794
 
799
795
  ```
800
796
  USAGE
@@ -803,7 +799,7 @@ USAGE
803
799
 
804
800
  ARGUMENTS
805
801
  ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
806
- provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
802
+ provided, the command runs the remote Actor specified in the '.actor/actor.json' file.
807
803
 
808
804
  FLAGS
809
805
  -b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
@@ -819,16 +815,15 @@ GLOBAL FLAGS
819
815
  --json Format output as json.
820
816
 
821
817
  DESCRIPTION
822
- Runs a specific Actor remotely on the Apify cloud platform.
823
- The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
824
- takes input for the Actor from the default local key-value store by default.
818
+ Executes Actor remotely using your authenticated account.
819
+ Reads input from local key-value store by default.
825
820
  ```
826
821
 
827
- _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/call.ts)_
822
+ _See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/call.ts)_
828
823
 
829
824
  ## `apify create [ACTORNAME]`
830
825
 
831
- Creates a new Actor project directory from a selected boilerplate template.
826
+ Creates an Actor project from a template in a new directory.
832
827
 
833
828
  ```
834
829
  USAGE
@@ -846,28 +841,28 @@ FLAGS
846
841
  --skip-dependency-install Skip installing Actor dependencies.
847
842
 
848
843
  DESCRIPTION
849
- Creates a new Actor project directory from a selected boilerplate template.
844
+ Creates an Actor project from a template in a new directory.
850
845
  ```
851
846
 
852
- _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/create.ts)_
847
+ _See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/create.ts)_
853
848
 
854
849
  ## `apify datasets`
855
850
 
856
- Commands are designed to be used with Datasets.
851
+ Manages structured data storage and retrieval.
857
852
 
858
853
  ```
859
854
  USAGE
860
855
  $ apify datasets
861
856
 
862
857
  DESCRIPTION
863
- Commands are designed to be used with Datasets.
858
+ Manages structured data storage and retrieval.
864
859
  ```
865
860
 
866
- _See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/index.ts)_
861
+ _See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/index.ts)_
867
862
 
868
863
  ## `apify datasets create [DATASETNAME]`
869
864
 
870
- Creates a new Dataset on your account
865
+ Creates a new dataset for storing structured data on your account.
871
866
 
872
867
  ```
873
868
  USAGE
@@ -880,14 +875,14 @@ GLOBAL FLAGS
880
875
  --json Format output as json.
881
876
 
882
877
  DESCRIPTION
883
- Creates a new Dataset on your account
878
+ Creates a new dataset for storing structured data on your account.
884
879
  ```
885
880
 
886
- _See code: [src/commands/datasets/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/create.ts)_
881
+ _See code: [src/commands/datasets/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/create.ts)_
887
882
 
888
883
  ## `apify datasets get-items DATASETID`
889
884
 
890
- Exports the items present in a Dataset.
885
+ Retrieves dataset items in specified format (JSON, CSV, etc).
891
886
 
892
887
  ```
893
888
  USAGE
@@ -903,14 +898,14 @@ FLAGS
903
898
  --offset=<value> The offset in the dataset where to start getting items.
904
899
 
905
900
  DESCRIPTION
906
- Exports the items present in a Dataset.
901
+ Retrieves dataset items in specified format (JSON, CSV, etc).
907
902
  ```
908
903
 
909
- _See code: [src/commands/datasets/get-items.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/get-items.ts)_
904
+ _See code: [src/commands/datasets/get-items.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/get-items.ts)_
910
905
 
911
906
  ## `apify datasets info STOREID`
912
907
 
913
- Shows information about a dataset.
908
+ Prints information about a specific dataset.
914
909
 
915
910
  ```
916
911
  USAGE
@@ -923,89 +918,89 @@ GLOBAL FLAGS
923
918
  --json Format output as json.
924
919
 
925
920
  DESCRIPTION
926
- Shows information about a dataset.
921
+ Prints information about a specific dataset.
927
922
  ```
928
923
 
929
- _See code: [src/commands/datasets/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/info.ts)_
924
+ _See code: [src/commands/datasets/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/info.ts)_
930
925
 
931
926
  ## `apify datasets ls`
932
927
 
933
- Lists all Datasets on your account.
928
+ Prints all datasets on your account.
934
929
 
935
930
  ```
936
931
  USAGE
937
932
  $ apify datasets ls [--json] [--offset <value>] [--limit <value>] [--desc] [--unnamed]
938
933
 
939
934
  FLAGS
940
- --desc Sorts Datasets in descending order.
941
- --limit=<value> [default: 20] Number of Datasets that will be listed.
942
- --offset=<value> Number of Datasets that will be skipped.
943
- --unnamed Lists Datasets that don't have a name set.
935
+ --desc Sorts datasets in descending order.
936
+ --limit=<value> [default: 20] Number of datasets that will be listed.
937
+ --offset=<value> Number of datasets that will be skipped.
938
+ --unnamed Lists datasets that don't have a name set.
944
939
 
945
940
  GLOBAL FLAGS
946
941
  --json Format output as json.
947
942
 
948
943
  DESCRIPTION
949
- Lists all Datasets on your account.
944
+ Prints all datasets on your account.
950
945
  ```
951
946
 
952
- _See code: [src/commands/datasets/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/ls.ts)_
947
+ _See code: [src/commands/datasets/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/ls.ts)_
953
948
 
954
949
  ## `apify datasets push-items NAMEORID [ITEM]`
955
950
 
956
- Pushes an object or an array of objects to the provided Dataset.
951
+ Adds data items to specified dataset. Accepts single object or array of objects.
957
952
 
958
953
  ```
959
954
  USAGE
960
955
  $ apify datasets push-items NAMEORID [ITEM]
961
956
 
962
957
  ARGUMENTS
963
- NAMEORID The Dataset ID or name to push the objects to
958
+ NAMEORID The dataset ID or name to push the objects to
964
959
  ITEM The object or array of objects to be pushed.
965
960
 
966
961
  DESCRIPTION
967
- Pushes an object or an array of objects to the provided Dataset.
962
+ Adds data items to specified dataset. Accepts single object or array of objects.
968
963
  ```
969
964
 
970
- _See code: [src/commands/datasets/push-items.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/push-items.ts)_
965
+ _See code: [src/commands/datasets/push-items.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/push-items.ts)_
971
966
 
972
967
  ## `apify datasets rename NAMEORID [NEWNAME]`
973
968
 
974
- Renames a Dataset, or removes its unique name
969
+ Change dataset name or removes name with --unname flag.
975
970
 
976
971
  ```
977
972
  USAGE
978
973
  $ apify datasets rename NAMEORID [NEWNAME] [--unname]
979
974
 
980
975
  ARGUMENTS
981
- NAMEORID The Dataset ID or name to delete
982
- NEWNAME The new name for the Dataset
976
+ NAMEORID The dataset ID or name to delete.
977
+ NEWNAME The new name for the dataset.
983
978
 
984
979
  FLAGS
985
- --unname Removes the unique name of the Dataset
980
+ --unname Removes the unique name of the dataset.
986
981
 
987
982
  DESCRIPTION
988
- Renames a Dataset, or removes its unique name
983
+ Change dataset name or removes name with --unname flag.
989
984
  ```
990
985
 
991
- _See code: [src/commands/datasets/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/rename.ts)_
986
+ _See code: [src/commands/datasets/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/rename.ts)_
992
987
 
993
988
  ## `apify datasets rm DATASETNAMEORID`
994
989
 
995
- Deletes a Dataset
990
+ Permanently removes a dataset.
996
991
 
997
992
  ```
998
993
  USAGE
999
994
  $ apify datasets rm DATASETNAMEORID
1000
995
 
1001
996
  ARGUMENTS
1002
- DATASETNAMEORID The Dataset ID or name to delete
997
+ DATASETNAMEORID The dataset ID or name to delete
1003
998
 
1004
999
  DESCRIPTION
1005
- Deletes a Dataset
1000
+ Permanently removes a dataset.
1006
1001
  ```
1007
1002
 
1008
- _See code: [src/commands/datasets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/datasets/rm.ts)_
1003
+ _See code: [src/commands/datasets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/datasets/rm.ts)_
1009
1004
 
1010
1005
  ## `apify help [COMMAND]`
1011
1006
 
@@ -1029,22 +1024,21 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
1029
1024
 
1030
1025
  ## `apify info`
1031
1026
 
1032
- Displays information about the currently active Apify account.
1027
+ Prints details about your currently authenticated Apify account.
1033
1028
 
1034
1029
  ```
1035
1030
  USAGE
1036
1031
  $ apify info
1037
1032
 
1038
1033
  DESCRIPTION
1039
- Displays information about the currently active Apify account.
1040
- The information is printed to the console.
1034
+ Prints details about your currently authenticated Apify account.
1041
1035
  ```
1042
1036
 
1043
- _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/info.ts)_
1037
+ _See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/info.ts)_
1044
1038
 
1045
1039
  ## `apify init [ACTORNAME]`
1046
1040
 
1047
- Initializes a new Actor project in an existing directory.
1041
+ Sets up an Actor project in your current directory by creating actor.json and storage files.
1048
1042
 
1049
1043
  ```
1050
1044
  USAGE
@@ -1058,53 +1052,52 @@ FLAGS
1058
1052
  still ask for confirmation.
1059
1053
 
1060
1054
  DESCRIPTION
1061
- Initializes a new Actor project in an existing directory.
1055
+ Sets up an Actor project in your current directory by creating actor.json and storage files.
1062
1056
  If the directory contains a Scrapy project in Python, the command automatically creates wrappers so that you can run
1063
1057
  your scrapers without changes.
1058
+ Creates the '.actor/actor.json' file and the 'storage' directory in the current directory, but does not touch any
1059
+ other existing files or directories.
1064
1060
 
1065
- The command creates the ".actor/actor.json" file and the "storage" directory in the current directory, but does not
1066
- touch any other existing files or directories.
1067
-
1068
- WARNING: The directory at "storage" will be overwritten if it already exists.
1061
+ WARNING: Overwrites existing 'storage' directory.
1069
1062
  ```
1070
1063
 
1071
- _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/init.ts)_
1064
+ _See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/init.ts)_
1072
1065
 
1073
1066
  ## `apify key-value-stores`
1074
1067
 
1075
- Commands are designed to be used with Key Value Stores.
1068
+ Manages persistent key-value storage.
1076
1069
 
1077
1070
  ```
1078
1071
  USAGE
1079
1072
  $ apify key-value-stores
1080
1073
 
1081
1074
  DESCRIPTION
1082
- Commands are designed to be used with Key Value Stores.
1075
+ Manages persistent key-value storage.
1083
1076
 
1084
- Aliases: kvs
1077
+ Alias: kvs
1085
1078
  ```
1086
1079
 
1087
- _See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/index.ts)_
1080
+ _See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/index.ts)_
1088
1081
 
1089
1082
  ## `apify key-value-stores create [KEYVALUESTORENAME]`
1090
1083
 
1091
- Creates a new Key-value store on your account
1084
+ Creates a new key-value store on your account.
1092
1085
 
1093
1086
  ```
1094
1087
  USAGE
1095
1088
  $ apify key-value-stores create [KEYVALUESTORENAME] [--json]
1096
1089
 
1097
1090
  ARGUMENTS
1098
- KEYVALUESTORENAME Optional name for the Key-value store
1091
+ KEYVALUESTORENAME Optional name for the key-value store
1099
1092
 
1100
1093
  GLOBAL FLAGS
1101
1094
  --json Format output as json.
1102
1095
 
1103
1096
  DESCRIPTION
1104
- Creates a new Key-value store on your account
1097
+ Creates a new key-value store on your account.
1105
1098
  ```
1106
1099
 
1107
- _See code: [src/commands/key-value-stores/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/create.ts)_
1100
+ _See code: [src/commands/key-value-stores/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/create.ts)_
1108
1101
 
1109
1102
  ## `apify key-value-stores delete-value STOREID ITEMKEY`
1110
1103
 
@@ -1122,11 +1115,11 @@ DESCRIPTION
1122
1115
  Delete a value from a key-value store.
1123
1116
  ```
1124
1117
 
1125
- _See code: [src/commands/key-value-stores/delete-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/delete-value.ts)_
1118
+ _See code: [src/commands/key-value-stores/delete-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/delete-value.ts)_
1126
1119
 
1127
1120
  ## `apify key-value-stores get-value KEYVALUESTOREID ITEMKEY`
1128
1121
 
1129
- Gets a value by key in the given key-value store.
1122
+ Retrieves stored value for specified key. Use --only-content-type to check MIME type.
1130
1123
 
1131
1124
  ```
1132
1125
  USAGE
@@ -1140,10 +1133,10 @@ FLAGS
1140
1133
  --only-content-type Only return the content type of the specified key
1141
1134
 
1142
1135
  DESCRIPTION
1143
- Gets a value by key in the given key-value store.
1136
+ Retrieves stored value for specified key. Use --only-content-type to check MIME type.
1144
1137
  ```
1145
1138
 
1146
- _See code: [src/commands/key-value-stores/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/get-value.ts)_
1139
+ _See code: [src/commands/key-value-stores/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/get-value.ts)_
1147
1140
 
1148
1141
  ## `apify key-value-stores info STOREID`
1149
1142
 
@@ -1163,7 +1156,7 @@ DESCRIPTION
1163
1156
  Shows information about a key-value store.
1164
1157
  ```
1165
1158
 
1166
- _See code: [src/commands/key-value-stores/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/info.ts)_
1159
+ _See code: [src/commands/key-value-stores/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/info.ts)_
1167
1160
 
1168
1161
  ## `apify key-value-stores keys STOREID`
1169
1162
 
@@ -1187,72 +1180,72 @@ DESCRIPTION
1187
1180
  Lists all keys in a key-value store.
1188
1181
  ```
1189
1182
 
1190
- _See code: [src/commands/key-value-stores/keys.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/keys.ts)_
1183
+ _See code: [src/commands/key-value-stores/keys.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/keys.ts)_
1191
1184
 
1192
1185
  ## `apify key-value-stores ls`
1193
1186
 
1194
- Lists all Key-value stores on your account.
1187
+ Lists all key-value stores on your account.
1195
1188
 
1196
1189
  ```
1197
1190
  USAGE
1198
1191
  $ apify key-value-stores ls [--json] [--offset <value>] [--limit <value>] [--desc] [--unnamed]
1199
1192
 
1200
1193
  FLAGS
1201
- --desc Sorts Key-value stores in descending order.
1202
- --limit=<value> [default: 20] Number of Key-value stores that will be listed.
1203
- --offset=<value> Number of Key-value stores that will be skipped.
1204
- --unnamed Lists Key-value stores that don't have a name set.
1194
+ --desc Sorts key-value stores in descending order.
1195
+ --limit=<value> [default: 20] Number of key-value stores that will be listed.
1196
+ --offset=<value> Number of key-value stores that will be skipped.
1197
+ --unnamed Lists key-value stores that don't have a name set.
1205
1198
 
1206
1199
  GLOBAL FLAGS
1207
1200
  --json Format output as json.
1208
1201
 
1209
1202
  DESCRIPTION
1210
- Lists all Key-value stores on your account.
1203
+ Lists all key-value stores on your account.
1211
1204
  ```
1212
1205
 
1213
- _See code: [src/commands/key-value-stores/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/ls.ts)_
1206
+ _See code: [src/commands/key-value-stores/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/ls.ts)_
1214
1207
 
1215
1208
  ## `apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME]`
1216
1209
 
1217
- Renames a Key-value store, or removes its unique name
1210
+ Renames a key-value store, or removes its unique name.
1218
1211
 
1219
1212
  ```
1220
1213
  USAGE
1221
1214
  $ apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME] [--unname]
1222
1215
 
1223
1216
  ARGUMENTS
1224
- KEYVALUESTORENAMEORID The Key-value store ID or name to delete
1225
- NEWNAME The new name for the Key-value store
1217
+ KEYVALUESTORENAMEORID The key-value store ID or name to delete
1218
+ NEWNAME The new name for the key-value store
1226
1219
 
1227
1220
  FLAGS
1228
- --unname Removes the unique name of the Key-value store
1221
+ --unname Removes the unique name of the key-value store
1229
1222
 
1230
1223
  DESCRIPTION
1231
- Renames a Key-value store, or removes its unique name
1224
+ Renames a key-value store, or removes its unique name.
1232
1225
  ```
1233
1226
 
1234
- _See code: [src/commands/key-value-stores/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/rename.ts)_
1227
+ _See code: [src/commands/key-value-stores/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/rename.ts)_
1235
1228
 
1236
1229
  ## `apify key-value-stores rm KEYVALUESTORENAMEORID`
1237
1230
 
1238
- Deletes a Key-value store
1231
+ Permanently removes a key-value store.
1239
1232
 
1240
1233
  ```
1241
1234
  USAGE
1242
1235
  $ apify key-value-stores rm KEYVALUESTORENAMEORID
1243
1236
 
1244
1237
  ARGUMENTS
1245
- KEYVALUESTORENAMEORID The Key-value store ID or name to delete
1238
+ KEYVALUESTORENAMEORID The key-value store ID or name to delete
1246
1239
 
1247
1240
  DESCRIPTION
1248
- Deletes a Key-value store
1241
+ Permanently removes a key-value store.
1249
1242
  ```
1250
1243
 
1251
- _See code: [src/commands/key-value-stores/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/rm.ts)_
1244
+ _See code: [src/commands/key-value-stores/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/rm.ts)_
1252
1245
 
1253
1246
  ## `apify key-value-stores set-value STOREID ITEMKEY [VALUE]`
1254
1247
 
1255
- Sets a value in a key-value store.
1248
+ Stores value with specified key. Set content-type with --content-type flag.
1256
1249
 
1257
1250
  ```
1258
1251
  USAGE
@@ -1268,14 +1261,14 @@ FLAGS
1268
1261
  is assumed.
1269
1262
 
1270
1263
  DESCRIPTION
1271
- Sets a value in a key-value store.
1264
+ Stores value with specified key. Set content-type with --content-type flag.
1272
1265
  ```
1273
1266
 
1274
- _See code: [src/commands/key-value-stores/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/key-value-stores/set-value.ts)_
1267
+ _See code: [src/commands/key-value-stores/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/key-value-stores/set-value.ts)_
1275
1268
 
1276
1269
  ## `apify login`
1277
1270
 
1278
- Logs in to your Apify account.
1271
+ Authenticates your Apify account and saves credentials to '~/.apify'.
1279
1272
 
1280
1273
  ```
1281
1274
  USAGE
@@ -1287,32 +1280,32 @@ FLAGS
1287
1280
  -t, --token=<value> [Optional] Apify API token
1288
1281
 
1289
1282
  DESCRIPTION
1290
- Logs in to your Apify account.
1291
- The API token and other account information is stored in the ~/.apify directory, from where it is read by all other
1292
- "apify" commands. To log out, call "apify logout".
1283
+ Authenticates your Apify account and saves credentials to '~/.apify'.
1284
+ All other commands use these stored credentials.
1285
+
1286
+ Run 'apify logout' to remove authentication.
1293
1287
  ```
1294
1288
 
1295
- _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/login.ts)_
1289
+ _See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/login.ts)_
1296
1290
 
1297
1291
  ## `apify logout`
1298
1292
 
1299
- Logs out of your Apify account.
1293
+ Removes authentication by deleting your API token and account information from '~/.apify'.
1300
1294
 
1301
1295
  ```
1302
1296
  USAGE
1303
1297
  $ apify logout
1304
1298
 
1305
1299
  DESCRIPTION
1306
- Logs out of your Apify account.
1307
- The command deletes the API token and all other account information stored in the ~/.apify directory. To log in again,
1308
- call "apify login".
1300
+ Removes authentication by deleting your API token and account information from '~/.apify'.
1301
+ Run 'apify login' to authenticate again.
1309
1302
  ```
1310
1303
 
1311
- _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/logout.ts)_
1304
+ _See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/logout.ts)_
1312
1305
 
1313
1306
  ## `apify pull [ACTORID]`
1314
1307
 
1315
- 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.
1308
+ Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
1316
1309
 
1317
1310
  ```
1318
1311
  USAGE
@@ -1327,15 +1320,14 @@ FLAGS
1327
1320
  --dir=<value> Directory where the Actor should be pulled to
1328
1321
 
1329
1322
  DESCRIPTION
1330
- Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
1331
- cloned. If it is defined as Web IDE, it will fetch the files.
1323
+ Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
1332
1324
  ```
1333
1325
 
1334
- _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/pull.ts)_
1326
+ _See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/pull.ts)_
1335
1327
 
1336
1328
  ## `apify push [ACTORID]`
1337
1329
 
1338
- Uploads the Actor to the Apify platform and builds it there.
1330
+ Deploys Actor to Apify platform using settings from '.actor/actor.json'.
1339
1331
 
1340
1332
  ```
1341
1333
  USAGE
@@ -1343,13 +1335,13 @@ USAGE
1343
1335
 
1344
1336
  ARGUMENTS
1345
1337
  ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
1346
- command will create or modify the Actor with the name specified in ".actor/actor.json" file.
1338
+ command will create or modify the Actor with the name specified in '.actor/actor.json' file.
1347
1339
 
1348
1340
  FLAGS
1349
1341
  -b, --build-tag=<value> Build tag to be applied to the successful Actor build. By default, it is taken from the
1350
- ".actor/actor.json" file
1342
+ '.actor/actor.json' file
1351
1343
  -v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
1352
- the ".actor/actor.json" file.
1344
+ the '.actor/actor.json' file.
1353
1345
  -w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
1354
1346
  --dir=<value> Directory where the Actor is located
1355
1347
  --force Push an Actor even when the local files are older than the Actor on the platform.
@@ -1357,35 +1349,30 @@ FLAGS
1357
1349
  browser automatically.
1358
1350
 
1359
1351
  DESCRIPTION
1360
- Uploads the Actor to the Apify platform and builds it there.
1361
- The Actor settings are read from the ".actor/actor.json" file in the current directory, but they can be overridden
1362
- using command-line options.
1363
- NOTE: If the source files are smaller than 3 MB then they are uploaded as
1364
- "Multiple source files", otherwise they are uploaded as "Zip file".
1365
-
1366
- When there's an attempt to push files that are older than the Actor on the platform, the command will fail. Can be
1367
- overwritten with --force flag.
1352
+ Deploys Actor to Apify platform using settings from '.actor/actor.json'.
1353
+ Files under '3' MB upload as "Multiple source files"; larger projects upload as ZIP file.
1354
+ Use --force to override newer remote versions.
1368
1355
  ```
1369
1356
 
1370
- _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/push.ts)_
1357
+ _See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/push.ts)_
1371
1358
 
1372
1359
  ## `apify request-queues`
1373
1360
 
1374
- Commands are designed to be used with Request Queues.
1361
+ Manages URL queues for web scraping and automation tasks.
1375
1362
 
1376
1363
  ```
1377
1364
  USAGE
1378
1365
  $ apify request-queues
1379
1366
 
1380
1367
  DESCRIPTION
1381
- Commands are designed to be used with Request Queues.
1368
+ Manages URL queues for web scraping and automation tasks.
1382
1369
  ```
1383
1370
 
1384
- _See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/request-queues/index.ts)_
1371
+ _See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/request-queues/index.ts)_
1385
1372
 
1386
1373
  ## `apify run`
1387
1374
 
1388
- Runs the Actor locally in the current directory.
1375
+ Executes Actor locally with simulated Apify environment variables.
1389
1376
 
1390
1377
  ```
1391
1378
  USAGE
@@ -1408,34 +1395,31 @@ FLAGS
1408
1395
  --purge-queue Deletes the local directory containing the default request queue before the run starts.
1409
1396
 
1410
1397
  DESCRIPTION
1411
- Runs the Actor locally in the current directory.
1412
- It sets various APIFY_XYZ environment variables in order to provide a working execution environment for the Actor. For
1413
- example, this causes the Actor input, as well as all other data in key-value stores, datasets or request queues to be
1414
- stored in the "storage" directory, rather than on the Apify platform.
1398
+ Executes Actor locally with simulated Apify environment variables.
1399
+ Stores data in local 'storage' directory.
1415
1400
 
1416
- NOTE: You can override the command's default behavior for Node.js Actors by overriding the "start" script in the
1417
- package.json file. You can set up your own main file or environment variables by changing it.
1401
+ NOTE: For Node.js Actors, customize behavior by modifying the 'start' script in package.json file.
1418
1402
  ```
1419
1403
 
1420
- _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/run.ts)_
1404
+ _See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/run.ts)_
1421
1405
 
1422
1406
  ## `apify runs`
1423
1407
 
1424
- Commands are designed to be used with Actor Runs.
1408
+ Manages Actor run operations
1425
1409
 
1426
1410
  ```
1427
1411
  USAGE
1428
1412
  $ apify runs
1429
1413
 
1430
1414
  DESCRIPTION
1431
- Commands are designed to be used with Actor Runs.
1415
+ Manages Actor run operations
1432
1416
  ```
1433
1417
 
1434
- _See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/runs/index.ts)_
1418
+ _See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/runs/index.ts)_
1435
1419
 
1436
1420
  ## `apify runs abort RUNID`
1437
1421
 
1438
- Aborts an Actor Run.
1422
+ Aborts an Actor run.
1439
1423
 
1440
1424
  ```
1441
1425
  USAGE
@@ -1451,14 +1435,14 @@ GLOBAL FLAGS
1451
1435
  --json Format output as json.
1452
1436
 
1453
1437
  DESCRIPTION
1454
- Aborts an Actor Run.
1438
+ Aborts an Actor run.
1455
1439
  ```
1456
1440
 
1457
- _See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/runs/abort.ts)_
1441
+ _See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/runs/abort.ts)_
1458
1442
 
1459
1443
  ## `apify runs info RUNID`
1460
1444
 
1461
- Prints information about an Actor Run.
1445
+ Prints information about an Actor run.
1462
1446
 
1463
1447
  ```
1464
1448
  USAGE
@@ -1468,16 +1452,16 @@ ARGUMENTS
1468
1452
  RUNID The run ID to print information about.
1469
1453
 
1470
1454
  FLAGS
1471
- -v, --verbose Prints more in-depth information about the Actor Run.
1455
+ -v, --verbose Prints more in-depth information about the Actor run.
1472
1456
 
1473
1457
  GLOBAL FLAGS
1474
1458
  --json Format output as json.
1475
1459
 
1476
1460
  DESCRIPTION
1477
- Prints information about an Actor Run.
1461
+ Prints information about an Actor run.
1478
1462
  ```
1479
1463
 
1480
- _See code: [src/commands/runs/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/runs/info.ts)_
1464
+ _See code: [src/commands/runs/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/runs/info.ts)_
1481
1465
 
1482
1466
  ## `apify runs log RUNID`
1483
1467
 
@@ -1494,7 +1478,7 @@ DESCRIPTION
1494
1478
  Prints the log of a specific run.
1495
1479
  ```
1496
1480
 
1497
- _See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/runs/log.ts)_
1481
+ _See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/runs/log.ts)_
1498
1482
 
1499
1483
  ## `apify runs ls [ACTORID]`
1500
1484
 
@@ -1520,7 +1504,7 @@ DESCRIPTION
1520
1504
  Lists all runs of the Actor.
1521
1505
  ```
1522
1506
 
1523
- _See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/runs/ls.ts)_
1507
+ _See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/runs/ls.ts)_
1524
1508
 
1525
1509
  ## `apify runs resurrect RUNID`
1526
1510
 
@@ -1540,7 +1524,7 @@ DESCRIPTION
1540
1524
  Resurrects an aborted or finished Actor Run.
1541
1525
  ```
1542
1526
 
1543
- _See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/runs/resurrect.ts)_
1527
+ _See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/runs/resurrect.ts)_
1544
1528
 
1545
1529
  ## `apify runs rm RUNID`
1546
1530
 
@@ -1557,41 +1541,41 @@ DESCRIPTION
1557
1541
  Deletes an Actor Run.
1558
1542
  ```
1559
1543
 
1560
- _See code: [src/commands/runs/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/runs/rm.ts)_
1544
+ _See code: [src/commands/runs/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/runs/rm.ts)_
1561
1545
 
1562
1546
  ## `apify secrets`
1563
1547
 
1564
- Manages secret values for Actor environment variables.
1548
+ Manages secure environment variables for Actors.
1565
1549
 
1566
1550
  ```
1567
1551
  USAGE
1568
1552
  $ apify secrets
1569
1553
 
1570
1554
  DESCRIPTION
1571
- Manages secret values for Actor environment variables.
1555
+ Manages secure environment variables for Actors.
1572
1556
 
1573
1557
  Example:
1574
1558
  $ apify secrets add mySecret TopSecretValue123
1575
1559
 
1576
- Now the "mySecret" value can be used in an environment variable defined in ".actor/actor.json" file by adding the "@"
1560
+ The "mySecret" value can be used in an environment variable defined in '.actor/actor.json' file by adding the "@"
1577
1561
  prefix:
1578
1562
 
1579
1563
  {
1580
1564
  "actorSpecification": 1,
1581
1565
  "name": "my_actor",
1582
1566
  "environmentVariables": { "SECRET_ENV_VAR": "@mySecret" },
1583
- "version": "0.1
1567
+ "version": "0.1"
1584
1568
  }
1585
1569
 
1586
1570
  When the Actor is pushed to Apify cloud, the "SECRET_ENV_VAR" and its value is stored as a secret environment variable
1587
1571
  of the Actor.
1588
1572
  ```
1589
1573
 
1590
- _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/secrets/index.ts)_
1574
+ _See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/secrets/index.ts)_
1591
1575
 
1592
1576
  ## `apify secrets add NAME VALUE`
1593
1577
 
1594
- Adds a new secret value.
1578
+ Adds a new secret to '~/.apify' for use in Actor environment variables.
1595
1579
 
1596
1580
  ```
1597
1581
  USAGE
@@ -1602,15 +1586,14 @@ ARGUMENTS
1602
1586
  VALUE Value of the secret
1603
1587
 
1604
1588
  DESCRIPTION
1605
- Adds a new secret value.
1606
- The secrets are stored to a file at ~/.apify
1589
+ Adds a new secret to '~/.apify' for use in Actor environment variables.
1607
1590
  ```
1608
1591
 
1609
- _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/secrets/add.ts)_
1592
+ _See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/secrets/add.ts)_
1610
1593
 
1611
1594
  ## `apify secrets rm NAME`
1612
1595
 
1613
- Removes the secret.
1596
+ Permanently deletes a secret from your stored credentials.
1614
1597
 
1615
1598
  ```
1616
1599
  USAGE
@@ -1620,28 +1603,28 @@ ARGUMENTS
1620
1603
  NAME Name of the secret
1621
1604
 
1622
1605
  DESCRIPTION
1623
- Removes the secret.
1606
+ Permanently deletes a secret from your stored credentials.
1624
1607
  ```
1625
1608
 
1626
- _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/secrets/rm.ts)_
1609
+ _See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/secrets/rm.ts)_
1627
1610
 
1628
1611
  ## `apify task`
1629
1612
 
1630
- Commands are designed to be used to interact with Tasks.
1613
+ Manages scheduled and predefined Actor configurations.
1631
1614
 
1632
1615
  ```
1633
1616
  USAGE
1634
1617
  $ apify task
1635
1618
 
1636
1619
  DESCRIPTION
1637
- Commands are designed to be used to interact with Tasks.
1620
+ Manages scheduled and predefined Actor configurations.
1638
1621
  ```
1639
1622
 
1640
- _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/task/index.ts)_
1623
+ _See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/task/index.ts)_
1641
1624
 
1642
1625
  ## `apify task run TASKID`
1643
1626
 
1644
- Runs a specific Actor remotely on the Apify cloud platform.
1627
+ Executes predefined Actor task remotely using local key-value store for input.
1645
1628
 
1646
1629
  ```
1647
1630
  USAGE
@@ -1656,16 +1639,15 @@ FLAGS
1656
1639
  -t, --timeout=<value> Timeout for the Task run in seconds. Zero value means there is no timeout.
1657
1640
 
1658
1641
  DESCRIPTION
1659
- Runs a specific Actor remotely on the Apify cloud platform.
1660
- The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
1661
- takes input for the Actor from the default local key-value store by default.
1642
+ Executes predefined Actor task remotely using local key-value store for input.
1643
+ Customize with --memory and --timeout flags.
1662
1644
  ```
1663
1645
 
1664
- _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/task/run.ts)_
1646
+ _See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/task/run.ts)_
1665
1647
 
1666
1648
  ## `apify validate-schema [PATH]`
1667
1649
 
1668
- Validates input schema and prints errors found.
1650
+ Validates Actor input schema from one of these locations (in priority order):
1669
1651
 
1670
1652
  ```
1671
1653
  USAGE
@@ -1675,17 +1657,15 @@ ARGUMENTS
1675
1657
  PATH Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
1676
1658
 
1677
1659
  DESCRIPTION
1678
- Validates input schema and prints errors found.
1679
- The input schema for the Actor is used from these locations in order of preference.
1680
- The first one found is validated as it would be the one used on the Apify platform.
1681
- 1. Directly embedded object in ".actor/actor.json" under 'input' key
1682
- 2. Path to JSON file referenced in ".actor/actor.json" under 'input' key
1683
- 3. JSON file at .actor/INPUT_SCHEMA.json
1684
- 4. JSON file at INPUT_SCHEMA.json
1660
+ Validates Actor input schema from one of these locations (in priority order):
1661
+ 1. Object in '.actor/actor.json' under "input" key
1662
+ 2. JSON file path in '.actor/actor.json' "input" key
1663
+ 3. .actor/INPUT_SCHEMA.json
1664
+ 4. INPUT_SCHEMA.json
1685
1665
 
1686
- You can also pass any custom path to your input schema to have it validated instead.
1666
+ Optionally specify custom schema path to validate.
1687
1667
  ```
1688
1668
 
1689
- _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.91/src/commands/validate-schema.ts)_
1669
+ _See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0/src/commands/validate-schema.ts)_
1690
1670
  <!-- commandsstop -->
1691
1671
  <!-- prettier-ignore-end -->