apify-cli 0.21.0-beta.5 → 0.21.0-beta.51
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 +381 -70
- package/dist/.tsbuildinfo +1 -1
- package/dist/commands/actor/get-input.js +1 -6
- package/dist/commands/actor/get-input.js.map +1 -1
- package/dist/commands/actor/get-value.js +7 -17
- package/dist/commands/actor/get-value.js.map +1 -1
- package/dist/commands/actor/index.js +1 -6
- package/dist/commands/actor/index.js.map +1 -1
- package/dist/commands/actor/push-data.js +12 -22
- package/dist/commands/actor/push-data.js.map +1 -1
- package/dist/commands/actor/set-value.js +27 -50
- package/dist/commands/actor/set-value.js.map +1 -1
- package/dist/commands/actors/build.d.ts +4 -0
- package/dist/commands/actors/build.d.ts.map +1 -0
- package/dist/commands/actors/build.js +4 -0
- package/dist/commands/actors/build.js.map +1 -0
- package/dist/commands/actors/call.d.ts +30 -0
- package/dist/commands/actors/call.d.ts.map +1 -0
- package/dist/commands/actors/call.js +221 -0
- package/dist/commands/actors/call.js.map +1 -0
- package/dist/commands/actors/index.js +1 -6
- package/dist/commands/actors/index.js.map +1 -1
- package/dist/commands/actors/ls.d.ts +15 -0
- package/dist/commands/actors/ls.d.ts.map +1 -0
- package/dist/commands/actors/ls.js +168 -0
- package/dist/commands/actors/ls.js.map +1 -0
- package/dist/commands/actors/pull.d.ts +13 -0
- package/dist/commands/actors/pull.d.ts.map +1 -0
- package/dist/commands/actors/pull.js +151 -0
- package/dist/commands/actors/pull.js.map +1 -0
- package/dist/commands/actors/push.d.ts +18 -0
- package/dist/commands/actors/push.d.ts.map +1 -0
- package/dist/commands/actors/push.js +306 -0
- package/dist/commands/actors/push.js.map +1 -0
- package/dist/commands/actors/rm.d.ts +9 -0
- package/dist/commands/actors/rm.d.ts.map +1 -0
- package/dist/commands/actors/rm.js +42 -0
- package/dist/commands/actors/rm.js.map +1 -0
- package/dist/commands/actors/start.d.ts +18 -0
- package/dist/commands/actors/start.d.ts.map +1 -0
- package/dist/commands/actors/start.js +124 -0
- package/dist/commands/actors/start.js.map +1 -0
- package/dist/commands/builds/create.d.ts +3 -1
- package/dist/commands/builds/create.d.ts.map +1 -1
- package/dist/commands/builds/create.js +35 -37
- package/dist/commands/builds/create.js.map +1 -1
- package/dist/commands/builds/index.js +1 -6
- package/dist/commands/builds/index.js.map +1 -1
- package/dist/commands/builds/info.js +11 -26
- package/dist/commands/builds/info.js.map +1 -1
- package/dist/commands/builds/log.d.ts.map +1 -1
- package/dist/commands/builds/log.js +12 -19
- package/dist/commands/builds/log.js.map +1 -1
- package/dist/commands/builds/ls.d.ts +3 -1
- package/dist/commands/builds/ls.d.ts.map +1 -1
- package/dist/commands/builds/ls.js +40 -45
- package/dist/commands/builds/ls.js.map +1 -1
- package/dist/commands/builds/rm.d.ts +9 -0
- package/dist/commands/builds/rm.d.ts.map +1 -0
- package/dist/commands/builds/rm.js +58 -0
- package/dist/commands/builds/rm.js.map +1 -0
- package/dist/commands/call.d.ts +2 -18
- package/dist/commands/call.d.ts.map +1 -1
- package/dist/commands/call.js +2 -181
- package/dist/commands/call.js.map +1 -1
- package/dist/commands/check-version.js +8 -28
- package/dist/commands/check-version.js.map +1 -1
- package/dist/commands/create.js +29 -44
- package/dist/commands/create.js.map +1 -1
- package/dist/commands/datasets/get-items.d.ts +17 -0
- package/dist/commands/datasets/get-items.d.ts.map +1 -0
- package/dist/commands/datasets/get-items.js +82 -0
- package/dist/commands/datasets/get-items.js.map +1 -0
- package/dist/commands/datasets/index.js +1 -6
- package/dist/commands/datasets/index.js.map +1 -1
- package/dist/commands/edit-input-schema.js +9 -29
- package/dist/commands/edit-input-schema.js.map +1 -1
- package/dist/commands/info.js +2 -7
- package/dist/commands/info.js.map +1 -1
- package/dist/commands/init-wrap-scrapy.js +9 -24
- package/dist/commands/init-wrap-scrapy.js.map +1 -1
- package/dist/commands/init.js +18 -33
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/key-value-stores/get-value.d.ts +15 -0
- package/dist/commands/key-value-stores/get-value.d.ts.map +1 -0
- package/dist/commands/key-value-stores/get-value.js +92 -0
- package/dist/commands/key-value-stores/get-value.js.map +1 -0
- package/dist/commands/key-value-stores/index.d.ts +1 -0
- package/dist/commands/key-value-stores/index.d.ts.map +1 -1
- package/dist/commands/key-value-stores/index.js +2 -6
- package/dist/commands/key-value-stores/index.js.map +1 -1
- package/dist/commands/login.js +16 -26
- package/dist/commands/login.js.map +1 -1
- package/dist/commands/logout.js +2 -7
- package/dist/commands/logout.js.map +1 -1
- package/dist/commands/pull.d.ts +2 -10
- package/dist/commands/pull.d.ts.map +1 -1
- package/dist/commands/pull.js +2 -160
- package/dist/commands/pull.js.map +1 -1
- package/dist/commands/push.d.ts +2 -16
- package/dist/commands/push.d.ts.map +1 -1
- package/dist/commands/push.js +2 -323
- package/dist/commands/push.js.map +1 -1
- package/dist/commands/request-queues/index.js +1 -6
- package/dist/commands/request-queues/index.js.map +1 -1
- package/dist/commands/run.d.ts.map +1 -1
- package/dist/commands/run.js +67 -62
- package/dist/commands/run.js.map +1 -1
- package/dist/commands/runs/abort.d.ts.map +1 -1
- package/dist/commands/runs/abort.js +21 -39
- package/dist/commands/runs/abort.js.map +1 -1
- package/dist/commands/runs/index.js +1 -6
- package/dist/commands/runs/index.js.map +1 -1
- package/dist/commands/runs/info.d.ts +45 -0
- package/dist/commands/runs/info.d.ts.map +1 -0
- package/dist/commands/runs/info.js +236 -0
- package/dist/commands/runs/info.js.map +1 -0
- package/dist/commands/runs/log.js +9 -19
- package/dist/commands/runs/log.js.map +1 -1
- package/dist/commands/runs/ls.d.ts +3 -1
- package/dist/commands/runs/ls.d.ts.map +1 -1
- package/dist/commands/runs/ls.js +34 -45
- package/dist/commands/runs/ls.js.map +1 -1
- package/dist/commands/runs/resurrect.d.ts.map +1 -1
- package/dist/commands/runs/resurrect.js +12 -25
- package/dist/commands/runs/resurrect.js.map +1 -1
- package/dist/commands/runs/rm.d.ts +9 -0
- package/dist/commands/runs/rm.d.ts.map +1 -0
- package/dist/commands/runs/rm.js +57 -0
- package/dist/commands/runs/rm.js.map +1 -0
- package/dist/commands/secrets/add.js +7 -17
- package/dist/commands/secrets/add.js.map +1 -1
- package/dist/commands/secrets/index.js +6 -11
- package/dist/commands/secrets/index.js.map +1 -1
- package/dist/commands/secrets/rm.js +7 -17
- package/dist/commands/secrets/rm.js.map +1 -1
- package/dist/commands/task/index.js +1 -6
- package/dist/commands/task/index.js.map +1 -1
- package/dist/commands/task/run.d.ts +0 -1
- package/dist/commands/task/run.d.ts.map +1 -1
- package/dist/commands/task/run.js +30 -30
- package/dist/commands/task/run.js.map +1 -1
- package/dist/commands/validate-schema.js +17 -32
- package/dist/commands/validate-schema.js.map +1 -1
- package/dist/lib/apify_command.d.ts +1 -0
- package/dist/lib/apify_command.d.ts.map +1 -1
- package/dist/lib/apify_command.js +6 -21
- package/dist/lib/apify_command.js.map +1 -1
- package/dist/lib/commands/confirm.d.ts +6 -0
- package/dist/lib/commands/confirm.d.ts.map +1 -0
- package/dist/lib/commands/confirm.js +26 -0
- package/dist/lib/commands/confirm.js.map +1 -0
- package/dist/lib/commands/pretty-print-bytes.d.ts +1 -1
- package/dist/lib/commands/pretty-print-bytes.d.ts.map +1 -1
- package/dist/lib/commands/pretty-print-bytes.js +6 -3
- package/dist/lib/commands/pretty-print-bytes.js.map +1 -1
- package/dist/lib/commands/responsive-table.d.ts +15 -1
- package/dist/lib/commands/responsive-table.d.ts.map +1 -1
- package/dist/lib/commands/responsive-table.js +36 -14
- package/dist/lib/commands/responsive-table.js.map +1 -1
- package/dist/lib/commands/run-on-cloud.d.ts +3 -2
- package/dist/lib/commands/run-on-cloud.d.ts.map +1 -1
- package/dist/lib/commands/run-on-cloud.js +42 -18
- package/dist/lib/commands/run-on-cloud.js.map +1 -1
- package/dist/lib/consts.d.ts.map +1 -1
- package/dist/lib/consts.js +11 -1
- package/dist/lib/consts.js.map +1 -1
- package/dist/lib/input_schema.d.ts.map +1 -1
- package/dist/lib/input_schema.js +14 -12
- package/dist/lib/input_schema.js.map +1 -1
- package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.js +3 -18
- package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.js.map +1 -1
- package/dist/lib/projects/scrapy/Spider.js +4 -24
- package/dist/lib/projects/scrapy/Spider.js.map +1 -1
- package/dist/lib/projects/scrapy/SpiderFileAnalyzer.js +1 -6
- package/dist/lib/projects/scrapy/SpiderFileAnalyzer.js.map +1 -1
- package/dist/lib/projects/scrapy/wrapScrapyProject.d.ts.map +1 -1
- package/dist/lib/projects/scrapy/wrapScrapyProject.js +3 -2
- package/dist/lib/projects/scrapy/wrapScrapyProject.js.map +1 -1
- package/dist/lib/telemetry.d.ts.map +1 -1
- package/dist/lib/telemetry.js +1 -0
- package/dist/lib/telemetry.js.map +1 -1
- package/dist/lib/utils.d.ts +1 -1
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +1 -1
- package/dist/lib/utils.js.map +1 -1
- package/dist/lib/version_check.d.ts +1 -1
- package/dist/lib/version_check.d.ts.map +1 -1
- package/dist/lib/version_check.js +6 -0
- package/dist/lib/version_check.js.map +1 -1
- package/dist/typechecking.tsbuildinfo +1 -1
- package/oclif.manifest.json +781 -152
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -288,18 +288,28 @@ 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 actors build [ACTORID]`](#apify-actors-build-actorid)
|
|
292
|
+
* [`apify actors call [ACTORID]`](#apify-actors-call-actorid)
|
|
293
|
+
* [`apify actors ls`](#apify-actors-ls)
|
|
294
|
+
* [`apify actors pull [ACTORID]`](#apify-actors-pull-actorid)
|
|
295
|
+
* [`apify actors push [ACTORID]`](#apify-actors-push-actorid)
|
|
296
|
+
* [`apify actors rm ACTORID`](#apify-actors-rm-actorid)
|
|
297
|
+
* [`apify actors start [ACTORID]`](#apify-actors-start-actorid)
|
|
291
298
|
* [`apify builds`](#apify-builds)
|
|
292
|
-
* [`apify builds create`](#apify-builds-create)
|
|
299
|
+
* [`apify builds create [ACTORID]`](#apify-builds-create-actorid)
|
|
293
300
|
* [`apify builds info BUILDID`](#apify-builds-info-buildid)
|
|
294
301
|
* [`apify builds log BUILDID`](#apify-builds-log-buildid)
|
|
295
|
-
* [`apify builds ls`](#apify-builds-ls)
|
|
302
|
+
* [`apify builds ls [ACTORID]`](#apify-builds-ls-actorid)
|
|
303
|
+
* [`apify builds rm BUILDID`](#apify-builds-rm-buildid)
|
|
296
304
|
* [`apify call [ACTORID]`](#apify-call-actorid)
|
|
297
305
|
* [`apify create [ACTORNAME]`](#apify-create-actorname)
|
|
298
306
|
* [`apify datasets`](#apify-datasets)
|
|
307
|
+
* [`apify datasets get-items DATASETID`](#apify-datasets-get-items-datasetid)
|
|
299
308
|
* [`apify help [COMMAND]`](#apify-help-command)
|
|
300
309
|
* [`apify info`](#apify-info)
|
|
301
310
|
* [`apify init [ACTORNAME]`](#apify-init-actorname)
|
|
302
311
|
* [`apify key-value-stores`](#apify-key-value-stores)
|
|
312
|
+
* [`apify key-value-stores get-value KEYVALUESTOREID ITEMKEY`](#apify-key-value-stores-get-value-keyvaluestoreid-itemkey)
|
|
303
313
|
* [`apify login`](#apify-login)
|
|
304
314
|
* [`apify logout`](#apify-logout)
|
|
305
315
|
* [`apify pull [ACTORID]`](#apify-pull-actorid)
|
|
@@ -308,9 +318,11 @@ This section contains printouts of `apify help` for all commands.
|
|
|
308
318
|
* [`apify run`](#apify-run)
|
|
309
319
|
* [`apify runs`](#apify-runs)
|
|
310
320
|
* [`apify runs abort RUNID`](#apify-runs-abort-runid)
|
|
321
|
+
* [`apify runs info RUNID`](#apify-runs-info-runid)
|
|
311
322
|
* [`apify runs log RUNID`](#apify-runs-log-runid)
|
|
312
|
-
* [`apify runs ls`](#apify-runs-ls)
|
|
323
|
+
* [`apify runs ls [ACTORID]`](#apify-runs-ls-actorid)
|
|
313
324
|
* [`apify runs resurrect RUNID`](#apify-runs-resurrect-runid)
|
|
325
|
+
* [`apify runs rm RUNID`](#apify-runs-rm-runid)
|
|
314
326
|
* [`apify secrets`](#apify-secrets)
|
|
315
327
|
* [`apify secrets add NAME VALUE`](#apify-secrets-add-name-value)
|
|
316
328
|
* [`apify secrets rm NAME`](#apify-secrets-rm-name)
|
|
@@ -330,7 +342,7 @@ DESCRIPTION
|
|
|
330
342
|
Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
|
|
331
343
|
```
|
|
332
344
|
|
|
333
|
-
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
345
|
+
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actor/index.ts)_
|
|
334
346
|
|
|
335
347
|
## `apify actor get-input`
|
|
336
348
|
|
|
@@ -344,7 +356,7 @@ DESCRIPTION
|
|
|
344
356
|
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
345
357
|
```
|
|
346
358
|
|
|
347
|
-
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
359
|
+
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actor/get-input.ts)_
|
|
348
360
|
|
|
349
361
|
## `apify actor get-value KEY`
|
|
350
362
|
|
|
@@ -361,7 +373,7 @@ DESCRIPTION
|
|
|
361
373
|
Gets a value from the default key-value store associated with the Actor run.
|
|
362
374
|
```
|
|
363
375
|
|
|
364
|
-
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
376
|
+
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actor/get-value.ts)_
|
|
365
377
|
|
|
366
378
|
## `apify actor push-data [ITEM]`
|
|
367
379
|
|
|
@@ -383,7 +395,7 @@ DESCRIPTION
|
|
|
383
395
|
$ cat ./test.json | apify actor push-data
|
|
384
396
|
```
|
|
385
397
|
|
|
386
|
-
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
398
|
+
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actor/push-data.ts)_
|
|
387
399
|
|
|
388
400
|
## `apify actor set-value KEY [VALUE]`
|
|
389
401
|
|
|
@@ -412,7 +424,7 @@ DESCRIPTION
|
|
|
412
424
|
$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
|
|
413
425
|
```
|
|
414
426
|
|
|
415
|
-
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
427
|
+
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actor/set-value.ts)_
|
|
416
428
|
|
|
417
429
|
## `apify actors`
|
|
418
430
|
|
|
@@ -426,7 +438,199 @@ DESCRIPTION
|
|
|
426
438
|
Commands are designed to be used with Actors.
|
|
427
439
|
```
|
|
428
440
|
|
|
429
|
-
_See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
441
|
+
_See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/index.ts)_
|
|
442
|
+
|
|
443
|
+
## `apify actors build [ACTORID]`
|
|
444
|
+
|
|
445
|
+
Creates a new build of the Actor.
|
|
446
|
+
|
|
447
|
+
```
|
|
448
|
+
USAGE
|
|
449
|
+
$ apify actors build [ACTORID] [--json] [--tag <value>] [--version <value>] [--log]
|
|
450
|
+
|
|
451
|
+
ARGUMENTS
|
|
452
|
+
ACTORID Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the current
|
|
453
|
+
directory.
|
|
454
|
+
|
|
455
|
+
FLAGS
|
|
456
|
+
--log Whether to print out the build log after the build is triggered.
|
|
457
|
+
--tag=<value> Build tag to be applied to the successful Actor build. By default, this is "latest".
|
|
458
|
+
--version=<value> Optional Actor Version to build. By default, this will be inferred from the tag, but this flag is
|
|
459
|
+
required when multiple versions have the same tag.
|
|
460
|
+
|
|
461
|
+
GLOBAL FLAGS
|
|
462
|
+
--json Format output as json.
|
|
463
|
+
|
|
464
|
+
DESCRIPTION
|
|
465
|
+
Creates a new build of the Actor.
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
_See code: [src/commands/actors/build.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/build.ts)_
|
|
469
|
+
|
|
470
|
+
## `apify actors call [ACTORID]`
|
|
471
|
+
|
|
472
|
+
Runs a specific Actor remotely on the Apify cloud platform.
|
|
473
|
+
|
|
474
|
+
```
|
|
475
|
+
USAGE
|
|
476
|
+
$ apify actors call [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
477
|
+
<value>] [-s] [-o]
|
|
478
|
+
|
|
479
|
+
ARGUMENTS
|
|
480
|
+
ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
|
|
481
|
+
provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
|
|
482
|
+
|
|
483
|
+
FLAGS
|
|
484
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
485
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
486
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
487
|
+
-o, --output-dataset Prints out the entire default dataset on successful run of the Actor.
|
|
488
|
+
-s, --silent Prevents printing the logs of the Actor run to the console.
|
|
489
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
490
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
491
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
492
|
+
|
|
493
|
+
GLOBAL FLAGS
|
|
494
|
+
--json Format output as json.
|
|
495
|
+
|
|
496
|
+
DESCRIPTION
|
|
497
|
+
Runs a specific Actor remotely on the Apify cloud platform.
|
|
498
|
+
The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
|
|
499
|
+
takes input for the Actor from the default local key-value store by default.
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
_See code: [src/commands/actors/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/call.ts)_
|
|
503
|
+
|
|
504
|
+
## `apify actors ls`
|
|
505
|
+
|
|
506
|
+
Lists all recently ran Actors or your own Actors.
|
|
507
|
+
|
|
508
|
+
```
|
|
509
|
+
USAGE
|
|
510
|
+
$ apify actors ls [--json] [--my] [--offset <value>] [--limit <value>] [--desc]
|
|
511
|
+
|
|
512
|
+
FLAGS
|
|
513
|
+
--desc Sort Actors in descending order.
|
|
514
|
+
--limit=<value> [default: 20] Number of Actors that will be listed.
|
|
515
|
+
--my Whether to list Actors made by the logged in user.
|
|
516
|
+
--offset=<value> Number of Actors that will be skipped.
|
|
517
|
+
|
|
518
|
+
GLOBAL FLAGS
|
|
519
|
+
--json Format output as json.
|
|
520
|
+
|
|
521
|
+
DESCRIPTION
|
|
522
|
+
Lists all recently ran Actors or your own Actors.
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
_See code: [src/commands/actors/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/ls.ts)_
|
|
526
|
+
|
|
527
|
+
## `apify actors pull [ACTORID]`
|
|
528
|
+
|
|
529
|
+
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.
|
|
530
|
+
|
|
531
|
+
```
|
|
532
|
+
USAGE
|
|
533
|
+
$ apify actors pull [ACTORID] [-v <value>] [--dir <value>]
|
|
534
|
+
|
|
535
|
+
ARGUMENTS
|
|
536
|
+
ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
537
|
+
command will update the Actor in the current directory based on its name in ".actor/actor.json" file.
|
|
538
|
+
|
|
539
|
+
FLAGS
|
|
540
|
+
-v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
|
|
541
|
+
--dir=<value> Directory where the Actor should be pulled to
|
|
542
|
+
|
|
543
|
+
DESCRIPTION
|
|
544
|
+
Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
|
|
545
|
+
cloned. If it is defined as Web IDE, it will fetch the files.
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
_See code: [src/commands/actors/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/pull.ts)_
|
|
549
|
+
|
|
550
|
+
## `apify actors push [ACTORID]`
|
|
551
|
+
|
|
552
|
+
Uploads the Actor to the Apify platform and builds it there.
|
|
553
|
+
|
|
554
|
+
```
|
|
555
|
+
USAGE
|
|
556
|
+
$ apify actors push [ACTORID] [-v <value>] [-b <value>] [-w <value>] [--no-prompt] [--force] [--dir <value>]
|
|
557
|
+
|
|
558
|
+
ARGUMENTS
|
|
559
|
+
ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
560
|
+
command will create or modify the Actor with the name specified in ".actor/actor.json" file.
|
|
561
|
+
|
|
562
|
+
FLAGS
|
|
563
|
+
-b, --build-tag=<value> Build tag to be applied to the successful Actor build. By default, it is taken from the
|
|
564
|
+
".actor/actor.json" file
|
|
565
|
+
-v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
|
|
566
|
+
the ".actor/actor.json" file.
|
|
567
|
+
-w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
|
|
568
|
+
--dir=<value> Directory where the Actor is located
|
|
569
|
+
--force Push an Actor even when the local files are older than the Actor on the platform.
|
|
570
|
+
--no-prompt Do not prompt for opening the Actor details in a browser. This will also not open the
|
|
571
|
+
browser automatically.
|
|
572
|
+
|
|
573
|
+
DESCRIPTION
|
|
574
|
+
Uploads the Actor to the Apify platform and builds it there.
|
|
575
|
+
The Actor settings are read from the ".actor/actor.json" file in the current directory, but they can be overridden
|
|
576
|
+
using command-line options.
|
|
577
|
+
NOTE: If the source files are smaller than 3 MB then they are uploaded as
|
|
578
|
+
"Multiple source files", otherwise they are uploaded as "Zip file".
|
|
579
|
+
|
|
580
|
+
When there's an attempt to push files that are older than the Actor on the platform, the command will fail. Can be
|
|
581
|
+
overwritten with --force flag.
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
_See code: [src/commands/actors/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/push.ts)_
|
|
585
|
+
|
|
586
|
+
## `apify actors rm ACTORID`
|
|
587
|
+
|
|
588
|
+
Deletes an Actor.
|
|
589
|
+
|
|
590
|
+
```
|
|
591
|
+
USAGE
|
|
592
|
+
$ apify actors rm ACTORID
|
|
593
|
+
|
|
594
|
+
ARGUMENTS
|
|
595
|
+
ACTORID The Actor ID to delete.
|
|
596
|
+
|
|
597
|
+
DESCRIPTION
|
|
598
|
+
Deletes an Actor.
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
_See code: [src/commands/actors/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/rm.ts)_
|
|
602
|
+
|
|
603
|
+
## `apify actors start [ACTORID]`
|
|
604
|
+
|
|
605
|
+
Runs a specific Actor remotely on the Apify cloud platform and immediately returns information about the run.
|
|
606
|
+
|
|
607
|
+
```
|
|
608
|
+
USAGE
|
|
609
|
+
$ apify actors start [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
610
|
+
<value>]
|
|
611
|
+
|
|
612
|
+
ARGUMENTS
|
|
613
|
+
ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
|
|
614
|
+
provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
|
|
615
|
+
|
|
616
|
+
FLAGS
|
|
617
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
618
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
619
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
620
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
621
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
622
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
623
|
+
|
|
624
|
+
GLOBAL FLAGS
|
|
625
|
+
--json Format output as json.
|
|
626
|
+
|
|
627
|
+
DESCRIPTION
|
|
628
|
+
Runs a specific Actor remotely on the Apify cloud platform and immediately returns information about the run.
|
|
629
|
+
The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
|
|
630
|
+
takes input for the Actor from the default local key-value store by default.
|
|
631
|
+
```
|
|
632
|
+
|
|
633
|
+
_See code: [src/commands/actors/start.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/actors/start.ts)_
|
|
430
634
|
|
|
431
635
|
## `apify builds`
|
|
432
636
|
|
|
@@ -440,19 +644,21 @@ DESCRIPTION
|
|
|
440
644
|
Commands are designed to be used with Actor Builds.
|
|
441
645
|
```
|
|
442
646
|
|
|
443
|
-
_See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
647
|
+
_See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/builds/index.ts)_
|
|
444
648
|
|
|
445
|
-
## `apify builds create`
|
|
649
|
+
## `apify builds create [ACTORID]`
|
|
446
650
|
|
|
447
651
|
Creates a new build of the Actor.
|
|
448
652
|
|
|
449
653
|
```
|
|
450
654
|
USAGE
|
|
451
|
-
$ apify builds create [
|
|
655
|
+
$ apify builds create [ACTORID] [--json] [--tag <value>] [--version <value>] [--log]
|
|
656
|
+
|
|
657
|
+
ARGUMENTS
|
|
658
|
+
ACTORID Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the current
|
|
659
|
+
directory.
|
|
452
660
|
|
|
453
661
|
FLAGS
|
|
454
|
-
--actor=<value> Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the
|
|
455
|
-
current directory.
|
|
456
662
|
--log Whether to print out the build log after the build is triggered.
|
|
457
663
|
--tag=<value> Build tag to be applied to the successful Actor build. By default, this is "latest".
|
|
458
664
|
--version=<value> Optional Actor Version to build. By default, this will be inferred from the tag, but this flag is
|
|
@@ -465,7 +671,7 @@ DESCRIPTION
|
|
|
465
671
|
Creates a new build of the Actor.
|
|
466
672
|
```
|
|
467
673
|
|
|
468
|
-
_See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
674
|
+
_See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/builds/create.ts)_
|
|
469
675
|
|
|
470
676
|
## `apify builds info BUILDID`
|
|
471
677
|
|
|
@@ -485,7 +691,7 @@ DESCRIPTION
|
|
|
485
691
|
Prints information about a specific build.
|
|
486
692
|
```
|
|
487
693
|
|
|
488
|
-
_See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
694
|
+
_See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/builds/info.ts)_
|
|
489
695
|
|
|
490
696
|
## `apify builds log BUILDID`
|
|
491
697
|
|
|
@@ -502,20 +708,21 @@ DESCRIPTION
|
|
|
502
708
|
Prints the log of a specific build.
|
|
503
709
|
```
|
|
504
710
|
|
|
505
|
-
_See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
711
|
+
_See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/builds/log.ts)_
|
|
506
712
|
|
|
507
|
-
## `apify builds ls`
|
|
713
|
+
## `apify builds ls [ACTORID]`
|
|
508
714
|
|
|
509
715
|
Lists all builds of the Actor.
|
|
510
716
|
|
|
511
717
|
```
|
|
512
718
|
USAGE
|
|
513
|
-
$ apify builds ls [
|
|
719
|
+
$ apify builds ls [ACTORID] [--json] [--offset <value>] [--limit <value>] [--desc] [-c]
|
|
720
|
+
|
|
721
|
+
ARGUMENTS
|
|
722
|
+
ACTORID Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current directory.
|
|
514
723
|
|
|
515
724
|
FLAGS
|
|
516
725
|
-c, --compact Display a compact table.
|
|
517
|
-
--actor=<value> Optional Actor ID or Name to list builds for. By default, it will use the Actor from the current
|
|
518
|
-
directory.
|
|
519
726
|
--desc Sort builds in descending order.
|
|
520
727
|
--limit=<value> [default: 10] Number of builds that will be listed.
|
|
521
728
|
--offset=<value> Number of builds that will be skipped.
|
|
@@ -527,7 +734,24 @@ DESCRIPTION
|
|
|
527
734
|
Lists all builds of the Actor.
|
|
528
735
|
```
|
|
529
736
|
|
|
530
|
-
_See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
737
|
+
_See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/builds/ls.ts)_
|
|
738
|
+
|
|
739
|
+
## `apify builds rm BUILDID`
|
|
740
|
+
|
|
741
|
+
Deletes an Actor Build.
|
|
742
|
+
|
|
743
|
+
```
|
|
744
|
+
USAGE
|
|
745
|
+
$ apify builds rm BUILDID
|
|
746
|
+
|
|
747
|
+
ARGUMENTS
|
|
748
|
+
BUILDID The build ID to delete.
|
|
749
|
+
|
|
750
|
+
DESCRIPTION
|
|
751
|
+
Deletes an Actor Build.
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
_See code: [src/commands/builds/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/builds/rm.ts)_
|
|
531
755
|
|
|
532
756
|
## `apify call [ACTORID]`
|
|
533
757
|
|
|
@@ -535,7 +759,7 @@ Runs a specific Actor remotely on the Apify cloud platform.
|
|
|
535
759
|
|
|
536
760
|
```
|
|
537
761
|
USAGE
|
|
538
|
-
$ apify call [ACTORID] [-b <value>] [-t <value>] [-m <value>] [-
|
|
762
|
+
$ apify call [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
539
763
|
<value>] [-s] [-o]
|
|
540
764
|
|
|
541
765
|
ARGUMENTS
|
|
@@ -543,15 +767,17 @@ ARGUMENTS
|
|
|
543
767
|
provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
|
|
544
768
|
|
|
545
769
|
FLAGS
|
|
546
|
-
-b, --build=<value>
|
|
547
|
-
-i, --input=<value>
|
|
548
|
-
-m, --memory=<value>
|
|
549
|
-
-o, --output-dataset
|
|
550
|
-
-s, --silent
|
|
551
|
-
-t, --timeout=<value>
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
770
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
771
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
772
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
773
|
+
-o, --output-dataset Prints out the entire default dataset on successful run of the Actor.
|
|
774
|
+
-s, --silent Prevents printing the logs of the Actor run to the console.
|
|
775
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
776
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
777
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
778
|
+
|
|
779
|
+
GLOBAL FLAGS
|
|
780
|
+
--json Format output as json.
|
|
555
781
|
|
|
556
782
|
DESCRIPTION
|
|
557
783
|
Runs a specific Actor remotely on the Apify cloud platform.
|
|
@@ -559,7 +785,7 @@ DESCRIPTION
|
|
|
559
785
|
takes input for the Actor from the default local key-value store by default.
|
|
560
786
|
```
|
|
561
787
|
|
|
562
|
-
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
788
|
+
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/call.ts)_
|
|
563
789
|
|
|
564
790
|
## `apify create [ACTORNAME]`
|
|
565
791
|
|
|
@@ -584,7 +810,7 @@ DESCRIPTION
|
|
|
584
810
|
Creates a new Actor project directory from a selected boilerplate template.
|
|
585
811
|
```
|
|
586
812
|
|
|
587
|
-
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
813
|
+
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/create.ts)_
|
|
588
814
|
|
|
589
815
|
## `apify datasets`
|
|
590
816
|
|
|
@@ -598,7 +824,30 @@ DESCRIPTION
|
|
|
598
824
|
Commands are designed to be used with Datasets.
|
|
599
825
|
```
|
|
600
826
|
|
|
601
|
-
_See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
827
|
+
_See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/datasets/index.ts)_
|
|
828
|
+
|
|
829
|
+
## `apify datasets get-items DATASETID`
|
|
830
|
+
|
|
831
|
+
Exports the items present in a Dataset.
|
|
832
|
+
|
|
833
|
+
```
|
|
834
|
+
USAGE
|
|
835
|
+
$ apify datasets get-items DATASETID [--limit <value>] [--offset <value>] [--format json|jsonl|csv|html|rss|xml|xlsx]
|
|
836
|
+
|
|
837
|
+
ARGUMENTS
|
|
838
|
+
DATASETID The ID of the Dataset to export the items for
|
|
839
|
+
|
|
840
|
+
FLAGS
|
|
841
|
+
--format=<option> [default: json] The format of the returned output. By default, it is set to 'json'
|
|
842
|
+
<options: json|jsonl|csv|html|rss|xml|xlsx>
|
|
843
|
+
--limit=<value> The amount of elements to get from the dataset. By default, it will return all available items.
|
|
844
|
+
--offset=<value> The offset in the dataset where to start getting items.
|
|
845
|
+
|
|
846
|
+
DESCRIPTION
|
|
847
|
+
Exports the items present in a Dataset.
|
|
848
|
+
```
|
|
849
|
+
|
|
850
|
+
_See code: [src/commands/datasets/get-items.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/datasets/get-items.ts)_
|
|
602
851
|
|
|
603
852
|
## `apify help [COMMAND]`
|
|
604
853
|
|
|
@@ -618,7 +867,7 @@ DESCRIPTION
|
|
|
618
867
|
Display help for apify.
|
|
619
868
|
```
|
|
620
869
|
|
|
621
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
870
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
|
|
622
871
|
|
|
623
872
|
## `apify info`
|
|
624
873
|
|
|
@@ -633,7 +882,7 @@ DESCRIPTION
|
|
|
633
882
|
The information is printed to the console.
|
|
634
883
|
```
|
|
635
884
|
|
|
636
|
-
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
885
|
+
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/info.ts)_
|
|
637
886
|
|
|
638
887
|
## `apify init [ACTORNAME]`
|
|
639
888
|
|
|
@@ -661,7 +910,7 @@ DESCRIPTION
|
|
|
661
910
|
WARNING: The directory at "storage" will be overwritten if it already exists.
|
|
662
911
|
```
|
|
663
912
|
|
|
664
|
-
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
913
|
+
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/init.ts)_
|
|
665
914
|
|
|
666
915
|
## `apify key-value-stores`
|
|
667
916
|
|
|
@@ -673,9 +922,32 @@ USAGE
|
|
|
673
922
|
|
|
674
923
|
DESCRIPTION
|
|
675
924
|
Commands are designed to be used with Key Value Stores.
|
|
925
|
+
|
|
926
|
+
Aliases: kvs
|
|
676
927
|
```
|
|
677
928
|
|
|
678
|
-
_See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
929
|
+
_See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/key-value-stores/index.ts)_
|
|
930
|
+
|
|
931
|
+
## `apify key-value-stores get-value KEYVALUESTOREID ITEMKEY`
|
|
932
|
+
|
|
933
|
+
Gets a value by key in the given key-value store.
|
|
934
|
+
|
|
935
|
+
```
|
|
936
|
+
USAGE
|
|
937
|
+
$ apify key-value-stores get-value KEYVALUESTOREID ITEMKEY [--only-content-type]
|
|
938
|
+
|
|
939
|
+
ARGUMENTS
|
|
940
|
+
KEYVALUESTOREID The key-value store ID to get the value from.
|
|
941
|
+
ITEMKEY The key of the item in the key-value store.
|
|
942
|
+
|
|
943
|
+
FLAGS
|
|
944
|
+
--only-content-type Only return the content type of the specified key
|
|
945
|
+
|
|
946
|
+
DESCRIPTION
|
|
947
|
+
Gets a value by key in the given key-value store.
|
|
948
|
+
```
|
|
949
|
+
|
|
950
|
+
_See code: [src/commands/key-value-stores/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/key-value-stores/get-value.ts)_
|
|
679
951
|
|
|
680
952
|
## `apify login`
|
|
681
953
|
|
|
@@ -696,7 +968,7 @@ DESCRIPTION
|
|
|
696
968
|
"apify" commands. To log out, call "apify logout".
|
|
697
969
|
```
|
|
698
970
|
|
|
699
|
-
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
971
|
+
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/login.ts)_
|
|
700
972
|
|
|
701
973
|
## `apify logout`
|
|
702
974
|
|
|
@@ -712,7 +984,7 @@ DESCRIPTION
|
|
|
712
984
|
call "apify login".
|
|
713
985
|
```
|
|
714
986
|
|
|
715
|
-
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
987
|
+
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/logout.ts)_
|
|
716
988
|
|
|
717
989
|
## `apify pull [ACTORID]`
|
|
718
990
|
|
|
@@ -720,7 +992,7 @@ Pulls an Actor from the Apify platform to the current directory. If it is define
|
|
|
720
992
|
|
|
721
993
|
```
|
|
722
994
|
USAGE
|
|
723
|
-
$ apify pull [ACTORID] [-v <value>]
|
|
995
|
+
$ apify pull [ACTORID] [-v <value>] [--dir <value>]
|
|
724
996
|
|
|
725
997
|
ARGUMENTS
|
|
726
998
|
ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
@@ -728,13 +1000,14 @@ ARGUMENTS
|
|
|
728
1000
|
|
|
729
1001
|
FLAGS
|
|
730
1002
|
-v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
|
|
1003
|
+
--dir=<value> Directory where the Actor should be pulled to
|
|
731
1004
|
|
|
732
1005
|
DESCRIPTION
|
|
733
1006
|
Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
|
|
734
1007
|
cloned. If it is defined as Web IDE, it will fetch the files.
|
|
735
1008
|
```
|
|
736
1009
|
|
|
737
|
-
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1010
|
+
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/pull.ts)_
|
|
738
1011
|
|
|
739
1012
|
## `apify push [ACTORID]`
|
|
740
1013
|
|
|
@@ -742,8 +1015,7 @@ Uploads the Actor to the Apify platform and builds it there.
|
|
|
742
1015
|
|
|
743
1016
|
```
|
|
744
1017
|
USAGE
|
|
745
|
-
$ apify push [ACTORID] [
|
|
746
|
-
[--force]
|
|
1018
|
+
$ apify push [ACTORID] [-v <value>] [-b <value>] [-w <value>] [--no-prompt] [--force] [--dir <value>]
|
|
747
1019
|
|
|
748
1020
|
ARGUMENTS
|
|
749
1021
|
ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
@@ -755,11 +1027,10 @@ FLAGS
|
|
|
755
1027
|
-v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
|
|
756
1028
|
the ".actor/actor.json" file.
|
|
757
1029
|
-w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
|
|
1030
|
+
--dir=<value> Directory where the Actor is located
|
|
758
1031
|
--force Push an Actor even when the local files are older than the Actor on the platform.
|
|
759
1032
|
--no-prompt Do not prompt for opening the Actor details in a browser. This will also not open the
|
|
760
1033
|
browser automatically.
|
|
761
|
-
--version-number=<value> DEPRECATED: Use flag version instead. Actor version number to which the files should be
|
|
762
|
-
pushed. By default, it is taken from the ".actor/actor.json" file.
|
|
763
1034
|
|
|
764
1035
|
DESCRIPTION
|
|
765
1036
|
Uploads the Actor to the Apify platform and builds it there.
|
|
@@ -772,7 +1043,7 @@ DESCRIPTION
|
|
|
772
1043
|
overwritten with --force flag.
|
|
773
1044
|
```
|
|
774
1045
|
|
|
775
|
-
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1046
|
+
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/push.ts)_
|
|
776
1047
|
|
|
777
1048
|
## `apify request-queues`
|
|
778
1049
|
|
|
@@ -786,7 +1057,7 @@ DESCRIPTION
|
|
|
786
1057
|
Commands are designed to be used with Request Queues.
|
|
787
1058
|
```
|
|
788
1059
|
|
|
789
|
-
_See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1060
|
+
_See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/request-queues/index.ts)_
|
|
790
1061
|
|
|
791
1062
|
## `apify run`
|
|
792
1063
|
|
|
@@ -822,7 +1093,7 @@ DESCRIPTION
|
|
|
822
1093
|
package.json file. You can set up your own main file or environment variables by changing it.
|
|
823
1094
|
```
|
|
824
1095
|
|
|
825
|
-
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1096
|
+
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/run.ts)_
|
|
826
1097
|
|
|
827
1098
|
## `apify runs`
|
|
828
1099
|
|
|
@@ -836,7 +1107,7 @@ DESCRIPTION
|
|
|
836
1107
|
Commands are designed to be used with Actor Runs.
|
|
837
1108
|
```
|
|
838
1109
|
|
|
839
|
-
_See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1110
|
+
_See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/runs/index.ts)_
|
|
840
1111
|
|
|
841
1112
|
## `apify runs abort RUNID`
|
|
842
1113
|
|
|
@@ -859,7 +1130,30 @@ DESCRIPTION
|
|
|
859
1130
|
Aborts an Actor Run.
|
|
860
1131
|
```
|
|
861
1132
|
|
|
862
|
-
_See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1133
|
+
_See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/runs/abort.ts)_
|
|
1134
|
+
|
|
1135
|
+
## `apify runs info RUNID`
|
|
1136
|
+
|
|
1137
|
+
Prints information about an Actor Run.
|
|
1138
|
+
|
|
1139
|
+
```
|
|
1140
|
+
USAGE
|
|
1141
|
+
$ apify runs info RUNID [--json] [-v]
|
|
1142
|
+
|
|
1143
|
+
ARGUMENTS
|
|
1144
|
+
RUNID The run ID to print information about.
|
|
1145
|
+
|
|
1146
|
+
FLAGS
|
|
1147
|
+
-v, --verbose Prints more in-depth information about the Actor Run.
|
|
1148
|
+
|
|
1149
|
+
GLOBAL FLAGS
|
|
1150
|
+
--json Format output as json.
|
|
1151
|
+
|
|
1152
|
+
DESCRIPTION
|
|
1153
|
+
Prints information about an Actor Run.
|
|
1154
|
+
```
|
|
1155
|
+
|
|
1156
|
+
_See code: [src/commands/runs/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/runs/info.ts)_
|
|
863
1157
|
|
|
864
1158
|
## `apify runs log RUNID`
|
|
865
1159
|
|
|
@@ -876,20 +1170,21 @@ DESCRIPTION
|
|
|
876
1170
|
Prints the log of a specific run.
|
|
877
1171
|
```
|
|
878
1172
|
|
|
879
|
-
_See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1173
|
+
_See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/runs/log.ts)_
|
|
880
1174
|
|
|
881
|
-
## `apify runs ls`
|
|
1175
|
+
## `apify runs ls [ACTORID]`
|
|
882
1176
|
|
|
883
1177
|
Lists all runs of the Actor.
|
|
884
1178
|
|
|
885
1179
|
```
|
|
886
1180
|
USAGE
|
|
887
|
-
$ apify runs ls [
|
|
1181
|
+
$ apify runs ls [ACTORID] [--json] [--offset <value>] [--limit <value>] [--desc] [-c]
|
|
1182
|
+
|
|
1183
|
+
ARGUMENTS
|
|
1184
|
+
ACTORID Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current directory.
|
|
888
1185
|
|
|
889
1186
|
FLAGS
|
|
890
1187
|
-c, --compact Display a compact table.
|
|
891
|
-
--actor=<value> Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current
|
|
892
|
-
directory.
|
|
893
1188
|
--desc Sort runs in descending order.
|
|
894
1189
|
--limit=<value> [default: 10] Number of runs that will be listed.
|
|
895
1190
|
--offset=<value> Number of runs that will be skipped.
|
|
@@ -901,7 +1196,7 @@ DESCRIPTION
|
|
|
901
1196
|
Lists all runs of the Actor.
|
|
902
1197
|
```
|
|
903
1198
|
|
|
904
|
-
_See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1199
|
+
_See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/runs/ls.ts)_
|
|
905
1200
|
|
|
906
1201
|
## `apify runs resurrect RUNID`
|
|
907
1202
|
|
|
@@ -921,7 +1216,24 @@ DESCRIPTION
|
|
|
921
1216
|
Resurrects an aborted or finished Actor Run.
|
|
922
1217
|
```
|
|
923
1218
|
|
|
924
|
-
_See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1219
|
+
_See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/runs/resurrect.ts)_
|
|
1220
|
+
|
|
1221
|
+
## `apify runs rm RUNID`
|
|
1222
|
+
|
|
1223
|
+
Deletes an Actor Run.
|
|
1224
|
+
|
|
1225
|
+
```
|
|
1226
|
+
USAGE
|
|
1227
|
+
$ apify runs rm RUNID
|
|
1228
|
+
|
|
1229
|
+
ARGUMENTS
|
|
1230
|
+
RUNID The run ID to delete.
|
|
1231
|
+
|
|
1232
|
+
DESCRIPTION
|
|
1233
|
+
Deletes an Actor Run.
|
|
1234
|
+
```
|
|
1235
|
+
|
|
1236
|
+
_See code: [src/commands/runs/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/runs/rm.ts)_
|
|
925
1237
|
|
|
926
1238
|
## `apify secrets`
|
|
927
1239
|
|
|
@@ -951,7 +1263,7 @@ DESCRIPTION
|
|
|
951
1263
|
of the Actor.
|
|
952
1264
|
```
|
|
953
1265
|
|
|
954
|
-
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1266
|
+
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/secrets/index.ts)_
|
|
955
1267
|
|
|
956
1268
|
## `apify secrets add NAME VALUE`
|
|
957
1269
|
|
|
@@ -970,7 +1282,7 @@ DESCRIPTION
|
|
|
970
1282
|
The secrets are stored to a file at ~/.apify
|
|
971
1283
|
```
|
|
972
1284
|
|
|
973
|
-
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1285
|
+
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/secrets/add.ts)_
|
|
974
1286
|
|
|
975
1287
|
## `apify secrets rm NAME`
|
|
976
1288
|
|
|
@@ -987,7 +1299,7 @@ DESCRIPTION
|
|
|
987
1299
|
Removes the secret.
|
|
988
1300
|
```
|
|
989
1301
|
|
|
990
|
-
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1302
|
+
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/secrets/rm.ts)_
|
|
991
1303
|
|
|
992
1304
|
## `apify task`
|
|
993
1305
|
|
|
@@ -1001,7 +1313,7 @@ DESCRIPTION
|
|
|
1001
1313
|
Commands are designed to be used to interact with Tasks.
|
|
1002
1314
|
```
|
|
1003
1315
|
|
|
1004
|
-
_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1316
|
+
_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/task/index.ts)_
|
|
1005
1317
|
|
|
1006
1318
|
## `apify task run TASKID`
|
|
1007
1319
|
|
|
@@ -1009,16 +1321,15 @@ Runs a specific Actor remotely on the Apify cloud platform.
|
|
|
1009
1321
|
|
|
1010
1322
|
```
|
|
1011
1323
|
USAGE
|
|
1012
|
-
$ apify task run TASKID [-b <value>] [-t <value>] [-m <value>]
|
|
1324
|
+
$ apify task run TASKID [-b <value>] [-t <value>] [-m <value>]
|
|
1013
1325
|
|
|
1014
1326
|
ARGUMENTS
|
|
1015
1327
|
TASKID Name or ID of the Task to run (e.g. "my-task" or "E2jjCZBezvAZnX8Rb").
|
|
1016
1328
|
|
|
1017
1329
|
FLAGS
|
|
1018
|
-
-b, --build=<value>
|
|
1019
|
-
-m, --memory=<value>
|
|
1020
|
-
-t, --timeout=<value>
|
|
1021
|
-
-w, --wait-for-finish=<value> Seconds for waiting to run to finish, if no value passed, it waits forever.
|
|
1330
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
1331
|
+
-m, --memory=<value> Amount of memory allocated for the Task run, in megabytes.
|
|
1332
|
+
-t, --timeout=<value> Timeout for the Task run in seconds. Zero value means there is no timeout.
|
|
1022
1333
|
|
|
1023
1334
|
DESCRIPTION
|
|
1024
1335
|
Runs a specific Actor remotely on the Apify cloud platform.
|
|
@@ -1026,7 +1337,7 @@ DESCRIPTION
|
|
|
1026
1337
|
takes input for the Actor from the default local key-value store by default.
|
|
1027
1338
|
```
|
|
1028
1339
|
|
|
1029
|
-
_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1340
|
+
_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/task/run.ts)_
|
|
1030
1341
|
|
|
1031
1342
|
## `apify validate-schema [PATH]`
|
|
1032
1343
|
|
|
@@ -1051,6 +1362,6 @@ DESCRIPTION
|
|
|
1051
1362
|
You can also pass any custom path to your input schema to have it validated instead.
|
|
1052
1363
|
```
|
|
1053
1364
|
|
|
1054
|
-
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1365
|
+
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.51/src/commands/validate-schema.ts)_
|
|
1055
1366
|
<!-- commandsstop -->
|
|
1056
1367
|
<!-- prettier-ignore-end -->
|