apify-cli 0.21.0-beta.7 → 0.21.0-beta.70
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/CHANGELOG.md +39 -1
- package/README.md +663 -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.d.ts.map +1 -1
- package/dist/commands/actor/push-data.js +20 -24
- 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/info.d.ts +22 -0
- package/dist/commands/actors/info.d.ts.map +1 -0
- package/dist/commands/actors/info.js +201 -0
- package/dist/commands/actors/info.js.map +1 -0
- 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 +12 -27
- 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/create.d.ts +10 -0
- package/dist/commands/datasets/create.d.ts.map +1 -0
- package/dist/commands/datasets/create.js +37 -0
- package/dist/commands/datasets/create.js.map +1 -0
- 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 +85 -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/datasets/ls.d.ts +13 -0
- package/dist/commands/datasets/ls.d.ts.map +1 -0
- package/dist/commands/datasets/ls.js +72 -0
- package/dist/commands/datasets/ls.js.map +1 -0
- package/dist/commands/datasets/push-items.d.ts +10 -0
- package/dist/commands/datasets/push-items.d.ts.map +1 -0
- package/dist/commands/datasets/push-items.js +69 -0
- package/dist/commands/datasets/push-items.js.map +1 -0
- package/dist/commands/datasets/rename.d.ts +13 -0
- package/dist/commands/datasets/rename.d.ts.map +1 -0
- package/dist/commands/datasets/rename.js +69 -0
- package/dist/commands/datasets/rename.js.map +1 -0
- package/dist/commands/datasets/rm.d.ts +9 -0
- package/dist/commands/datasets/rm.d.ts.map +1 -0
- package/dist/commands/datasets/rm.js +47 -0
- package/dist/commands/datasets/rm.js.map +1 -0
- 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 +19 -34
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/key-value-stores/create.d.ts +11 -0
- package/dist/commands/key-value-stores/create.d.ts.map +1 -0
- package/dist/commands/key-value-stores/create.js +38 -0
- package/dist/commands/key-value-stores/create.js.map +1 -0
- package/dist/commands/key-value-stores/delete-value.d.ts +11 -0
- package/dist/commands/key-value-stores/delete-value.d.ts.map +1 -0
- package/dist/commands/key-value-stores/delete-value.js +61 -0
- package/dist/commands/key-value-stores/delete-value.js.map +1 -0
- package/dist/commands/key-value-stores/get-value.d.ts +14 -0
- package/dist/commands/key-value-stores/get-value.d.ts.map +1 -0
- package/dist/commands/key-value-stores/get-value.js +69 -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/key-value-stores/keys.d.ts +15 -0
- package/dist/commands/key-value-stores/keys.d.ts.map +1 -0
- package/dist/commands/key-value-stores/keys.js +60 -0
- package/dist/commands/key-value-stores/keys.js.map +1 -0
- package/dist/commands/key-value-stores/ls.d.ts +14 -0
- package/dist/commands/key-value-stores/ls.d.ts.map +1 -0
- package/dist/commands/key-value-stores/ls.js +71 -0
- package/dist/commands/key-value-stores/ls.js.map +1 -0
- package/dist/commands/key-value-stores/rename.d.ts +14 -0
- package/dist/commands/key-value-stores/rename.d.ts.map +1 -0
- package/dist/commands/key-value-stores/rename.js +70 -0
- package/dist/commands/key-value-stores/rename.js.map +1 -0
- package/dist/commands/key-value-stores/rm.d.ts +10 -0
- package/dist/commands/key-value-stores/rm.d.ts.map +1 -0
- package/dist/commands/key-value-stores/rm.js +48 -0
- package/dist/commands/key-value-stores/rm.js.map +1 -0
- package/dist/commands/key-value-stores/set-value.d.ts +15 -0
- package/dist/commands/key-value-stores/set-value.d.ts.map +1 -0
- package/dist/commands/key-value-stores/set-value.js +59 -0
- package/dist/commands/key-value-stores/set-value.js.map +1 -0
- 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 +6 -1
- package/dist/lib/commands/pretty-print-bytes.d.ts.map +1 -1
- package/dist/lib/commands/pretty-print-bytes.js +8 -4
- package/dist/lib/commands/pretty-print-bytes.js.map +1 -1
- package/dist/lib/commands/read-stdin.d.ts +1 -1
- package/dist/lib/commands/read-stdin.d.ts.map +1 -1
- package/dist/lib/commands/read-stdin.js +13 -1
- package/dist/lib/commands/read-stdin.js.map +1 -1
- package/dist/lib/commands/resolve-input.js +1 -1
- package/dist/lib/commands/resolve-input.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/commands/storages.d.ts +10 -0
- package/dist/lib/commands/storages.d.ts.map +1 -0
- package/dist/lib/commands/storages.js +30 -0
- package/dist/lib/commands/storages.js.map +1 -0
- 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/create-utils.d.ts +1 -1
- package/dist/lib/create-utils.d.ts.map +1 -1
- package/dist/lib/create-utils.js +1 -2
- package/dist/lib/create-utils.js.map +1 -1
- package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.d.ts.map +1 -1
- package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.js +8 -22
- 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 +2 -2
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +1 -2
- 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 +1308 -148
- package/package.json +16 -15
package/README.md
CHANGED
|
@@ -288,18 +288,41 @@ 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 info ACTORID`](#apify-actors-info-actorid)
|
|
294
|
+
* [`apify actors ls`](#apify-actors-ls)
|
|
295
|
+
* [`apify actors pull [ACTORID]`](#apify-actors-pull-actorid)
|
|
296
|
+
* [`apify actors push [ACTORID]`](#apify-actors-push-actorid)
|
|
297
|
+
* [`apify actors rm ACTORID`](#apify-actors-rm-actorid)
|
|
298
|
+
* [`apify actors start [ACTORID]`](#apify-actors-start-actorid)
|
|
291
299
|
* [`apify builds`](#apify-builds)
|
|
292
|
-
* [`apify builds create`](#apify-builds-create)
|
|
300
|
+
* [`apify builds create [ACTORID]`](#apify-builds-create-actorid)
|
|
293
301
|
* [`apify builds info BUILDID`](#apify-builds-info-buildid)
|
|
294
302
|
* [`apify builds log BUILDID`](#apify-builds-log-buildid)
|
|
295
|
-
* [`apify builds ls`](#apify-builds-ls)
|
|
303
|
+
* [`apify builds ls [ACTORID]`](#apify-builds-ls-actorid)
|
|
304
|
+
* [`apify builds rm BUILDID`](#apify-builds-rm-buildid)
|
|
296
305
|
* [`apify call [ACTORID]`](#apify-call-actorid)
|
|
297
306
|
* [`apify create [ACTORNAME]`](#apify-create-actorname)
|
|
298
307
|
* [`apify datasets`](#apify-datasets)
|
|
308
|
+
* [`apify datasets create [DATASETNAME]`](#apify-datasets-create-datasetname)
|
|
309
|
+
* [`apify datasets get-items DATASETID`](#apify-datasets-get-items-datasetid)
|
|
310
|
+
* [`apify datasets ls`](#apify-datasets-ls)
|
|
311
|
+
* [`apify datasets push-items NAMEORID [ITEM]`](#apify-datasets-push-items-nameorid-item)
|
|
312
|
+
* [`apify datasets rename NAMEORID [NEWNAME]`](#apify-datasets-rename-nameorid-newname)
|
|
313
|
+
* [`apify datasets rm DATASETNAMEORID`](#apify-datasets-rm-datasetnameorid)
|
|
299
314
|
* [`apify help [COMMAND]`](#apify-help-command)
|
|
300
315
|
* [`apify info`](#apify-info)
|
|
301
316
|
* [`apify init [ACTORNAME]`](#apify-init-actorname)
|
|
302
317
|
* [`apify key-value-stores`](#apify-key-value-stores)
|
|
318
|
+
* [`apify key-value-stores create [KEYVALUESTORENAME]`](#apify-key-value-stores-create-keyvaluestorename)
|
|
319
|
+
* [`apify key-value-stores delete-value STOREID ITEMKEY`](#apify-key-value-stores-delete-value-storeid-itemkey)
|
|
320
|
+
* [`apify key-value-stores get-value KEYVALUESTOREID ITEMKEY`](#apify-key-value-stores-get-value-keyvaluestoreid-itemkey)
|
|
321
|
+
* [`apify key-value-stores keys STOREID`](#apify-key-value-stores-keys-storeid)
|
|
322
|
+
* [`apify key-value-stores ls`](#apify-key-value-stores-ls)
|
|
323
|
+
* [`apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME]`](#apify-key-value-stores-rename-keyvaluestorenameorid-newname)
|
|
324
|
+
* [`apify key-value-stores rm KEYVALUESTORENAMEORID`](#apify-key-value-stores-rm-keyvaluestorenameorid)
|
|
325
|
+
* [`apify key-value-stores set-value STOREID ITEMKEY [VALUE]`](#apify-key-value-stores-set-value-storeid-itemkey-value)
|
|
303
326
|
* [`apify login`](#apify-login)
|
|
304
327
|
* [`apify logout`](#apify-logout)
|
|
305
328
|
* [`apify pull [ACTORID]`](#apify-pull-actorid)
|
|
@@ -308,9 +331,11 @@ This section contains printouts of `apify help` for all commands.
|
|
|
308
331
|
* [`apify run`](#apify-run)
|
|
309
332
|
* [`apify runs`](#apify-runs)
|
|
310
333
|
* [`apify runs abort RUNID`](#apify-runs-abort-runid)
|
|
334
|
+
* [`apify runs info RUNID`](#apify-runs-info-runid)
|
|
311
335
|
* [`apify runs log RUNID`](#apify-runs-log-runid)
|
|
312
|
-
* [`apify runs ls`](#apify-runs-ls)
|
|
336
|
+
* [`apify runs ls [ACTORID]`](#apify-runs-ls-actorid)
|
|
313
337
|
* [`apify runs resurrect RUNID`](#apify-runs-resurrect-runid)
|
|
338
|
+
* [`apify runs rm RUNID`](#apify-runs-rm-runid)
|
|
314
339
|
* [`apify secrets`](#apify-secrets)
|
|
315
340
|
* [`apify secrets add NAME VALUE`](#apify-secrets-add-name-value)
|
|
316
341
|
* [`apify secrets rm NAME`](#apify-secrets-rm-name)
|
|
@@ -330,7 +355,7 @@ DESCRIPTION
|
|
|
330
355
|
Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
|
|
331
356
|
```
|
|
332
357
|
|
|
333
|
-
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
358
|
+
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actor/index.ts)_
|
|
334
359
|
|
|
335
360
|
## `apify actor get-input`
|
|
336
361
|
|
|
@@ -344,7 +369,7 @@ DESCRIPTION
|
|
|
344
369
|
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
345
370
|
```
|
|
346
371
|
|
|
347
|
-
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
372
|
+
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actor/get-input.ts)_
|
|
348
373
|
|
|
349
374
|
## `apify actor get-value KEY`
|
|
350
375
|
|
|
@@ -361,7 +386,7 @@ DESCRIPTION
|
|
|
361
386
|
Gets a value from the default key-value store associated with the Actor run.
|
|
362
387
|
```
|
|
363
388
|
|
|
364
|
-
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
389
|
+
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actor/get-value.ts)_
|
|
365
390
|
|
|
366
391
|
## `apify actor push-data [ITEM]`
|
|
367
392
|
|
|
@@ -383,7 +408,7 @@ DESCRIPTION
|
|
|
383
408
|
$ cat ./test.json | apify actor push-data
|
|
384
409
|
```
|
|
385
410
|
|
|
386
|
-
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
411
|
+
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actor/push-data.ts)_
|
|
387
412
|
|
|
388
413
|
## `apify actor set-value KEY [VALUE]`
|
|
389
414
|
|
|
@@ -412,7 +437,7 @@ DESCRIPTION
|
|
|
412
437
|
$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
|
|
413
438
|
```
|
|
414
439
|
|
|
415
|
-
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
440
|
+
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actor/set-value.ts)_
|
|
416
441
|
|
|
417
442
|
## `apify actors`
|
|
418
443
|
|
|
@@ -426,7 +451,223 @@ DESCRIPTION
|
|
|
426
451
|
Commands are designed to be used with Actors.
|
|
427
452
|
```
|
|
428
453
|
|
|
429
|
-
_See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
454
|
+
_See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/index.ts)_
|
|
455
|
+
|
|
456
|
+
## `apify actors build [ACTORID]`
|
|
457
|
+
|
|
458
|
+
Creates a new build of the Actor.
|
|
459
|
+
|
|
460
|
+
```
|
|
461
|
+
USAGE
|
|
462
|
+
$ apify actors build [ACTORID] [--json] [--tag <value>] [--version <value>] [--log]
|
|
463
|
+
|
|
464
|
+
ARGUMENTS
|
|
465
|
+
ACTORID Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the current
|
|
466
|
+
directory.
|
|
467
|
+
|
|
468
|
+
FLAGS
|
|
469
|
+
--log Whether to print out the build log after the build is triggered.
|
|
470
|
+
--tag=<value> Build tag to be applied to the successful Actor build. By default, this is "latest".
|
|
471
|
+
--version=<value> Optional Actor Version to build. By default, this will be inferred from the tag, but this flag is
|
|
472
|
+
required when multiple versions have the same tag.
|
|
473
|
+
|
|
474
|
+
GLOBAL FLAGS
|
|
475
|
+
--json Format output as json.
|
|
476
|
+
|
|
477
|
+
DESCRIPTION
|
|
478
|
+
Creates a new build of the Actor.
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
_See code: [src/commands/actors/build.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/build.ts)_
|
|
482
|
+
|
|
483
|
+
## `apify actors call [ACTORID]`
|
|
484
|
+
|
|
485
|
+
Runs a specific Actor remotely on the Apify cloud platform.
|
|
486
|
+
|
|
487
|
+
```
|
|
488
|
+
USAGE
|
|
489
|
+
$ apify actors call [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
490
|
+
<value>] [-s] [-o]
|
|
491
|
+
|
|
492
|
+
ARGUMENTS
|
|
493
|
+
ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
|
|
494
|
+
provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
|
|
495
|
+
|
|
496
|
+
FLAGS
|
|
497
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
498
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
499
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
500
|
+
-o, --output-dataset Prints out the entire default dataset on successful run of the Actor.
|
|
501
|
+
-s, --silent Prevents printing the logs of the Actor run to the console.
|
|
502
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
503
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
504
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
505
|
+
|
|
506
|
+
GLOBAL FLAGS
|
|
507
|
+
--json Format output as json.
|
|
508
|
+
|
|
509
|
+
DESCRIPTION
|
|
510
|
+
Runs a specific Actor remotely on the Apify cloud platform.
|
|
511
|
+
The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
|
|
512
|
+
takes input for the Actor from the default local key-value store by default.
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
_See code: [src/commands/actors/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/call.ts)_
|
|
516
|
+
|
|
517
|
+
## `apify actors info ACTORID`
|
|
518
|
+
|
|
519
|
+
Get information about an Actor.
|
|
520
|
+
|
|
521
|
+
```
|
|
522
|
+
USAGE
|
|
523
|
+
$ apify actors info ACTORID [--json] [--readme | --input]
|
|
524
|
+
|
|
525
|
+
ARGUMENTS
|
|
526
|
+
ACTORID The ID of the Actor to return information about.
|
|
527
|
+
|
|
528
|
+
FLAGS
|
|
529
|
+
--input Return the Actor input schema.
|
|
530
|
+
--readme Return the Actor README.
|
|
531
|
+
|
|
532
|
+
GLOBAL FLAGS
|
|
533
|
+
--json Format output as json.
|
|
534
|
+
|
|
535
|
+
DESCRIPTION
|
|
536
|
+
Get information about an Actor.
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
_See code: [src/commands/actors/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/info.ts)_
|
|
540
|
+
|
|
541
|
+
## `apify actors ls`
|
|
542
|
+
|
|
543
|
+
Lists all recently ran Actors or your own Actors.
|
|
544
|
+
|
|
545
|
+
```
|
|
546
|
+
USAGE
|
|
547
|
+
$ apify actors ls [--json] [--my] [--offset <value>] [--limit <value>] [--desc]
|
|
548
|
+
|
|
549
|
+
FLAGS
|
|
550
|
+
--desc Sort Actors in descending order.
|
|
551
|
+
--limit=<value> [default: 20] Number of Actors that will be listed.
|
|
552
|
+
--my Whether to list Actors made by the logged in user.
|
|
553
|
+
--offset=<value> Number of Actors that will be skipped.
|
|
554
|
+
|
|
555
|
+
GLOBAL FLAGS
|
|
556
|
+
--json Format output as json.
|
|
557
|
+
|
|
558
|
+
DESCRIPTION
|
|
559
|
+
Lists all recently ran Actors or your own Actors.
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
_See code: [src/commands/actors/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/ls.ts)_
|
|
563
|
+
|
|
564
|
+
## `apify actors pull [ACTORID]`
|
|
565
|
+
|
|
566
|
+
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.
|
|
567
|
+
|
|
568
|
+
```
|
|
569
|
+
USAGE
|
|
570
|
+
$ apify actors pull [ACTORID] [-v <value>] [--dir <value>]
|
|
571
|
+
|
|
572
|
+
ARGUMENTS
|
|
573
|
+
ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
574
|
+
command will update the Actor in the current directory based on its name in ".actor/actor.json" file.
|
|
575
|
+
|
|
576
|
+
FLAGS
|
|
577
|
+
-v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
|
|
578
|
+
--dir=<value> Directory where the Actor should be pulled to
|
|
579
|
+
|
|
580
|
+
DESCRIPTION
|
|
581
|
+
Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
|
|
582
|
+
cloned. If it is defined as Web IDE, it will fetch the files.
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
_See code: [src/commands/actors/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/pull.ts)_
|
|
586
|
+
|
|
587
|
+
## `apify actors push [ACTORID]`
|
|
588
|
+
|
|
589
|
+
Uploads the Actor to the Apify platform and builds it there.
|
|
590
|
+
|
|
591
|
+
```
|
|
592
|
+
USAGE
|
|
593
|
+
$ apify actors push [ACTORID] [-v <value>] [-b <value>] [-w <value>] [--no-prompt] [--force] [--dir <value>]
|
|
594
|
+
|
|
595
|
+
ARGUMENTS
|
|
596
|
+
ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
597
|
+
command will create or modify the Actor with the name specified in ".actor/actor.json" file.
|
|
598
|
+
|
|
599
|
+
FLAGS
|
|
600
|
+
-b, --build-tag=<value> Build tag to be applied to the successful Actor build. By default, it is taken from the
|
|
601
|
+
".actor/actor.json" file
|
|
602
|
+
-v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
|
|
603
|
+
the ".actor/actor.json" file.
|
|
604
|
+
-w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
|
|
605
|
+
--dir=<value> Directory where the Actor is located
|
|
606
|
+
--force Push an Actor even when the local files are older than the Actor on the platform.
|
|
607
|
+
--no-prompt Do not prompt for opening the Actor details in a browser. This will also not open the
|
|
608
|
+
browser automatically.
|
|
609
|
+
|
|
610
|
+
DESCRIPTION
|
|
611
|
+
Uploads the Actor to the Apify platform and builds it there.
|
|
612
|
+
The Actor settings are read from the ".actor/actor.json" file in the current directory, but they can be overridden
|
|
613
|
+
using command-line options.
|
|
614
|
+
NOTE: If the source files are smaller than 3 MB then they are uploaded as
|
|
615
|
+
"Multiple source files", otherwise they are uploaded as "Zip file".
|
|
616
|
+
|
|
617
|
+
When there's an attempt to push files that are older than the Actor on the platform, the command will fail. Can be
|
|
618
|
+
overwritten with --force flag.
|
|
619
|
+
```
|
|
620
|
+
|
|
621
|
+
_See code: [src/commands/actors/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/push.ts)_
|
|
622
|
+
|
|
623
|
+
## `apify actors rm ACTORID`
|
|
624
|
+
|
|
625
|
+
Deletes an Actor.
|
|
626
|
+
|
|
627
|
+
```
|
|
628
|
+
USAGE
|
|
629
|
+
$ apify actors rm ACTORID
|
|
630
|
+
|
|
631
|
+
ARGUMENTS
|
|
632
|
+
ACTORID The Actor ID to delete.
|
|
633
|
+
|
|
634
|
+
DESCRIPTION
|
|
635
|
+
Deletes an Actor.
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
_See code: [src/commands/actors/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/rm.ts)_
|
|
639
|
+
|
|
640
|
+
## `apify actors start [ACTORID]`
|
|
641
|
+
|
|
642
|
+
Runs a specific Actor remotely on the Apify cloud platform and immediately returns information about the run.
|
|
643
|
+
|
|
644
|
+
```
|
|
645
|
+
USAGE
|
|
646
|
+
$ apify actors start [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
647
|
+
<value>]
|
|
648
|
+
|
|
649
|
+
ARGUMENTS
|
|
650
|
+
ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
|
|
651
|
+
provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
|
|
652
|
+
|
|
653
|
+
FLAGS
|
|
654
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
655
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
656
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
657
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
658
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
659
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
660
|
+
|
|
661
|
+
GLOBAL FLAGS
|
|
662
|
+
--json Format output as json.
|
|
663
|
+
|
|
664
|
+
DESCRIPTION
|
|
665
|
+
Runs a specific Actor remotely on the Apify cloud platform and immediately returns information about the run.
|
|
666
|
+
The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
|
|
667
|
+
takes input for the Actor from the default local key-value store by default.
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
_See code: [src/commands/actors/start.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/actors/start.ts)_
|
|
430
671
|
|
|
431
672
|
## `apify builds`
|
|
432
673
|
|
|
@@ -440,19 +681,21 @@ DESCRIPTION
|
|
|
440
681
|
Commands are designed to be used with Actor Builds.
|
|
441
682
|
```
|
|
442
683
|
|
|
443
|
-
_See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
684
|
+
_See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/builds/index.ts)_
|
|
444
685
|
|
|
445
|
-
## `apify builds create`
|
|
686
|
+
## `apify builds create [ACTORID]`
|
|
446
687
|
|
|
447
688
|
Creates a new build of the Actor.
|
|
448
689
|
|
|
449
690
|
```
|
|
450
691
|
USAGE
|
|
451
|
-
$ apify builds create [
|
|
692
|
+
$ apify builds create [ACTORID] [--json] [--tag <value>] [--version <value>] [--log]
|
|
693
|
+
|
|
694
|
+
ARGUMENTS
|
|
695
|
+
ACTORID Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the current
|
|
696
|
+
directory.
|
|
452
697
|
|
|
453
698
|
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
699
|
--log Whether to print out the build log after the build is triggered.
|
|
457
700
|
--tag=<value> Build tag to be applied to the successful Actor build. By default, this is "latest".
|
|
458
701
|
--version=<value> Optional Actor Version to build. By default, this will be inferred from the tag, but this flag is
|
|
@@ -465,7 +708,7 @@ DESCRIPTION
|
|
|
465
708
|
Creates a new build of the Actor.
|
|
466
709
|
```
|
|
467
710
|
|
|
468
|
-
_See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
711
|
+
_See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/builds/create.ts)_
|
|
469
712
|
|
|
470
713
|
## `apify builds info BUILDID`
|
|
471
714
|
|
|
@@ -485,7 +728,7 @@ DESCRIPTION
|
|
|
485
728
|
Prints information about a specific build.
|
|
486
729
|
```
|
|
487
730
|
|
|
488
|
-
_See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
731
|
+
_See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/builds/info.ts)_
|
|
489
732
|
|
|
490
733
|
## `apify builds log BUILDID`
|
|
491
734
|
|
|
@@ -502,20 +745,21 @@ DESCRIPTION
|
|
|
502
745
|
Prints the log of a specific build.
|
|
503
746
|
```
|
|
504
747
|
|
|
505
|
-
_See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
748
|
+
_See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/builds/log.ts)_
|
|
506
749
|
|
|
507
|
-
## `apify builds ls`
|
|
750
|
+
## `apify builds ls [ACTORID]`
|
|
508
751
|
|
|
509
752
|
Lists all builds of the Actor.
|
|
510
753
|
|
|
511
754
|
```
|
|
512
755
|
USAGE
|
|
513
|
-
$ apify builds ls [
|
|
756
|
+
$ apify builds ls [ACTORID] [--json] [--offset <value>] [--limit <value>] [--desc] [-c]
|
|
757
|
+
|
|
758
|
+
ARGUMENTS
|
|
759
|
+
ACTORID Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current directory.
|
|
514
760
|
|
|
515
761
|
FLAGS
|
|
516
762
|
-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
763
|
--desc Sort builds in descending order.
|
|
520
764
|
--limit=<value> [default: 10] Number of builds that will be listed.
|
|
521
765
|
--offset=<value> Number of builds that will be skipped.
|
|
@@ -527,7 +771,24 @@ DESCRIPTION
|
|
|
527
771
|
Lists all builds of the Actor.
|
|
528
772
|
```
|
|
529
773
|
|
|
530
|
-
_See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
774
|
+
_See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/builds/ls.ts)_
|
|
775
|
+
|
|
776
|
+
## `apify builds rm BUILDID`
|
|
777
|
+
|
|
778
|
+
Deletes an Actor Build.
|
|
779
|
+
|
|
780
|
+
```
|
|
781
|
+
USAGE
|
|
782
|
+
$ apify builds rm BUILDID
|
|
783
|
+
|
|
784
|
+
ARGUMENTS
|
|
785
|
+
BUILDID The build ID to delete.
|
|
786
|
+
|
|
787
|
+
DESCRIPTION
|
|
788
|
+
Deletes an Actor Build.
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
_See code: [src/commands/builds/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/builds/rm.ts)_
|
|
531
792
|
|
|
532
793
|
## `apify call [ACTORID]`
|
|
533
794
|
|
|
@@ -535,7 +796,7 @@ Runs a specific Actor remotely on the Apify cloud platform.
|
|
|
535
796
|
|
|
536
797
|
```
|
|
537
798
|
USAGE
|
|
538
|
-
$ apify call [ACTORID] [-b <value>] [-t <value>] [-m <value>] [-
|
|
799
|
+
$ apify call [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
539
800
|
<value>] [-s] [-o]
|
|
540
801
|
|
|
541
802
|
ARGUMENTS
|
|
@@ -543,15 +804,17 @@ ARGUMENTS
|
|
|
543
804
|
provided, the command runs the remote Actor specified in the ".actor/actor.json" file.
|
|
544
805
|
|
|
545
806
|
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
|
-
|
|
807
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
808
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
809
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
810
|
+
-o, --output-dataset Prints out the entire default dataset on successful run of the Actor.
|
|
811
|
+
-s, --silent Prevents printing the logs of the Actor run to the console.
|
|
812
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
813
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
814
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
815
|
+
|
|
816
|
+
GLOBAL FLAGS
|
|
817
|
+
--json Format output as json.
|
|
555
818
|
|
|
556
819
|
DESCRIPTION
|
|
557
820
|
Runs a specific Actor remotely on the Apify cloud platform.
|
|
@@ -559,7 +822,7 @@ DESCRIPTION
|
|
|
559
822
|
takes input for the Actor from the default local key-value store by default.
|
|
560
823
|
```
|
|
561
824
|
|
|
562
|
-
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
825
|
+
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/call.ts)_
|
|
563
826
|
|
|
564
827
|
## `apify create [ACTORNAME]`
|
|
565
828
|
|
|
@@ -584,7 +847,7 @@ DESCRIPTION
|
|
|
584
847
|
Creates a new Actor project directory from a selected boilerplate template.
|
|
585
848
|
```
|
|
586
849
|
|
|
587
|
-
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
850
|
+
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/create.ts)_
|
|
588
851
|
|
|
589
852
|
## `apify datasets`
|
|
590
853
|
|
|
@@ -598,7 +861,129 @@ DESCRIPTION
|
|
|
598
861
|
Commands are designed to be used with Datasets.
|
|
599
862
|
```
|
|
600
863
|
|
|
601
|
-
_See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
864
|
+
_See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/datasets/index.ts)_
|
|
865
|
+
|
|
866
|
+
## `apify datasets create [DATASETNAME]`
|
|
867
|
+
|
|
868
|
+
Creates a new Dataset on your account
|
|
869
|
+
|
|
870
|
+
```
|
|
871
|
+
USAGE
|
|
872
|
+
$ apify datasets create [DATASETNAME] [--json]
|
|
873
|
+
|
|
874
|
+
ARGUMENTS
|
|
875
|
+
DATASETNAME Optional name for the Dataset
|
|
876
|
+
|
|
877
|
+
GLOBAL FLAGS
|
|
878
|
+
--json Format output as json.
|
|
879
|
+
|
|
880
|
+
DESCRIPTION
|
|
881
|
+
Creates a new Dataset on your account
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
_See code: [src/commands/datasets/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/datasets/create.ts)_
|
|
885
|
+
|
|
886
|
+
## `apify datasets get-items DATASETID`
|
|
887
|
+
|
|
888
|
+
Exports the items present in a Dataset.
|
|
889
|
+
|
|
890
|
+
```
|
|
891
|
+
USAGE
|
|
892
|
+
$ apify datasets get-items DATASETID [--limit <value>] [--offset <value>] [--format json|jsonl|csv|html|rss|xml|xlsx]
|
|
893
|
+
|
|
894
|
+
ARGUMENTS
|
|
895
|
+
DATASETID The ID of the Dataset to export the items for
|
|
896
|
+
|
|
897
|
+
FLAGS
|
|
898
|
+
--format=<option> [default: json] The format of the returned output. By default, it is set to 'json'
|
|
899
|
+
<options: json|jsonl|csv|html|rss|xml|xlsx>
|
|
900
|
+
--limit=<value> The amount of elements to get from the dataset. By default, it will return all available items.
|
|
901
|
+
--offset=<value> The offset in the dataset where to start getting items.
|
|
902
|
+
|
|
903
|
+
DESCRIPTION
|
|
904
|
+
Exports the items present in a Dataset.
|
|
905
|
+
```
|
|
906
|
+
|
|
907
|
+
_See code: [src/commands/datasets/get-items.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/datasets/get-items.ts)_
|
|
908
|
+
|
|
909
|
+
## `apify datasets ls`
|
|
910
|
+
|
|
911
|
+
Lists all Datasets on your account.
|
|
912
|
+
|
|
913
|
+
```
|
|
914
|
+
USAGE
|
|
915
|
+
$ apify datasets ls [--json] [--offset <value>] [--limit <value>] [--desc] [--unnamed]
|
|
916
|
+
|
|
917
|
+
FLAGS
|
|
918
|
+
--desc Sorts Datasets in descending order.
|
|
919
|
+
--limit=<value> [default: 20] Number of Datasets that will be listed.
|
|
920
|
+
--offset=<value> Number of Datasets that will be skipped.
|
|
921
|
+
--unnamed Lists Datasets that don't have a name set.
|
|
922
|
+
|
|
923
|
+
GLOBAL FLAGS
|
|
924
|
+
--json Format output as json.
|
|
925
|
+
|
|
926
|
+
DESCRIPTION
|
|
927
|
+
Lists all Datasets on your account.
|
|
928
|
+
```
|
|
929
|
+
|
|
930
|
+
_See code: [src/commands/datasets/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/datasets/ls.ts)_
|
|
931
|
+
|
|
932
|
+
## `apify datasets push-items NAMEORID [ITEM]`
|
|
933
|
+
|
|
934
|
+
Pushes an object or an array of objects to the provided Dataset.
|
|
935
|
+
|
|
936
|
+
```
|
|
937
|
+
USAGE
|
|
938
|
+
$ apify datasets push-items NAMEORID [ITEM]
|
|
939
|
+
|
|
940
|
+
ARGUMENTS
|
|
941
|
+
NAMEORID The Dataset ID or name to push the objects to
|
|
942
|
+
ITEM The object or array of objects to be pushed.
|
|
943
|
+
|
|
944
|
+
DESCRIPTION
|
|
945
|
+
Pushes an object or an array of objects to the provided Dataset.
|
|
946
|
+
```
|
|
947
|
+
|
|
948
|
+
_See code: [src/commands/datasets/push-items.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/datasets/push-items.ts)_
|
|
949
|
+
|
|
950
|
+
## `apify datasets rename NAMEORID [NEWNAME]`
|
|
951
|
+
|
|
952
|
+
Renames a Dataset, or removes its unique name
|
|
953
|
+
|
|
954
|
+
```
|
|
955
|
+
USAGE
|
|
956
|
+
$ apify datasets rename NAMEORID [NEWNAME] [--unname]
|
|
957
|
+
|
|
958
|
+
ARGUMENTS
|
|
959
|
+
NAMEORID The Dataset ID or name to delete
|
|
960
|
+
NEWNAME The new name for the Dataset
|
|
961
|
+
|
|
962
|
+
FLAGS
|
|
963
|
+
--unname Removes the unique name of the Dataset
|
|
964
|
+
|
|
965
|
+
DESCRIPTION
|
|
966
|
+
Renames a Dataset, or removes its unique name
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
_See code: [src/commands/datasets/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/datasets/rename.ts)_
|
|
970
|
+
|
|
971
|
+
## `apify datasets rm DATASETNAMEORID`
|
|
972
|
+
|
|
973
|
+
Deletes a Dataset
|
|
974
|
+
|
|
975
|
+
```
|
|
976
|
+
USAGE
|
|
977
|
+
$ apify datasets rm DATASETNAMEORID
|
|
978
|
+
|
|
979
|
+
ARGUMENTS
|
|
980
|
+
DATASETNAMEORID The Dataset ID or name to delete
|
|
981
|
+
|
|
982
|
+
DESCRIPTION
|
|
983
|
+
Deletes a Dataset
|
|
984
|
+
```
|
|
985
|
+
|
|
986
|
+
_See code: [src/commands/datasets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/datasets/rm.ts)_
|
|
602
987
|
|
|
603
988
|
## `apify help [COMMAND]`
|
|
604
989
|
|
|
@@ -618,7 +1003,7 @@ DESCRIPTION
|
|
|
618
1003
|
Display help for apify.
|
|
619
1004
|
```
|
|
620
1005
|
|
|
621
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
1006
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.18/src/commands/help.ts)_
|
|
622
1007
|
|
|
623
1008
|
## `apify info`
|
|
624
1009
|
|
|
@@ -633,7 +1018,7 @@ DESCRIPTION
|
|
|
633
1018
|
The information is printed to the console.
|
|
634
1019
|
```
|
|
635
1020
|
|
|
636
|
-
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1021
|
+
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/info.ts)_
|
|
637
1022
|
|
|
638
1023
|
## `apify init [ACTORNAME]`
|
|
639
1024
|
|
|
@@ -661,7 +1046,7 @@ DESCRIPTION
|
|
|
661
1046
|
WARNING: The directory at "storage" will be overwritten if it already exists.
|
|
662
1047
|
```
|
|
663
1048
|
|
|
664
|
-
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1049
|
+
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/init.ts)_
|
|
665
1050
|
|
|
666
1051
|
## `apify key-value-stores`
|
|
667
1052
|
|
|
@@ -673,9 +1058,178 @@ USAGE
|
|
|
673
1058
|
|
|
674
1059
|
DESCRIPTION
|
|
675
1060
|
Commands are designed to be used with Key Value Stores.
|
|
1061
|
+
|
|
1062
|
+
Aliases: kvs
|
|
1063
|
+
```
|
|
1064
|
+
|
|
1065
|
+
_See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/index.ts)_
|
|
1066
|
+
|
|
1067
|
+
## `apify key-value-stores create [KEYVALUESTORENAME]`
|
|
1068
|
+
|
|
1069
|
+
Creates a new Key-value store on your account
|
|
1070
|
+
|
|
1071
|
+
```
|
|
1072
|
+
USAGE
|
|
1073
|
+
$ apify key-value-stores create [KEYVALUESTORENAME] [--json]
|
|
1074
|
+
|
|
1075
|
+
ARGUMENTS
|
|
1076
|
+
KEYVALUESTORENAME Optional name for the Key-value store
|
|
1077
|
+
|
|
1078
|
+
GLOBAL FLAGS
|
|
1079
|
+
--json Format output as json.
|
|
1080
|
+
|
|
1081
|
+
DESCRIPTION
|
|
1082
|
+
Creates a new Key-value store on your account
|
|
1083
|
+
```
|
|
1084
|
+
|
|
1085
|
+
_See code: [src/commands/key-value-stores/create.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/create.ts)_
|
|
1086
|
+
|
|
1087
|
+
## `apify key-value-stores delete-value STOREID ITEMKEY`
|
|
1088
|
+
|
|
1089
|
+
Delete a value from a key-value store.
|
|
1090
|
+
|
|
1091
|
+
```
|
|
1092
|
+
USAGE
|
|
1093
|
+
$ apify key-value-stores delete-value STOREID ITEMKEY
|
|
1094
|
+
|
|
1095
|
+
ARGUMENTS
|
|
1096
|
+
STOREID The key-value store ID to delete the value from.
|
|
1097
|
+
ITEMKEY The key of the item in the key-value store.
|
|
1098
|
+
|
|
1099
|
+
DESCRIPTION
|
|
1100
|
+
Delete a value from a key-value store.
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
_See code: [src/commands/key-value-stores/delete-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/delete-value.ts)_
|
|
1104
|
+
|
|
1105
|
+
## `apify key-value-stores get-value KEYVALUESTOREID ITEMKEY`
|
|
1106
|
+
|
|
1107
|
+
Gets a value by key in the given key-value store.
|
|
1108
|
+
|
|
1109
|
+
```
|
|
1110
|
+
USAGE
|
|
1111
|
+
$ apify key-value-stores get-value KEYVALUESTOREID ITEMKEY [--only-content-type]
|
|
1112
|
+
|
|
1113
|
+
ARGUMENTS
|
|
1114
|
+
KEYVALUESTOREID The key-value store ID to get the value from.
|
|
1115
|
+
ITEMKEY The key of the item in the key-value store.
|
|
1116
|
+
|
|
1117
|
+
FLAGS
|
|
1118
|
+
--only-content-type Only return the content type of the specified key
|
|
1119
|
+
|
|
1120
|
+
DESCRIPTION
|
|
1121
|
+
Gets a value by key in the given key-value store.
|
|
676
1122
|
```
|
|
677
1123
|
|
|
678
|
-
_See code: [src/commands/key-value-stores/
|
|
1124
|
+
_See code: [src/commands/key-value-stores/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/get-value.ts)_
|
|
1125
|
+
|
|
1126
|
+
## `apify key-value-stores keys STOREID`
|
|
1127
|
+
|
|
1128
|
+
Lists all keys in a key-value store.
|
|
1129
|
+
|
|
1130
|
+
```
|
|
1131
|
+
USAGE
|
|
1132
|
+
$ apify key-value-stores keys STOREID [--json] [--limit <value>] [--exclusive-start-key <value>]
|
|
1133
|
+
|
|
1134
|
+
ARGUMENTS
|
|
1135
|
+
STOREID The key-value store ID to list keys for.
|
|
1136
|
+
|
|
1137
|
+
FLAGS
|
|
1138
|
+
--exclusive-start-key=<value> The key to start the list from.
|
|
1139
|
+
--limit=<value> [default: 20] The maximum number of keys to return.
|
|
1140
|
+
|
|
1141
|
+
GLOBAL FLAGS
|
|
1142
|
+
--json Format output as json.
|
|
1143
|
+
|
|
1144
|
+
DESCRIPTION
|
|
1145
|
+
Lists all keys in a key-value store.
|
|
1146
|
+
```
|
|
1147
|
+
|
|
1148
|
+
_See code: [src/commands/key-value-stores/keys.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/keys.ts)_
|
|
1149
|
+
|
|
1150
|
+
## `apify key-value-stores ls`
|
|
1151
|
+
|
|
1152
|
+
Lists all Key-value stores on your account.
|
|
1153
|
+
|
|
1154
|
+
```
|
|
1155
|
+
USAGE
|
|
1156
|
+
$ apify key-value-stores ls [--json] [--offset <value>] [--limit <value>] [--desc] [--unnamed]
|
|
1157
|
+
|
|
1158
|
+
FLAGS
|
|
1159
|
+
--desc Sorts Key-value stores in descending order.
|
|
1160
|
+
--limit=<value> [default: 20] Number of Key-value stores that will be listed.
|
|
1161
|
+
--offset=<value> Number of Key-value stores that will be skipped.
|
|
1162
|
+
--unnamed Lists Key-value stores that don't have a name set.
|
|
1163
|
+
|
|
1164
|
+
GLOBAL FLAGS
|
|
1165
|
+
--json Format output as json.
|
|
1166
|
+
|
|
1167
|
+
DESCRIPTION
|
|
1168
|
+
Lists all Key-value stores on your account.
|
|
1169
|
+
```
|
|
1170
|
+
|
|
1171
|
+
_See code: [src/commands/key-value-stores/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/ls.ts)_
|
|
1172
|
+
|
|
1173
|
+
## `apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME]`
|
|
1174
|
+
|
|
1175
|
+
Renames a Key-value store, or removes its unique name
|
|
1176
|
+
|
|
1177
|
+
```
|
|
1178
|
+
USAGE
|
|
1179
|
+
$ apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME] [--unname]
|
|
1180
|
+
|
|
1181
|
+
ARGUMENTS
|
|
1182
|
+
KEYVALUESTORENAMEORID The Key-value store ID or name to delete
|
|
1183
|
+
NEWNAME The new name for the Key-value store
|
|
1184
|
+
|
|
1185
|
+
FLAGS
|
|
1186
|
+
--unname Removes the unique name of the Key-value store
|
|
1187
|
+
|
|
1188
|
+
DESCRIPTION
|
|
1189
|
+
Renames a Key-value store, or removes its unique name
|
|
1190
|
+
```
|
|
1191
|
+
|
|
1192
|
+
_See code: [src/commands/key-value-stores/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/rename.ts)_
|
|
1193
|
+
|
|
1194
|
+
## `apify key-value-stores rm KEYVALUESTORENAMEORID`
|
|
1195
|
+
|
|
1196
|
+
Deletes a Key-value store
|
|
1197
|
+
|
|
1198
|
+
```
|
|
1199
|
+
USAGE
|
|
1200
|
+
$ apify key-value-stores rm KEYVALUESTORENAMEORID
|
|
1201
|
+
|
|
1202
|
+
ARGUMENTS
|
|
1203
|
+
KEYVALUESTORENAMEORID The Key-value store ID or name to delete
|
|
1204
|
+
|
|
1205
|
+
DESCRIPTION
|
|
1206
|
+
Deletes a Key-value store
|
|
1207
|
+
```
|
|
1208
|
+
|
|
1209
|
+
_See code: [src/commands/key-value-stores/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/rm.ts)_
|
|
1210
|
+
|
|
1211
|
+
## `apify key-value-stores set-value STOREID ITEMKEY [VALUE]`
|
|
1212
|
+
|
|
1213
|
+
Sets a value in a key-value store.
|
|
1214
|
+
|
|
1215
|
+
```
|
|
1216
|
+
USAGE
|
|
1217
|
+
$ apify key-value-stores set-value STOREID ITEMKEY [VALUE] [--content-type <value>]
|
|
1218
|
+
|
|
1219
|
+
ARGUMENTS
|
|
1220
|
+
STOREID The key-value store ID to set the value in.
|
|
1221
|
+
ITEMKEY The key of the item in the key-value store.
|
|
1222
|
+
VALUE The value to set.
|
|
1223
|
+
|
|
1224
|
+
FLAGS
|
|
1225
|
+
--content-type=<value> [default: application/json] The MIME content type of the value. By default, "application/json"
|
|
1226
|
+
is assumed.
|
|
1227
|
+
|
|
1228
|
+
DESCRIPTION
|
|
1229
|
+
Sets a value in a key-value store.
|
|
1230
|
+
```
|
|
1231
|
+
|
|
1232
|
+
_See code: [src/commands/key-value-stores/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/key-value-stores/set-value.ts)_
|
|
679
1233
|
|
|
680
1234
|
## `apify login`
|
|
681
1235
|
|
|
@@ -696,7 +1250,7 @@ DESCRIPTION
|
|
|
696
1250
|
"apify" commands. To log out, call "apify logout".
|
|
697
1251
|
```
|
|
698
1252
|
|
|
699
|
-
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1253
|
+
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/login.ts)_
|
|
700
1254
|
|
|
701
1255
|
## `apify logout`
|
|
702
1256
|
|
|
@@ -712,7 +1266,7 @@ DESCRIPTION
|
|
|
712
1266
|
call "apify login".
|
|
713
1267
|
```
|
|
714
1268
|
|
|
715
|
-
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1269
|
+
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/logout.ts)_
|
|
716
1270
|
|
|
717
1271
|
## `apify pull [ACTORID]`
|
|
718
1272
|
|
|
@@ -720,7 +1274,7 @@ Pulls an Actor from the Apify platform to the current directory. If it is define
|
|
|
720
1274
|
|
|
721
1275
|
```
|
|
722
1276
|
USAGE
|
|
723
|
-
$ apify pull [ACTORID] [-v <value>]
|
|
1277
|
+
$ apify pull [ACTORID] [-v <value>] [--dir <value>]
|
|
724
1278
|
|
|
725
1279
|
ARGUMENTS
|
|
726
1280
|
ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
@@ -728,13 +1282,14 @@ ARGUMENTS
|
|
|
728
1282
|
|
|
729
1283
|
FLAGS
|
|
730
1284
|
-v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
|
|
1285
|
+
--dir=<value> Directory where the Actor should be pulled to
|
|
731
1286
|
|
|
732
1287
|
DESCRIPTION
|
|
733
1288
|
Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
|
|
734
1289
|
cloned. If it is defined as Web IDE, it will fetch the files.
|
|
735
1290
|
```
|
|
736
1291
|
|
|
737
|
-
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1292
|
+
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/pull.ts)_
|
|
738
1293
|
|
|
739
1294
|
## `apify push [ACTORID]`
|
|
740
1295
|
|
|
@@ -742,8 +1297,7 @@ Uploads the Actor to the Apify platform and builds it there.
|
|
|
742
1297
|
|
|
743
1298
|
```
|
|
744
1299
|
USAGE
|
|
745
|
-
$ apify push [ACTORID] [
|
|
746
|
-
[--force]
|
|
1300
|
+
$ apify push [ACTORID] [-v <value>] [-b <value>] [-w <value>] [--no-prompt] [--force] [--dir <value>]
|
|
747
1301
|
|
|
748
1302
|
ARGUMENTS
|
|
749
1303
|
ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
@@ -755,11 +1309,10 @@ FLAGS
|
|
|
755
1309
|
-v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
|
|
756
1310
|
the ".actor/actor.json" file.
|
|
757
1311
|
-w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
|
|
1312
|
+
--dir=<value> Directory where the Actor is located
|
|
758
1313
|
--force Push an Actor even when the local files are older than the Actor on the platform.
|
|
759
1314
|
--no-prompt Do not prompt for opening the Actor details in a browser. This will also not open the
|
|
760
1315
|
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
1316
|
|
|
764
1317
|
DESCRIPTION
|
|
765
1318
|
Uploads the Actor to the Apify platform and builds it there.
|
|
@@ -772,7 +1325,7 @@ DESCRIPTION
|
|
|
772
1325
|
overwritten with --force flag.
|
|
773
1326
|
```
|
|
774
1327
|
|
|
775
|
-
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1328
|
+
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/push.ts)_
|
|
776
1329
|
|
|
777
1330
|
## `apify request-queues`
|
|
778
1331
|
|
|
@@ -786,7 +1339,7 @@ DESCRIPTION
|
|
|
786
1339
|
Commands are designed to be used with Request Queues.
|
|
787
1340
|
```
|
|
788
1341
|
|
|
789
|
-
_See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1342
|
+
_See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/request-queues/index.ts)_
|
|
790
1343
|
|
|
791
1344
|
## `apify run`
|
|
792
1345
|
|
|
@@ -822,7 +1375,7 @@ DESCRIPTION
|
|
|
822
1375
|
package.json file. You can set up your own main file or environment variables by changing it.
|
|
823
1376
|
```
|
|
824
1377
|
|
|
825
|
-
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1378
|
+
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/run.ts)_
|
|
826
1379
|
|
|
827
1380
|
## `apify runs`
|
|
828
1381
|
|
|
@@ -836,7 +1389,7 @@ DESCRIPTION
|
|
|
836
1389
|
Commands are designed to be used with Actor Runs.
|
|
837
1390
|
```
|
|
838
1391
|
|
|
839
|
-
_See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1392
|
+
_See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/runs/index.ts)_
|
|
840
1393
|
|
|
841
1394
|
## `apify runs abort RUNID`
|
|
842
1395
|
|
|
@@ -859,7 +1412,30 @@ DESCRIPTION
|
|
|
859
1412
|
Aborts an Actor Run.
|
|
860
1413
|
```
|
|
861
1414
|
|
|
862
|
-
_See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1415
|
+
_See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/runs/abort.ts)_
|
|
1416
|
+
|
|
1417
|
+
## `apify runs info RUNID`
|
|
1418
|
+
|
|
1419
|
+
Prints information about an Actor Run.
|
|
1420
|
+
|
|
1421
|
+
```
|
|
1422
|
+
USAGE
|
|
1423
|
+
$ apify runs info RUNID [--json] [-v]
|
|
1424
|
+
|
|
1425
|
+
ARGUMENTS
|
|
1426
|
+
RUNID The run ID to print information about.
|
|
1427
|
+
|
|
1428
|
+
FLAGS
|
|
1429
|
+
-v, --verbose Prints more in-depth information about the Actor Run.
|
|
1430
|
+
|
|
1431
|
+
GLOBAL FLAGS
|
|
1432
|
+
--json Format output as json.
|
|
1433
|
+
|
|
1434
|
+
DESCRIPTION
|
|
1435
|
+
Prints information about an Actor Run.
|
|
1436
|
+
```
|
|
1437
|
+
|
|
1438
|
+
_See code: [src/commands/runs/info.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/runs/info.ts)_
|
|
863
1439
|
|
|
864
1440
|
## `apify runs log RUNID`
|
|
865
1441
|
|
|
@@ -876,20 +1452,21 @@ DESCRIPTION
|
|
|
876
1452
|
Prints the log of a specific run.
|
|
877
1453
|
```
|
|
878
1454
|
|
|
879
|
-
_See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1455
|
+
_See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/runs/log.ts)_
|
|
880
1456
|
|
|
881
|
-
## `apify runs ls`
|
|
1457
|
+
## `apify runs ls [ACTORID]`
|
|
882
1458
|
|
|
883
1459
|
Lists all runs of the Actor.
|
|
884
1460
|
|
|
885
1461
|
```
|
|
886
1462
|
USAGE
|
|
887
|
-
$ apify runs ls [
|
|
1463
|
+
$ apify runs ls [ACTORID] [--json] [--offset <value>] [--limit <value>] [--desc] [-c]
|
|
1464
|
+
|
|
1465
|
+
ARGUMENTS
|
|
1466
|
+
ACTORID Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current directory.
|
|
888
1467
|
|
|
889
1468
|
FLAGS
|
|
890
1469
|
-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
1470
|
--desc Sort runs in descending order.
|
|
894
1471
|
--limit=<value> [default: 10] Number of runs that will be listed.
|
|
895
1472
|
--offset=<value> Number of runs that will be skipped.
|
|
@@ -901,7 +1478,7 @@ DESCRIPTION
|
|
|
901
1478
|
Lists all runs of the Actor.
|
|
902
1479
|
```
|
|
903
1480
|
|
|
904
|
-
_See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1481
|
+
_See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/runs/ls.ts)_
|
|
905
1482
|
|
|
906
1483
|
## `apify runs resurrect RUNID`
|
|
907
1484
|
|
|
@@ -921,7 +1498,24 @@ DESCRIPTION
|
|
|
921
1498
|
Resurrects an aborted or finished Actor Run.
|
|
922
1499
|
```
|
|
923
1500
|
|
|
924
|
-
_See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1501
|
+
_See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/runs/resurrect.ts)_
|
|
1502
|
+
|
|
1503
|
+
## `apify runs rm RUNID`
|
|
1504
|
+
|
|
1505
|
+
Deletes an Actor Run.
|
|
1506
|
+
|
|
1507
|
+
```
|
|
1508
|
+
USAGE
|
|
1509
|
+
$ apify runs rm RUNID
|
|
1510
|
+
|
|
1511
|
+
ARGUMENTS
|
|
1512
|
+
RUNID The run ID to delete.
|
|
1513
|
+
|
|
1514
|
+
DESCRIPTION
|
|
1515
|
+
Deletes an Actor Run.
|
|
1516
|
+
```
|
|
1517
|
+
|
|
1518
|
+
_See code: [src/commands/runs/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/runs/rm.ts)_
|
|
925
1519
|
|
|
926
1520
|
## `apify secrets`
|
|
927
1521
|
|
|
@@ -951,7 +1545,7 @@ DESCRIPTION
|
|
|
951
1545
|
of the Actor.
|
|
952
1546
|
```
|
|
953
1547
|
|
|
954
|
-
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1548
|
+
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/secrets/index.ts)_
|
|
955
1549
|
|
|
956
1550
|
## `apify secrets add NAME VALUE`
|
|
957
1551
|
|
|
@@ -970,7 +1564,7 @@ DESCRIPTION
|
|
|
970
1564
|
The secrets are stored to a file at ~/.apify
|
|
971
1565
|
```
|
|
972
1566
|
|
|
973
|
-
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1567
|
+
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/secrets/add.ts)_
|
|
974
1568
|
|
|
975
1569
|
## `apify secrets rm NAME`
|
|
976
1570
|
|
|
@@ -987,7 +1581,7 @@ DESCRIPTION
|
|
|
987
1581
|
Removes the secret.
|
|
988
1582
|
```
|
|
989
1583
|
|
|
990
|
-
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1584
|
+
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/secrets/rm.ts)_
|
|
991
1585
|
|
|
992
1586
|
## `apify task`
|
|
993
1587
|
|
|
@@ -1001,7 +1595,7 @@ DESCRIPTION
|
|
|
1001
1595
|
Commands are designed to be used to interact with Tasks.
|
|
1002
1596
|
```
|
|
1003
1597
|
|
|
1004
|
-
_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1598
|
+
_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/task/index.ts)_
|
|
1005
1599
|
|
|
1006
1600
|
## `apify task run TASKID`
|
|
1007
1601
|
|
|
@@ -1009,16 +1603,15 @@ Runs a specific Actor remotely on the Apify cloud platform.
|
|
|
1009
1603
|
|
|
1010
1604
|
```
|
|
1011
1605
|
USAGE
|
|
1012
|
-
$ apify task run TASKID [-b <value>] [-t <value>] [-m <value>]
|
|
1606
|
+
$ apify task run TASKID [-b <value>] [-t <value>] [-m <value>]
|
|
1013
1607
|
|
|
1014
1608
|
ARGUMENTS
|
|
1015
1609
|
TASKID Name or ID of the Task to run (e.g. "my-task" or "E2jjCZBezvAZnX8Rb").
|
|
1016
1610
|
|
|
1017
1611
|
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.
|
|
1612
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
1613
|
+
-m, --memory=<value> Amount of memory allocated for the Task run, in megabytes.
|
|
1614
|
+
-t, --timeout=<value> Timeout for the Task run in seconds. Zero value means there is no timeout.
|
|
1022
1615
|
|
|
1023
1616
|
DESCRIPTION
|
|
1024
1617
|
Runs a specific Actor remotely on the Apify cloud platform.
|
|
@@ -1026,7 +1619,7 @@ DESCRIPTION
|
|
|
1026
1619
|
takes input for the Actor from the default local key-value store by default.
|
|
1027
1620
|
```
|
|
1028
1621
|
|
|
1029
|
-
_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1622
|
+
_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/task/run.ts)_
|
|
1030
1623
|
|
|
1031
1624
|
## `apify validate-schema [PATH]`
|
|
1032
1625
|
|
|
@@ -1051,6 +1644,6 @@ DESCRIPTION
|
|
|
1051
1644
|
You can also pass any custom path to your input schema to have it validated instead.
|
|
1052
1645
|
```
|
|
1053
1646
|
|
|
1054
|
-
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.
|
|
1647
|
+
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.0-beta.70/src/commands/validate-schema.ts)_
|
|
1055
1648
|
<!-- commandsstop -->
|
|
1056
1649
|
<!-- prettier-ignore-end -->
|