apify-cli 1.0.0-beta.14 → 1.0.0-beta.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -40
- package/dist/.tsbuildinfo +1 -1
- package/dist/commands/secrets/index.js +1 -1
- package/dist/lib/secrets.js +3 -3
- package/oclif.manifest.json +2 -2
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -276,10 +276,10 @@ This section contains printouts of `apify help` for all commands.
|
|
|
276
276
|
|
|
277
277
|
<!-- commands -->
|
|
278
278
|
* [`apify actor`](#apify-actor)
|
|
279
|
-
* [`apify actor
|
|
280
|
-
* [`apify actor
|
|
281
|
-
* [`apify actor
|
|
282
|
-
* [`apify actor
|
|
279
|
+
* [`apify actor get-input`](#apify-actor-get-input)
|
|
280
|
+
* [`apify actor get-value KEY`](#apify-actor-get-value-key)
|
|
281
|
+
* [`apify actor push-data [ITEM]`](#apify-actor-push-data-item)
|
|
282
|
+
* [`apify actor set-value KEY [VALUE]`](#apify-actor-set-value-key-value)
|
|
283
283
|
* [`apify call [ACTORID]`](#apify-call-actorid)
|
|
284
284
|
* [`apify create [ACTORNAME]`](#apify-create-actorname)
|
|
285
285
|
* [`apify help [COMMAND]`](#apify-help-command)
|
|
@@ -291,8 +291,8 @@ This section contains printouts of `apify help` for all commands.
|
|
|
291
291
|
* [`apify push [ACTORID]`](#apify-push-actorid)
|
|
292
292
|
* [`apify run`](#apify-run)
|
|
293
293
|
* [`apify secrets`](#apify-secrets)
|
|
294
|
-
* [`apify secrets
|
|
295
|
-
* [`apify secrets
|
|
294
|
+
* [`apify secrets add NAME VALUE`](#apify-secrets-add-name-value)
|
|
295
|
+
* [`apify secrets rm NAME`](#apify-secrets-rm-name)
|
|
296
296
|
* [`apify vis [PATH]`](#apify-vis-path)
|
|
297
297
|
|
|
298
298
|
## `apify actor`
|
|
@@ -307,29 +307,29 @@ DESCRIPTION
|
|
|
307
307
|
Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
|
|
308
308
|
```
|
|
309
309
|
|
|
310
|
-
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
310
|
+
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/actor/index.ts)_
|
|
311
311
|
|
|
312
|
-
## `apify actor
|
|
312
|
+
## `apify actor get-input`
|
|
313
313
|
|
|
314
314
|
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
315
315
|
|
|
316
316
|
```
|
|
317
317
|
USAGE
|
|
318
|
-
$ apify actor
|
|
318
|
+
$ apify actor get-input
|
|
319
319
|
|
|
320
320
|
DESCRIPTION
|
|
321
321
|
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
322
322
|
```
|
|
323
323
|
|
|
324
|
-
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
324
|
+
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/actor/get-input.ts)_
|
|
325
325
|
|
|
326
|
-
## `apify actor
|
|
326
|
+
## `apify actor get-value KEY`
|
|
327
327
|
|
|
328
328
|
Gets a value from the default key-value store associated with the Actor run.
|
|
329
329
|
|
|
330
330
|
```
|
|
331
331
|
USAGE
|
|
332
|
-
$ apify actor
|
|
332
|
+
$ apify actor get-value KEY
|
|
333
333
|
|
|
334
334
|
ARGUMENTS
|
|
335
335
|
KEY Key of the record in key-value store
|
|
@@ -338,15 +338,15 @@ DESCRIPTION
|
|
|
338
338
|
Gets a value from the default key-value store associated with the Actor run.
|
|
339
339
|
```
|
|
340
340
|
|
|
341
|
-
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
341
|
+
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/actor/get-value.ts)_
|
|
342
342
|
|
|
343
|
-
## `apify actor
|
|
343
|
+
## `apify actor push-data [ITEM]`
|
|
344
344
|
|
|
345
345
|
Stores an object or an array of objects to the default dataset of the Actor run.
|
|
346
346
|
|
|
347
347
|
```
|
|
348
348
|
USAGE
|
|
349
|
-
$ apify actor
|
|
349
|
+
$ apify actor push-data [ITEM]
|
|
350
350
|
|
|
351
351
|
ARGUMENTS
|
|
352
352
|
ITEM JSON string with one object or array of objects containing data to be stored in the default dataset.
|
|
@@ -360,15 +360,15 @@ DESCRIPTION
|
|
|
360
360
|
$ cat ./test.json | apify actor:push-data
|
|
361
361
|
```
|
|
362
362
|
|
|
363
|
-
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
363
|
+
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/actor/push-data.ts)_
|
|
364
364
|
|
|
365
|
-
## `apify actor
|
|
365
|
+
## `apify actor set-value KEY [VALUE]`
|
|
366
366
|
|
|
367
367
|
Sets or removes record into the default KeyValueStore associated with the Actor run.
|
|
368
368
|
|
|
369
369
|
```
|
|
370
370
|
USAGE
|
|
371
|
-
$ apify actor
|
|
371
|
+
$ apify actor set-value KEY [VALUE] [-c <value>]
|
|
372
372
|
|
|
373
373
|
ARGUMENTS
|
|
374
374
|
KEY Key of the record in key-value store.
|
|
@@ -389,7 +389,7 @@ DESCRIPTION
|
|
|
389
389
|
$ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain
|
|
390
390
|
```
|
|
391
391
|
|
|
392
|
-
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
392
|
+
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/actor/set-value.ts)_
|
|
393
393
|
|
|
394
394
|
## `apify call [ACTORID]`
|
|
395
395
|
|
|
@@ -415,7 +415,7 @@ DESCRIPTION
|
|
|
415
415
|
takes input for the Actor from the default local key-value store by default.
|
|
416
416
|
```
|
|
417
417
|
|
|
418
|
-
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
418
|
+
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/call.ts)_
|
|
419
419
|
|
|
420
420
|
## `apify create [ACTORNAME]`
|
|
421
421
|
|
|
@@ -439,7 +439,7 @@ DESCRIPTION
|
|
|
439
439
|
Creates a new Actor project directory from a selected boilerplate template.
|
|
440
440
|
```
|
|
441
441
|
|
|
442
|
-
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
442
|
+
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/create.ts)_
|
|
443
443
|
|
|
444
444
|
## `apify help [COMMAND]`
|
|
445
445
|
|
|
@@ -447,10 +447,10 @@ Display help for apify.
|
|
|
447
447
|
|
|
448
448
|
```
|
|
449
449
|
USAGE
|
|
450
|
-
$ apify help [COMMAND] [-n]
|
|
450
|
+
$ apify help [COMMAND...] [-n]
|
|
451
451
|
|
|
452
452
|
ARGUMENTS
|
|
453
|
-
COMMAND Command to show help for.
|
|
453
|
+
COMMAND... Command to show help for.
|
|
454
454
|
|
|
455
455
|
FLAGS
|
|
456
456
|
-n, --nested-commands Include all nested commands in the output.
|
|
@@ -459,7 +459,7 @@ DESCRIPTION
|
|
|
459
459
|
Display help for apify.
|
|
460
460
|
```
|
|
461
461
|
|
|
462
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.
|
|
462
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.18/src/commands/help.ts)_
|
|
463
463
|
|
|
464
464
|
## `apify info`
|
|
465
465
|
|
|
@@ -474,7 +474,7 @@ DESCRIPTION
|
|
|
474
474
|
The information is printed to the console.
|
|
475
475
|
```
|
|
476
476
|
|
|
477
|
-
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
477
|
+
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/info.ts)_
|
|
478
478
|
|
|
479
479
|
## `apify init [ACTORNAME]`
|
|
480
480
|
|
|
@@ -502,7 +502,7 @@ DESCRIPTION
|
|
|
502
502
|
WARNING: The directory at "storage" will be overwritten if it already exists.
|
|
503
503
|
```
|
|
504
504
|
|
|
505
|
-
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
505
|
+
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/init.ts)_
|
|
506
506
|
|
|
507
507
|
## `apify login`
|
|
508
508
|
|
|
@@ -523,7 +523,7 @@ DESCRIPTION
|
|
|
523
523
|
"apify" commands. To log out, call "apify logout".
|
|
524
524
|
```
|
|
525
525
|
|
|
526
|
-
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
526
|
+
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/login.ts)_
|
|
527
527
|
|
|
528
528
|
## `apify logout`
|
|
529
529
|
|
|
@@ -539,7 +539,7 @@ DESCRIPTION
|
|
|
539
539
|
call "apify login".
|
|
540
540
|
```
|
|
541
541
|
|
|
542
|
-
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
542
|
+
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/logout.ts)_
|
|
543
543
|
|
|
544
544
|
## `apify pull [ACTORID]`
|
|
545
545
|
|
|
@@ -561,7 +561,7 @@ DESCRIPTION
|
|
|
561
561
|
cloned. If it is defined as Web IDE, it will fetch the files.
|
|
562
562
|
```
|
|
563
563
|
|
|
564
|
-
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
564
|
+
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/pull.ts)_
|
|
565
565
|
|
|
566
566
|
## `apify push [ACTORID]`
|
|
567
567
|
|
|
@@ -599,7 +599,7 @@ DESCRIPTION
|
|
|
599
599
|
overwritten with --force flag.
|
|
600
600
|
```
|
|
601
601
|
|
|
602
|
-
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
602
|
+
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/push.ts)_
|
|
603
603
|
|
|
604
604
|
## `apify run`
|
|
605
605
|
|
|
@@ -627,7 +627,7 @@ DESCRIPTION
|
|
|
627
627
|
package.json file. You can set up your own main file or environment variables by changing it.
|
|
628
628
|
```
|
|
629
629
|
|
|
630
|
-
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
630
|
+
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/run.ts)_
|
|
631
631
|
|
|
632
632
|
## `apify secrets`
|
|
633
633
|
|
|
@@ -641,7 +641,7 @@ DESCRIPTION
|
|
|
641
641
|
Manages secret values for Actor environment variables.
|
|
642
642
|
|
|
643
643
|
Example:
|
|
644
|
-
$ apify secrets
|
|
644
|
+
$ apify secrets add mySecret TopSecretValue123
|
|
645
645
|
|
|
646
646
|
Now the "mySecret" value can be used in an environment variable defined in ".actor/actor.json" file by adding the "@"
|
|
647
647
|
prefix:
|
|
@@ -657,15 +657,15 @@ DESCRIPTION
|
|
|
657
657
|
of the Actor.
|
|
658
658
|
```
|
|
659
659
|
|
|
660
|
-
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
660
|
+
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/secrets/index.ts)_
|
|
661
661
|
|
|
662
|
-
## `apify secrets
|
|
662
|
+
## `apify secrets add NAME VALUE`
|
|
663
663
|
|
|
664
664
|
Adds a new secret value.
|
|
665
665
|
|
|
666
666
|
```
|
|
667
667
|
USAGE
|
|
668
|
-
$ apify secrets
|
|
668
|
+
$ apify secrets add NAME VALUE
|
|
669
669
|
|
|
670
670
|
ARGUMENTS
|
|
671
671
|
NAME Name of the secret
|
|
@@ -676,15 +676,15 @@ DESCRIPTION
|
|
|
676
676
|
The secrets are stored to a file at ~/.apify
|
|
677
677
|
```
|
|
678
678
|
|
|
679
|
-
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
679
|
+
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/secrets/add.ts)_
|
|
680
680
|
|
|
681
|
-
## `apify secrets
|
|
681
|
+
## `apify secrets rm NAME`
|
|
682
682
|
|
|
683
683
|
Removes the secret.
|
|
684
684
|
|
|
685
685
|
```
|
|
686
686
|
USAGE
|
|
687
|
-
$ apify secrets
|
|
687
|
+
$ apify secrets rm NAME
|
|
688
688
|
|
|
689
689
|
ARGUMENTS
|
|
690
690
|
NAME Name of the secret
|
|
@@ -693,7 +693,7 @@ DESCRIPTION
|
|
|
693
693
|
Removes the secret.
|
|
694
694
|
```
|
|
695
695
|
|
|
696
|
-
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
696
|
+
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/secrets/rm.ts)_
|
|
697
697
|
|
|
698
698
|
## `apify vis [PATH]`
|
|
699
699
|
|
|
@@ -718,5 +718,5 @@ DESCRIPTION
|
|
|
718
718
|
You can also pass any custom path to your input schema to have it validated instead.
|
|
719
719
|
```
|
|
720
720
|
|
|
721
|
-
_See code: [src/commands/vis.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
721
|
+
_See code: [src/commands/vis.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.16/src/commands/vis.ts)_
|
|
722
722
|
<!-- commandsstop -->
|