apify-cli 0.21.9-beta.7 → 0.21.9
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 +7 -12
- package/README.md +1431 -0
- package/bin/dev.cmd +3 -0
- package/bin/dev.js +23 -0
- package/bin/dev.sh +4 -0
- package/bin/run.cmd +3 -0
- package/bin/run.js +25 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/commands/actor/charge.d.ts +23 -0
- package/dist/commands/actor/charge.d.ts.map +1 -0
- package/dist/commands/actor/charge.js +3 -5
- package/dist/commands/actor/charge.js.map +1 -1
- package/dist/commands/actor/get-input.d.ts +6 -0
- package/dist/commands/actor/get-input.d.ts.map +1 -0
- package/dist/commands/actor/get-input.js +2 -3
- package/dist/commands/actor/get-input.js.map +1 -1
- package/dist/commands/actor/get-public-url.d.ts +9 -0
- package/dist/commands/actor/get-public-url.d.ts.map +1 -0
- package/dist/commands/actor/get-public-url.js +3 -4
- package/dist/commands/actor/get-public-url.js.map +1 -1
- package/dist/commands/actor/get-value.d.ts +9 -0
- package/dist/commands/actor/get-value.d.ts.map +1 -0
- package/dist/commands/actor/get-value.js +3 -4
- package/dist/commands/actor/get-value.js.map +1 -1
- package/dist/commands/actor/index.d.ts +6 -0
- package/dist/commands/actor/index.d.ts.map +1 -0
- package/dist/commands/actor/index.js +8 -0
- package/dist/commands/actor/index.js.map +1 -0
- package/dist/commands/actor/push-data.d.ts +9 -0
- package/dist/commands/actor/push-data.d.ts.map +1 -0
- package/dist/commands/actor/push-data.js +5 -6
- package/dist/commands/actor/push-data.js.map +1 -1
- package/dist/commands/actor/set-value.d.ts +13 -0
- package/dist/commands/actor/set-value.d.ts.map +1 -0
- package/dist/commands/actor/set-value.js +5 -5
- 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 +1 -3
- package/dist/commands/actors/build.js.map +1 -1
- 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 +7 -9
- package/dist/commands/actors/call.js.map +1 -1
- package/dist/commands/actors/index.d.ts +6 -0
- package/dist/commands/actors/index.d.ts.map +1 -0
- package/dist/commands/actors/index.js +8 -0
- package/dist/commands/actors/index.js.map +1 -0
- 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 +5 -7
- package/dist/commands/actors/info.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 +6 -8
- package/dist/commands/actors/ls.js.map +1 -1
- 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 +2 -4
- package/dist/commands/actors/pull.js.map +1 -1
- 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 +6 -4
- package/dist/commands/actors/push.js.map +1 -1
- 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 +3 -4
- package/dist/commands/actors/rm.js.map +1 -1
- 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 +7 -9
- package/dist/commands/actors/start.js.map +1 -1
- package/dist/commands/builds/create.d.ts +15 -0
- package/dist/commands/builds/create.d.ts.map +1 -0
- package/dist/commands/builds/create.js +5 -7
- package/dist/commands/builds/create.js.map +1 -1
- package/dist/commands/builds/index.d.ts +6 -0
- package/dist/commands/builds/index.d.ts.map +1 -0
- package/dist/commands/builds/index.js +8 -0
- package/dist/commands/builds/index.js.map +1 -0
- package/dist/commands/builds/info.d.ts +10 -0
- package/dist/commands/builds/info.d.ts.map +1 -0
- package/dist/commands/builds/info.js +6 -7
- package/dist/commands/builds/info.js.map +1 -1
- package/dist/commands/builds/log.d.ts +9 -0
- package/dist/commands/builds/log.d.ts.map +1 -0
- package/dist/commands/builds/log.js +3 -4
- package/dist/commands/builds/log.js.map +1 -1
- package/dist/commands/builds/ls.d.ts +17 -0
- package/dist/commands/builds/ls.d.ts.map +1 -0
- package/dist/commands/builds/ls.js +6 -8
- 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 +2 -3
- package/dist/commands/builds/rm.js.map +1 -1
- package/dist/commands/call.d.ts +4 -0
- package/dist/commands/call.d.ts.map +1 -0
- package/dist/commands/call.js +0 -1
- package/dist/commands/call.js.map +1 -1
- package/dist/commands/check-version.d.ts +11 -0
- package/dist/commands/check-version.d.ts.map +1 -0
- package/dist/commands/check-version.js +19 -0
- package/dist/commands/check-version.js.map +1 -0
- package/dist/commands/create.d.ts +15 -0
- package/dist/commands/create.d.ts.map +1 -0
- package/dist/commands/create.js +2 -4
- 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 +5 -6
- package/dist/commands/datasets/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 +7 -6
- package/dist/commands/datasets/get-items.js.map +1 -1
- package/dist/commands/datasets/index.d.ts +6 -0
- package/dist/commands/datasets/index.d.ts.map +1 -0
- package/dist/commands/datasets/index.js +8 -0
- package/dist/commands/datasets/index.js.map +1 -0
- package/dist/commands/datasets/info.d.ts +30 -0
- package/dist/commands/datasets/info.d.ts.map +1 -0
- package/dist/commands/datasets/info.js +6 -7
- package/dist/commands/datasets/info.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 +5 -6
- package/dist/commands/datasets/ls.js.map +1 -1
- 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 +4 -5
- package/dist/commands/datasets/push-items.js.map +1 -1
- 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 +2 -4
- package/dist/commands/datasets/rename.js.map +1 -1
- 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 +2 -3
- package/dist/commands/datasets/rm.js.map +1 -1
- package/dist/commands/edit-input-schema.d.ts +11 -0
- package/dist/commands/edit-input-schema.d.ts.map +1 -0
- package/dist/commands/edit-input-schema.js +3 -4
- package/dist/commands/edit-input-schema.js.map +1 -1
- package/dist/commands/info.d.ts +6 -0
- package/dist/commands/info.d.ts.map +1 -0
- package/dist/commands/info.js +1 -2
- package/dist/commands/info.js.map +1 -1
- package/dist/commands/init-wrap-scrapy.d.ts +10 -0
- package/dist/commands/init-wrap-scrapy.d.ts.map +1 -0
- package/dist/commands/init-wrap-scrapy.js +2 -3
- package/dist/commands/init-wrap-scrapy.js.map +1 -1
- package/dist/commands/init.d.ts +12 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +2 -4
- 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 +7 -7
- package/dist/commands/key-value-stores/create.js.map +1 -1
- 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 +4 -4
- package/dist/commands/key-value-stores/delete-value.js.map +1 -1
- 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 +3 -4
- package/dist/commands/key-value-stores/get-value.js.map +1 -1
- package/dist/commands/key-value-stores/index.d.ts +7 -0
- package/dist/commands/key-value-stores/index.d.ts.map +1 -0
- package/dist/commands/key-value-stores/index.js +9 -0
- package/dist/commands/key-value-stores/index.js.map +1 -0
- package/dist/commands/key-value-stores/info.d.ts +28 -0
- package/dist/commands/key-value-stores/info.d.ts.map +1 -0
- package/dist/commands/key-value-stores/info.js +7 -7
- package/dist/commands/key-value-stores/info.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 +6 -7
- package/dist/commands/key-value-stores/keys.js.map +1 -1
- 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 +7 -6
- package/dist/commands/key-value-stores/ls.js.map +1 -1
- 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 +3 -4
- package/dist/commands/key-value-stores/rename.js.map +1 -1
- 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 +3 -3
- package/dist/commands/key-value-stores/rm.js.map +1 -1
- 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 +6 -4
- package/dist/commands/key-value-stores/set-value.js.map +1 -1
- package/dist/commands/login.d.ts +10 -0
- package/dist/commands/login.d.ts.map +1 -0
- package/dist/commands/login.js +5 -8
- package/dist/commands/login.js.map +1 -1
- package/dist/commands/logout.d.ts +6 -0
- package/dist/commands/logout.d.ts.map +1 -0
- package/dist/commands/logout.js +2 -3
- package/dist/commands/logout.js.map +1 -1
- package/dist/commands/pull.d.ts +4 -0
- package/dist/commands/pull.d.ts.map +1 -0
- package/dist/commands/pull.js +0 -1
- package/dist/commands/pull.js.map +1 -1
- package/dist/commands/push.d.ts +4 -0
- package/dist/commands/push.d.ts.map +1 -0
- package/dist/commands/push.js +0 -1
- package/dist/commands/push.js.map +1 -1
- package/dist/commands/request-queues/index.d.ts +6 -0
- package/dist/commands/request-queues/index.d.ts.map +1 -0
- package/dist/commands/request-queues/{_index.js → index.js} +3 -4
- package/dist/commands/request-queues/index.js.map +1 -0
- package/dist/commands/run.d.ts +20 -0
- package/dist/commands/run.d.ts.map +1 -0
- package/dist/commands/run.js +39 -22
- package/dist/commands/run.js.map +1 -1
- package/dist/commands/runs/abort.d.ts +13 -0
- package/dist/commands/runs/abort.d.ts.map +1 -0
- package/dist/commands/runs/abort.js +5 -7
- package/dist/commands/runs/abort.js.map +1 -1
- package/dist/commands/runs/index.d.ts +6 -0
- package/dist/commands/runs/index.d.ts.map +1 -0
- package/dist/commands/runs/index.js +8 -0
- package/dist/commands/runs/index.js.map +1 -0
- package/dist/commands/runs/info.d.ts +48 -0
- package/dist/commands/runs/info.d.ts.map +1 -0
- package/dist/commands/runs/info.js +6 -8
- package/dist/commands/runs/info.js.map +1 -1
- package/dist/commands/runs/log.d.ts +9 -0
- package/dist/commands/runs/log.d.ts.map +1 -0
- package/dist/commands/runs/log.js +2 -3
- package/dist/commands/runs/log.js.map +1 -1
- package/dist/commands/runs/ls.d.ts +16 -0
- package/dist/commands/runs/ls.d.ts.map +1 -0
- package/dist/commands/runs/ls.js +5 -7
- package/dist/commands/runs/ls.js.map +1 -1
- package/dist/commands/runs/resurrect.d.ts +10 -0
- package/dist/commands/runs/resurrect.d.ts.map +1 -0
- package/dist/commands/runs/resurrect.js +5 -6
- 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 +2 -3
- package/dist/commands/runs/rm.js.map +1 -1
- package/dist/commands/secrets/add.d.ts +10 -0
- package/dist/commands/secrets/add.d.ts.map +1 -0
- package/dist/commands/secrets/add.js +2 -3
- package/dist/commands/secrets/add.js.map +1 -1
- package/dist/commands/secrets/index.d.ts +6 -0
- package/dist/commands/secrets/index.d.ts.map +1 -0
- package/dist/commands/secrets/{_index.js → index.js} +3 -7
- package/dist/commands/secrets/index.js.map +1 -0
- package/dist/commands/secrets/rm.d.ts +9 -0
- package/dist/commands/secrets/rm.d.ts.map +1 -0
- package/dist/commands/secrets/rm.js +3 -4
- package/dist/commands/secrets/rm.js.map +1 -1
- package/dist/commands/task/index.d.ts +6 -0
- package/dist/commands/task/index.d.ts.map +1 -0
- package/dist/commands/task/index.js +8 -0
- package/dist/commands/task/index.js.map +1 -0
- package/dist/commands/task/run.d.ts +15 -0
- package/dist/commands/task/run.d.ts.map +1 -0
- package/dist/commands/task/run.js +2 -3
- package/dist/commands/task/run.js.map +1 -1
- package/dist/commands/validate-schema.d.ts +10 -0
- package/dist/commands/validate-schema.d.ts.map +1 -0
- package/dist/commands/validate-schema.js +4 -5
- package/dist/commands/validate-schema.js.map +1 -1
- package/dist/hooks/deprecations.d.ts +4 -0
- package/dist/hooks/deprecations.d.ts.map +1 -0
- package/dist/hooks/deprecations.js +18 -0
- package/dist/hooks/deprecations.js.map +1 -0
- package/dist/hooks/init.d.ts +7 -0
- package/dist/hooks/init.d.ts.map +1 -0
- package/dist/hooks/init.js +17 -0
- package/dist/hooks/init.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/lib/actor.d.ts +32 -0
- package/dist/lib/actor.d.ts.map +1 -0
- package/dist/lib/apify-oclif-help.d.ts +15 -0
- package/dist/lib/apify-oclif-help.d.ts.map +1 -0
- package/dist/lib/apify-oclif-help.js +19 -0
- package/dist/lib/apify-oclif-help.js.map +1 -0
- package/dist/lib/apify_command.d.ts +17 -0
- package/dist/lib/apify_command.d.ts.map +1 -0
- package/dist/lib/apify_command.js +76 -0
- package/dist/lib/apify_command.js.map +1 -0
- package/dist/lib/commands/pretty-print-bytes.d.ts +7 -0
- package/dist/lib/commands/pretty-print-bytes.d.ts.map +1 -0
- package/dist/lib/commands/pretty-print-bytes.js.map +1 -1
- package/dist/lib/commands/pretty-print-status.d.ts +3 -0
- package/dist/lib/commands/pretty-print-status.d.ts.map +1 -0
- package/dist/lib/commands/read-stdin.d.ts +2 -0
- package/dist/lib/commands/read-stdin.d.ts.map +1 -0
- package/dist/lib/commands/read-stdin.js +20 -34
- package/dist/lib/commands/read-stdin.js.map +1 -1
- package/dist/lib/commands/resolve-actor-context.d.ts +22 -0
- package/dist/lib/commands/resolve-actor-context.d.ts.map +1 -0
- package/dist/lib/commands/resolve-actor-context.js.map +1 -1
- package/dist/lib/commands/resolve-input.d.ts +9 -0
- package/dist/lib/commands/resolve-input.d.ts.map +1 -0
- package/dist/lib/commands/resolve-input.js +6 -6
- package/dist/lib/commands/resolve-input.js.map +1 -1
- package/dist/lib/commands/responsive-table.d.ts +62 -0
- package/dist/lib/commands/responsive-table.d.ts.map +1 -0
- package/dist/lib/commands/run-on-cloud.d.ts +22 -0
- package/dist/lib/commands/run-on-cloud.d.ts.map +1 -0
- package/dist/lib/commands/run-on-cloud.js +1 -1
- package/dist/lib/commands/run-on-cloud.js.map +1 -1
- package/dist/lib/commands/storage-size.d.ts +6 -0
- package/dist/lib/commands/storage-size.d.ts.map +1 -0
- package/dist/lib/commands/storages.d.ts +10 -0
- package/dist/lib/commands/storages.d.ts.map +1 -0
- package/dist/lib/community.d.ts +2 -0
- package/dist/lib/community.d.ts.map +1 -0
- package/dist/lib/community.js +4 -0
- package/dist/lib/community.js.map +1 -0
- package/dist/lib/consts.d.ts +56 -0
- package/dist/lib/consts.d.ts.map +1 -0
- package/dist/lib/consts.js +8 -1
- package/dist/lib/consts.js.map +1 -1
- package/dist/lib/create-utils.d.ts +8 -0
- package/dist/lib/create-utils.d.ts.map +1 -0
- package/dist/lib/exec.d.ts +9 -0
- package/dist/lib/exec.d.ts.map +1 -0
- package/dist/lib/files.d.ts +14 -0
- package/dist/lib/files.d.ts.map +1 -0
- package/dist/lib/hooks/runtimes/javascript.d.ts +4 -0
- package/dist/lib/hooks/runtimes/javascript.d.ts.map +1 -0
- package/dist/lib/hooks/runtimes/python.d.ts +8 -0
- package/dist/lib/hooks/runtimes/python.d.ts.map +1 -0
- package/dist/lib/hooks/runtimes/utils.d.ts +3 -0
- package/dist/lib/hooks/runtimes/utils.d.ts.map +1 -0
- package/dist/lib/hooks/runtimes/utils.js +6 -3
- package/dist/lib/hooks/runtimes/utils.js.map +1 -1
- package/dist/lib/hooks/useActorConfig.d.ts +20 -0
- package/dist/lib/hooks/useActorConfig.d.ts.map +1 -0
- package/dist/lib/hooks/useCwdProject.d.ts +33 -0
- package/dist/lib/hooks/useCwdProject.d.ts.map +1 -0
- package/dist/lib/hooks/useCwdProject.js.map +1 -1
- package/dist/lib/hooks/useModuleVersion.d.ts +8 -0
- package/dist/lib/hooks/useModuleVersion.d.ts.map +1 -0
- package/dist/lib/input_schema.d.ts +28 -0
- package/dist/lib/input_schema.d.ts.map +1 -0
- package/dist/lib/input_schema.js +2 -2
- package/dist/lib/input_schema.js.map +1 -1
- package/dist/lib/local_state.d.ts +11 -0
- package/dist/lib/local_state.d.ts.map +1 -0
- package/dist/lib/local_state.js +25 -0
- package/dist/lib/local_state.js.map +1 -0
- package/dist/lib/outputs.d.ts +19 -0
- package/dist/lib/outputs.d.ts.map +1 -0
- package/dist/lib/outputs.js +1 -1
- package/dist/lib/outputs.js.map +1 -1
- package/dist/lib/project_analyzer.d.ts +4 -0
- package/dist/lib/project_analyzer.d.ts.map +1 -0
- package/dist/lib/projects/CrawleeAnalyzer.d.ts +4 -0
- package/dist/lib/projects/CrawleeAnalyzer.d.ts.map +1 -0
- package/dist/lib/projects/OldApifySDKAnalyzer.d.ts +4 -0
- package/dist/lib/projects/OldApifySDKAnalyzer.d.ts.map +1 -0
- package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.d.ts +17 -0
- package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.d.ts.map +1 -0
- package/dist/lib/projects/scrapy/Spider.d.ts +14 -0
- package/dist/lib/projects/scrapy/Spider.d.ts.map +1 -0
- package/dist/lib/projects/scrapy/SpiderFileAnalyzer.d.ts +7 -0
- package/dist/lib/projects/scrapy/SpiderFileAnalyzer.d.ts.map +1 -0
- package/dist/lib/projects/scrapy/wrapScrapyProject.d.ts +4 -0
- package/dist/lib/projects/scrapy/wrapScrapyProject.d.ts.map +1 -0
- package/dist/lib/projects/shared.d.ts +2 -0
- package/dist/lib/projects/shared.d.ts.map +1 -0
- package/dist/lib/secrets.d.ts +22 -0
- package/dist/lib/secrets.d.ts.map +1 -0
- package/dist/lib/telemetry.d.ts +21 -0
- package/dist/lib/telemetry.d.ts.map +1 -0
- package/dist/lib/telemetry.js.map +1 -1
- package/dist/lib/types.d.ts +11 -0
- package/dist/lib/types.d.ts.map +1 -0
- package/dist/lib/types.js +1 -3
- package/dist/lib/types.js.map +1 -1
- package/dist/lib/utils/cliDebugPrint.d.ts +2 -0
- package/dist/lib/utils/cliDebugPrint.d.ts.map +1 -0
- package/dist/lib/utils/confirm.d.ts +7 -0
- package/dist/lib/utils/confirm.d.ts.map +1 -0
- package/dist/lib/utils/confirm.js.map +1 -1
- package/dist/lib/utils.d.ts +113 -0
- package/dist/lib/utils.d.ts.map +1 -0
- package/dist/lib/utils.js +14 -23
- package/dist/lib/utils.js.map +1 -1
- package/dist/lib/version_check.d.ts +14 -0
- package/dist/lib/version_check.d.ts.map +1 -0
- package/dist/lib/version_check.js +99 -0
- package/dist/lib/version_check.js.map +1 -0
- package/dist/typechecking.tsbuildinfo +1 -0
- package/oclif.manifest.json +2661 -0
- package/package.json +54 -60
- package/LICENSE.md +0 -201
- package/dist/commands/_register.js +0 -68
- package/dist/commands/_register.js.map +0 -1
- package/dist/commands/actor/_index.js +0 -24
- package/dist/commands/actor/_index.js.map +0 -1
- package/dist/commands/actors/_index.js +0 -28
- package/dist/commands/actors/_index.js.map +0 -1
- package/dist/commands/builds/_index.js +0 -22
- package/dist/commands/builds/_index.js.map +0 -1
- package/dist/commands/datasets/_index.js +0 -25
- package/dist/commands/datasets/_index.js.map +0 -1
- package/dist/commands/help.js +0 -43
- package/dist/commands/help.js.map +0 -1
- package/dist/commands/key-value-stores/_index.js +0 -30
- package/dist/commands/key-value-stores/_index.js.map +0 -1
- package/dist/commands/request-queues/_index.js.map +0 -1
- package/dist/commands/runs/_index.js +0 -23
- package/dist/commands/runs/_index.js.map +0 -1
- package/dist/commands/secrets/_index.js.map +0 -1
- package/dist/commands/task/_index.js +0 -11
- package/dist/commands/task/_index.js.map +0 -1
- package/dist/commands/upgrade.js +0 -74
- package/dist/commands/upgrade.js.map +0 -1
- package/dist/entrypoints/_shared.js +0 -256
- package/dist/entrypoints/_shared.js.map +0 -1
- package/dist/entrypoints/actor.js +0 -19
- package/dist/entrypoints/actor.js.map +0 -1
- package/dist/entrypoints/apify.js +0 -18
- package/dist/entrypoints/apify.js.map +0 -1
- package/dist/lib/command-framework/apify-command.js +0 -426
- package/dist/lib/command-framework/apify-command.js.map +0 -1
- package/dist/lib/command-framework/args.js +0 -24
- package/dist/lib/command-framework/args.js.map +0 -1
- package/dist/lib/command-framework/flags.js +0 -99
- package/dist/lib/command-framework/flags.js.map +0 -1
- package/dist/lib/command-framework/help/CommandHelp.js +0 -228
- package/dist/lib/command-framework/help/CommandHelp.js.map +0 -1
- package/dist/lib/command-framework/help/CommandWithSubcommands.js +0 -75
- package/dist/lib/command-framework/help/CommandWithSubcommands.js.map +0 -1
- package/dist/lib/command-framework/help/_BaseCommandRenderer.js +0 -63
- package/dist/lib/command-framework/help/_BaseCommandRenderer.js.map +0 -1
- package/dist/lib/command-framework/help/consts.js +0 -27
- package/dist/lib/command-framework/help/consts.js.map +0 -1
- package/dist/lib/command-framework/help.js +0 -105
- package/dist/lib/command-framework/help.js.map +0 -1
- package/dist/lib/hooks/useCLIMetadata.js +0 -73
- package/dist/lib/hooks/useCLIMetadata.js.map +0 -1
- package/dist/lib/hooks/useCLIVersionCheck.js +0 -91
- package/dist/lib/hooks/useCLIVersionCheck.js.map +0 -1
- package/dist/lib/hooks/useCommandSuggestions.js +0 -37
- package/dist/lib/hooks/useCommandSuggestions.js.map +0 -1
- package/dist/lib/hooks/useLocalState.js +0 -56
- package/dist/lib/hooks/useLocalState.js.map +0 -1
- package/dist/lib/hooks/useStdin.js +0 -65
- package/dist/lib/hooks/useStdin.js.map +0 -1
package/README.md
CHANGED
|
@@ -279,3 +279,1434 @@ or [contact us](https://www.apify.com/contact).
|
|
|
279
279
|
## Command reference
|
|
280
280
|
|
|
281
281
|
This section contains printouts of `apify help` for all commands.
|
|
282
|
+
|
|
283
|
+
<!-- prettier-ignore-start -->
|
|
284
|
+
<!-- commands -->
|
|
285
|
+
* [`apify actor`](#apify-actor)
|
|
286
|
+
* [`apify actor charge EVENTNAME`](#apify-actor-charge-eventname)
|
|
287
|
+
* [`apify actor get-input`](#apify-actor-get-input)
|
|
288
|
+
* [`apify actor get-public-url KEY`](#apify-actor-get-public-url-key)
|
|
289
|
+
* [`apify actor get-value KEY`](#apify-actor-get-value-key)
|
|
290
|
+
* [`apify actor push-data [ITEM]`](#apify-actor-push-data-item)
|
|
291
|
+
* [`apify actor set-value KEY [VALUE]`](#apify-actor-set-value-key-value)
|
|
292
|
+
* [`apify actors`](#apify-actors)
|
|
293
|
+
* [`apify actors build [ACTORID]`](#apify-actors-build-actorid)
|
|
294
|
+
* [`apify actors call [ACTORID]`](#apify-actors-call-actorid)
|
|
295
|
+
* [`apify actors info ACTORID`](#apify-actors-info-actorid)
|
|
296
|
+
* [`apify actors ls`](#apify-actors-ls)
|
|
297
|
+
* [`apify actors pull [ACTORID]`](#apify-actors-pull-actorid)
|
|
298
|
+
* [`apify actors push [ACTORID]`](#apify-actors-push-actorid)
|
|
299
|
+
* [`apify actors rm ACTORID`](#apify-actors-rm-actorid)
|
|
300
|
+
* [`apify actors start [ACTORID]`](#apify-actors-start-actorid)
|
|
301
|
+
* [`apify builds`](#apify-builds)
|
|
302
|
+
* [`apify builds create [ACTORID]`](#apify-builds-create-actorid)
|
|
303
|
+
* [`apify builds info BUILDID`](#apify-builds-info-buildid)
|
|
304
|
+
* [`apify builds log BUILDID`](#apify-builds-log-buildid)
|
|
305
|
+
* [`apify builds ls [ACTORID]`](#apify-builds-ls-actorid)
|
|
306
|
+
* [`apify builds rm BUILDID`](#apify-builds-rm-buildid)
|
|
307
|
+
* [`apify call [ACTORID]`](#apify-call-actorid)
|
|
308
|
+
* [`apify create [ACTORNAME]`](#apify-create-actorname)
|
|
309
|
+
* [`apify datasets`](#apify-datasets)
|
|
310
|
+
* [`apify datasets create [DATASETNAME]`](#apify-datasets-create-datasetname)
|
|
311
|
+
* [`apify datasets get-items DATASETID`](#apify-datasets-get-items-datasetid)
|
|
312
|
+
* [`apify datasets info STOREID`](#apify-datasets-info-storeid)
|
|
313
|
+
* [`apify datasets ls`](#apify-datasets-ls)
|
|
314
|
+
* [`apify datasets push-items NAMEORID [ITEM]`](#apify-datasets-push-items-nameorid-item)
|
|
315
|
+
* [`apify datasets rename NAMEORID [NEWNAME]`](#apify-datasets-rename-nameorid-newname)
|
|
316
|
+
* [`apify datasets rm DATASETNAMEORID`](#apify-datasets-rm-datasetnameorid)
|
|
317
|
+
* [`apify help [COMMAND]`](#apify-help-command)
|
|
318
|
+
* [`apify info`](#apify-info)
|
|
319
|
+
* [`apify init [ACTORNAME]`](#apify-init-actorname)
|
|
320
|
+
* [`apify key-value-stores`](#apify-key-value-stores)
|
|
321
|
+
* [`apify key-value-stores create [KEYVALUESTORENAME]`](#apify-key-value-stores-create-keyvaluestorename)
|
|
322
|
+
* [`apify key-value-stores delete-value STOREID ITEMKEY`](#apify-key-value-stores-delete-value-storeid-itemkey)
|
|
323
|
+
* [`apify key-value-stores get-value KEYVALUESTOREID ITEMKEY`](#apify-key-value-stores-get-value-keyvaluestoreid-itemkey)
|
|
324
|
+
* [`apify key-value-stores info STOREID`](#apify-key-value-stores-info-storeid)
|
|
325
|
+
* [`apify key-value-stores keys STOREID`](#apify-key-value-stores-keys-storeid)
|
|
326
|
+
* [`apify key-value-stores ls`](#apify-key-value-stores-ls)
|
|
327
|
+
* [`apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME]`](#apify-key-value-stores-rename-keyvaluestorenameorid-newname)
|
|
328
|
+
* [`apify key-value-stores rm KEYVALUESTORENAMEORID`](#apify-key-value-stores-rm-keyvaluestorenameorid)
|
|
329
|
+
* [`apify key-value-stores set-value STOREID ITEMKEY [VALUE]`](#apify-key-value-stores-set-value-storeid-itemkey-value)
|
|
330
|
+
* [`apify login`](#apify-login)
|
|
331
|
+
* [`apify logout`](#apify-logout)
|
|
332
|
+
* [`apify pull [ACTORID]`](#apify-pull-actorid)
|
|
333
|
+
* [`apify push [ACTORID]`](#apify-push-actorid)
|
|
334
|
+
* [`apify request-queues`](#apify-request-queues)
|
|
335
|
+
* [`apify run`](#apify-run)
|
|
336
|
+
* [`apify runs`](#apify-runs)
|
|
337
|
+
* [`apify runs abort RUNID`](#apify-runs-abort-runid)
|
|
338
|
+
* [`apify runs info RUNID`](#apify-runs-info-runid)
|
|
339
|
+
* [`apify runs log RUNID`](#apify-runs-log-runid)
|
|
340
|
+
* [`apify runs ls [ACTORID]`](#apify-runs-ls-actorid)
|
|
341
|
+
* [`apify runs resurrect RUNID`](#apify-runs-resurrect-runid)
|
|
342
|
+
* [`apify runs rm RUNID`](#apify-runs-rm-runid)
|
|
343
|
+
* [`apify secrets`](#apify-secrets)
|
|
344
|
+
* [`apify secrets add NAME VALUE`](#apify-secrets-add-name-value)
|
|
345
|
+
* [`apify secrets rm NAME`](#apify-secrets-rm-name)
|
|
346
|
+
* [`apify task`](#apify-task)
|
|
347
|
+
* [`apify task run TASKID`](#apify-task-run-taskid)
|
|
348
|
+
* [`apify validate-schema [PATH]`](#apify-validate-schema-path)
|
|
349
|
+
|
|
350
|
+
## `apify actor`
|
|
351
|
+
|
|
352
|
+
Manages runtime data operations inside of a running Actor.
|
|
353
|
+
|
|
354
|
+
```
|
|
355
|
+
USAGE
|
|
356
|
+
$ apify actor
|
|
357
|
+
|
|
358
|
+
DESCRIPTION
|
|
359
|
+
Manages runtime data operations inside of a running Actor.
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actor/index.ts)_
|
|
363
|
+
|
|
364
|
+
## `apify actor charge EVENTNAME`
|
|
365
|
+
|
|
366
|
+
Charge for a specific event in the pay-per-event Actor run.
|
|
367
|
+
|
|
368
|
+
```
|
|
369
|
+
USAGE
|
|
370
|
+
$ apify actor charge EVENTNAME [--count <value>] [--idempotency-key <value>] [--test-pay-per-event]
|
|
371
|
+
|
|
372
|
+
ARGUMENTS
|
|
373
|
+
EVENTNAME Name of the event to charge for
|
|
374
|
+
|
|
375
|
+
FLAGS
|
|
376
|
+
--count=<value> [default: 1] Number of events to charge
|
|
377
|
+
--idempotency-key=<value> Idempotency key for the charge request
|
|
378
|
+
--test-pay-per-event Test pay-per-event charging without actually charging
|
|
379
|
+
|
|
380
|
+
DESCRIPTION
|
|
381
|
+
Charge for a specific event in the pay-per-event Actor run.
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
_See code: [src/commands/actor/charge.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actor/charge.ts)_
|
|
385
|
+
|
|
386
|
+
## `apify actor get-input`
|
|
387
|
+
|
|
388
|
+
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
389
|
+
|
|
390
|
+
```
|
|
391
|
+
USAGE
|
|
392
|
+
$ apify actor get-input
|
|
393
|
+
|
|
394
|
+
DESCRIPTION
|
|
395
|
+
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actor/get-input.ts)_
|
|
399
|
+
|
|
400
|
+
## `apify actor get-public-url KEY`
|
|
401
|
+
|
|
402
|
+
Get an HTTP URL that allows public access to a key-value store item.
|
|
403
|
+
|
|
404
|
+
```
|
|
405
|
+
USAGE
|
|
406
|
+
$ apify actor get-public-url KEY
|
|
407
|
+
|
|
408
|
+
ARGUMENTS
|
|
409
|
+
KEY Key of the record in key-value store
|
|
410
|
+
|
|
411
|
+
DESCRIPTION
|
|
412
|
+
Get an HTTP URL that allows public access to a key-value store item.
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
_See code: [src/commands/actor/get-public-url.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actor/get-public-url.ts)_
|
|
416
|
+
|
|
417
|
+
## `apify actor get-value KEY`
|
|
418
|
+
|
|
419
|
+
Gets a value from the default key-value store associated with the Actor run.
|
|
420
|
+
|
|
421
|
+
```
|
|
422
|
+
USAGE
|
|
423
|
+
$ apify actor get-value KEY
|
|
424
|
+
|
|
425
|
+
ARGUMENTS
|
|
426
|
+
KEY Key of the record in key-value store
|
|
427
|
+
|
|
428
|
+
DESCRIPTION
|
|
429
|
+
Gets a value from the default key-value store associated with the Actor run.
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actor/get-value.ts)_
|
|
433
|
+
|
|
434
|
+
## `apify actor push-data [ITEM]`
|
|
435
|
+
|
|
436
|
+
Saves data to Actor's run default dataset.
|
|
437
|
+
|
|
438
|
+
```
|
|
439
|
+
USAGE
|
|
440
|
+
$ apify actor push-data [ITEM]
|
|
441
|
+
|
|
442
|
+
ARGUMENTS
|
|
443
|
+
ITEM JSON string with one object or array of objects containing data to be stored in the default dataset.
|
|
444
|
+
|
|
445
|
+
DESCRIPTION
|
|
446
|
+
Saves data to Actor's run default dataset.
|
|
447
|
+
|
|
448
|
+
Accept input as:
|
|
449
|
+
- JSON argument:
|
|
450
|
+
$ apify actor push-data {"key": "value"}
|
|
451
|
+
- Piped stdin:
|
|
452
|
+
$ cat ./test.json | apify actor push-data
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actor/push-data.ts)_
|
|
456
|
+
|
|
457
|
+
## `apify actor set-value KEY [VALUE]`
|
|
458
|
+
|
|
459
|
+
Sets or removes record into the default key-value store associated with the Actor run.
|
|
460
|
+
|
|
461
|
+
```
|
|
462
|
+
USAGE
|
|
463
|
+
$ apify actor set-value KEY [VALUE] [-c <value>]
|
|
464
|
+
|
|
465
|
+
ARGUMENTS
|
|
466
|
+
KEY Key of the record in key-value store.
|
|
467
|
+
VALUE Record data, which can be one of the following values:
|
|
468
|
+
- If empty, the record in the key-value store is deleted.
|
|
469
|
+
- If no `contentType` flag is specified, value is expected to be any JSON string value.
|
|
470
|
+
- If options.contentType is set, value is taken as is.
|
|
471
|
+
|
|
472
|
+
FLAGS
|
|
473
|
+
-c, --contentType=<value> Specifies a custom MIME content type of the record. By default "application/json" is used.
|
|
474
|
+
|
|
475
|
+
DESCRIPTION
|
|
476
|
+
Sets or removes record into the default key-value store associated with the Actor run.
|
|
477
|
+
|
|
478
|
+
It is possible to pass data using argument or stdin.
|
|
479
|
+
|
|
480
|
+
Passing data using argument:
|
|
481
|
+
$ apify actor set-value KEY my-value
|
|
482
|
+
|
|
483
|
+
Passing data using stdin with pipe:
|
|
484
|
+
$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actor/set-value.ts)_
|
|
488
|
+
|
|
489
|
+
## `apify actors`
|
|
490
|
+
|
|
491
|
+
Manages Actor creation, deployment, and execution on the Apify platform.
|
|
492
|
+
|
|
493
|
+
```
|
|
494
|
+
USAGE
|
|
495
|
+
$ apify actors
|
|
496
|
+
|
|
497
|
+
DESCRIPTION
|
|
498
|
+
Manages Actor creation, deployment, and execution on the Apify platform.
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
_See code: [src/commands/actors/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/index.ts)_
|
|
502
|
+
|
|
503
|
+
## `apify actors build [ACTORID]`
|
|
504
|
+
|
|
505
|
+
Creates a new build of the Actor.
|
|
506
|
+
|
|
507
|
+
```
|
|
508
|
+
USAGE
|
|
509
|
+
$ apify actors build [ACTORID] [--json] [--tag <value>] [--version <value>] [--log]
|
|
510
|
+
|
|
511
|
+
ARGUMENTS
|
|
512
|
+
ACTORID Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the current
|
|
513
|
+
directory.
|
|
514
|
+
|
|
515
|
+
FLAGS
|
|
516
|
+
--log Whether to print out the build log after the build is triggered.
|
|
517
|
+
--tag=<value> Build tag to be applied to the successful Actor build. By default, this is "latest".
|
|
518
|
+
--version=<value> Optional Actor Version to build. By default, this will be inferred from the tag, but this flag is
|
|
519
|
+
required when multiple versions have the same tag.
|
|
520
|
+
|
|
521
|
+
GLOBAL FLAGS
|
|
522
|
+
--json Format output as json.
|
|
523
|
+
|
|
524
|
+
DESCRIPTION
|
|
525
|
+
Creates a new build of the Actor.
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
_See code: [src/commands/actors/build.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/build.ts)_
|
|
529
|
+
|
|
530
|
+
## `apify actors call [ACTORID]`
|
|
531
|
+
|
|
532
|
+
Executes Actor remotely using your authenticated account.
|
|
533
|
+
|
|
534
|
+
```
|
|
535
|
+
USAGE
|
|
536
|
+
$ apify actors call [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
537
|
+
<value>] [-s] [-o]
|
|
538
|
+
|
|
539
|
+
ARGUMENTS
|
|
540
|
+
ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
|
|
541
|
+
provided, the command runs the remote Actor specified in the '.actor/actor.json' file.
|
|
542
|
+
|
|
543
|
+
FLAGS
|
|
544
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
545
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
546
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
547
|
+
-o, --output-dataset Prints out the entire default dataset on successful run of the Actor.
|
|
548
|
+
-s, --silent Prevents printing the logs of the Actor run to the console.
|
|
549
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
550
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
551
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
552
|
+
|
|
553
|
+
GLOBAL FLAGS
|
|
554
|
+
--json Format output as json.
|
|
555
|
+
|
|
556
|
+
DESCRIPTION
|
|
557
|
+
Executes Actor remotely using your authenticated account.
|
|
558
|
+
Reads input from local key-value store by default.
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
_See code: [src/commands/actors/call.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/call.ts)_
|
|
562
|
+
|
|
563
|
+
## `apify actors info ACTORID`
|
|
564
|
+
|
|
565
|
+
Get information about an Actor.
|
|
566
|
+
|
|
567
|
+
```
|
|
568
|
+
USAGE
|
|
569
|
+
$ apify actors info ACTORID [--json] [--readme | --input]
|
|
570
|
+
|
|
571
|
+
ARGUMENTS
|
|
572
|
+
ACTORID The ID of the Actor to return information about.
|
|
573
|
+
|
|
574
|
+
FLAGS
|
|
575
|
+
--input Return the Actor input schema.
|
|
576
|
+
--readme Return the Actor README.
|
|
577
|
+
|
|
578
|
+
GLOBAL FLAGS
|
|
579
|
+
--json Format output as json.
|
|
580
|
+
|
|
581
|
+
DESCRIPTION
|
|
582
|
+
Get information about an Actor.
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
_See code: [src/commands/actors/info.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/info.ts)_
|
|
586
|
+
|
|
587
|
+
## `apify actors ls`
|
|
588
|
+
|
|
589
|
+
Prints a list of recently executed Actors or Actors you own.
|
|
590
|
+
|
|
591
|
+
```
|
|
592
|
+
USAGE
|
|
593
|
+
$ apify actors ls [--json] [--my] [--offset <value>] [--limit <value>] [--desc]
|
|
594
|
+
|
|
595
|
+
FLAGS
|
|
596
|
+
--desc Sort Actors in descending order.
|
|
597
|
+
--limit=<value> [default: 20] Number of Actors that will be listed.
|
|
598
|
+
--my Whether to list Actors made by the logged in user.
|
|
599
|
+
--offset=<value> Number of Actors that will be skipped.
|
|
600
|
+
|
|
601
|
+
GLOBAL FLAGS
|
|
602
|
+
--json Format output as json.
|
|
603
|
+
|
|
604
|
+
DESCRIPTION
|
|
605
|
+
Prints a list of recently executed Actors or Actors you own.
|
|
606
|
+
```
|
|
607
|
+
|
|
608
|
+
_See code: [src/commands/actors/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/ls.ts)_
|
|
609
|
+
|
|
610
|
+
## `apify actors pull [ACTORID]`
|
|
611
|
+
|
|
612
|
+
Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
|
|
613
|
+
|
|
614
|
+
```
|
|
615
|
+
USAGE
|
|
616
|
+
$ apify actors pull [ACTORID] [-v <value>] [--dir <value>]
|
|
617
|
+
|
|
618
|
+
ARGUMENTS
|
|
619
|
+
ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
620
|
+
command will update the Actor in the current directory based on its name in ".actor/actor.json" file.
|
|
621
|
+
|
|
622
|
+
FLAGS
|
|
623
|
+
-v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
|
|
624
|
+
--dir=<value> Directory where the Actor should be pulled to
|
|
625
|
+
|
|
626
|
+
DESCRIPTION
|
|
627
|
+
Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
_See code: [src/commands/actors/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/pull.ts)_
|
|
631
|
+
|
|
632
|
+
## `apify actors push [ACTORID]`
|
|
633
|
+
|
|
634
|
+
Deploys Actor to Apify platform using settings from '.actor/actor.json'.
|
|
635
|
+
|
|
636
|
+
```
|
|
637
|
+
USAGE
|
|
638
|
+
$ apify actors push [ACTORID] [-v <value>] [-b <value>] [-w <value>] [--no-prompt] [--force] [--dir <value>]
|
|
639
|
+
|
|
640
|
+
ARGUMENTS
|
|
641
|
+
ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
642
|
+
command will create or modify the Actor with the name specified in '.actor/actor.json' file.
|
|
643
|
+
|
|
644
|
+
FLAGS
|
|
645
|
+
-b, --build-tag=<value> Build tag to be applied to the successful Actor build. By default, it is taken from the
|
|
646
|
+
'.actor/actor.json' file
|
|
647
|
+
-v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
|
|
648
|
+
the '.actor/actor.json' file.
|
|
649
|
+
-w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
|
|
650
|
+
--dir=<value> Directory where the Actor is located
|
|
651
|
+
--force Push an Actor even when the local files are older than the Actor on the platform.
|
|
652
|
+
--no-prompt Do not prompt for opening the Actor details in a browser. This will also not open the
|
|
653
|
+
browser automatically.
|
|
654
|
+
|
|
655
|
+
DESCRIPTION
|
|
656
|
+
Deploys Actor to Apify platform using settings from '.actor/actor.json'.
|
|
657
|
+
Files under '3' MB upload as "Multiple source files"; larger projects upload as ZIP file.
|
|
658
|
+
Use --force to override newer remote versions.
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
_See code: [src/commands/actors/push.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/push.ts)_
|
|
662
|
+
|
|
663
|
+
## `apify actors rm ACTORID`
|
|
664
|
+
|
|
665
|
+
Permanently removes an Actor from your account.
|
|
666
|
+
|
|
667
|
+
```
|
|
668
|
+
USAGE
|
|
669
|
+
$ apify actors rm ACTORID
|
|
670
|
+
|
|
671
|
+
ARGUMENTS
|
|
672
|
+
ACTORID The Actor ID to delete.
|
|
673
|
+
|
|
674
|
+
DESCRIPTION
|
|
675
|
+
Permanently removes an Actor from your account.
|
|
676
|
+
```
|
|
677
|
+
|
|
678
|
+
_See code: [src/commands/actors/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/rm.ts)_
|
|
679
|
+
|
|
680
|
+
## `apify actors start [ACTORID]`
|
|
681
|
+
|
|
682
|
+
Starts Actor remotely and returns run details immediately.
|
|
683
|
+
|
|
684
|
+
```
|
|
685
|
+
USAGE
|
|
686
|
+
$ apify actors start [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
687
|
+
<value>]
|
|
688
|
+
|
|
689
|
+
ARGUMENTS
|
|
690
|
+
ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
|
|
691
|
+
provided, the command runs the remote Actor specified in the '.actor/actor.json' file.
|
|
692
|
+
|
|
693
|
+
FLAGS
|
|
694
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
695
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
696
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
697
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
698
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
699
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
700
|
+
|
|
701
|
+
GLOBAL FLAGS
|
|
702
|
+
--json Format output as json.
|
|
703
|
+
|
|
704
|
+
DESCRIPTION
|
|
705
|
+
Starts Actor remotely and returns run details immediately.
|
|
706
|
+
Uses authenticated account and local key-value store for input.
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
_See code: [src/commands/actors/start.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/actors/start.ts)_
|
|
710
|
+
|
|
711
|
+
## `apify builds`
|
|
712
|
+
|
|
713
|
+
Manages Actor build processes and versioning.
|
|
714
|
+
|
|
715
|
+
```
|
|
716
|
+
USAGE
|
|
717
|
+
$ apify builds
|
|
718
|
+
|
|
719
|
+
DESCRIPTION
|
|
720
|
+
Manages Actor build processes and versioning.
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
_See code: [src/commands/builds/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/builds/index.ts)_
|
|
724
|
+
|
|
725
|
+
## `apify builds create [ACTORID]`
|
|
726
|
+
|
|
727
|
+
Creates a new build of the Actor.
|
|
728
|
+
|
|
729
|
+
```
|
|
730
|
+
USAGE
|
|
731
|
+
$ apify builds create [ACTORID] [--json] [--tag <value>] [--version <value>] [--log]
|
|
732
|
+
|
|
733
|
+
ARGUMENTS
|
|
734
|
+
ACTORID Optional Actor ID or Name to trigger a build for. By default, it will use the Actor from the current
|
|
735
|
+
directory.
|
|
736
|
+
|
|
737
|
+
FLAGS
|
|
738
|
+
--log Whether to print out the build log after the build is triggered.
|
|
739
|
+
--tag=<value> Build tag to be applied to the successful Actor build. By default, this is "latest".
|
|
740
|
+
--version=<value> Optional Actor Version to build. By default, this will be inferred from the tag, but this flag is
|
|
741
|
+
required when multiple versions have the same tag.
|
|
742
|
+
|
|
743
|
+
GLOBAL FLAGS
|
|
744
|
+
--json Format output as json.
|
|
745
|
+
|
|
746
|
+
DESCRIPTION
|
|
747
|
+
Creates a new build of the Actor.
|
|
748
|
+
```
|
|
749
|
+
|
|
750
|
+
_See code: [src/commands/builds/create.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/builds/create.ts)_
|
|
751
|
+
|
|
752
|
+
## `apify builds info BUILDID`
|
|
753
|
+
|
|
754
|
+
Prints information about a specific build.
|
|
755
|
+
|
|
756
|
+
```
|
|
757
|
+
USAGE
|
|
758
|
+
$ apify builds info BUILDID [--json]
|
|
759
|
+
|
|
760
|
+
ARGUMENTS
|
|
761
|
+
BUILDID The build ID to get information about.
|
|
762
|
+
|
|
763
|
+
GLOBAL FLAGS
|
|
764
|
+
--json Format output as json.
|
|
765
|
+
|
|
766
|
+
DESCRIPTION
|
|
767
|
+
Prints information about a specific build.
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
_See code: [src/commands/builds/info.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/builds/info.ts)_
|
|
771
|
+
|
|
772
|
+
## `apify builds log BUILDID`
|
|
773
|
+
|
|
774
|
+
Prints the log of a specific build.
|
|
775
|
+
|
|
776
|
+
```
|
|
777
|
+
USAGE
|
|
778
|
+
$ apify builds log BUILDID
|
|
779
|
+
|
|
780
|
+
ARGUMENTS
|
|
781
|
+
BUILDID The build ID to get the log from.
|
|
782
|
+
|
|
783
|
+
DESCRIPTION
|
|
784
|
+
Prints the log of a specific build.
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
_See code: [src/commands/builds/log.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/builds/log.ts)_
|
|
788
|
+
|
|
789
|
+
## `apify builds ls [ACTORID]`
|
|
790
|
+
|
|
791
|
+
Lists all builds of the Actor.
|
|
792
|
+
|
|
793
|
+
```
|
|
794
|
+
USAGE
|
|
795
|
+
$ apify builds ls [ACTORID] [--json] [--offset <value>] [--limit <value>] [--desc] [-c]
|
|
796
|
+
|
|
797
|
+
ARGUMENTS
|
|
798
|
+
ACTORID Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current directory.
|
|
799
|
+
|
|
800
|
+
FLAGS
|
|
801
|
+
-c, --compact Display a compact table.
|
|
802
|
+
--desc Sort builds in descending order.
|
|
803
|
+
--limit=<value> [default: 10] Number of builds that will be listed.
|
|
804
|
+
--offset=<value> Number of builds that will be skipped.
|
|
805
|
+
|
|
806
|
+
GLOBAL FLAGS
|
|
807
|
+
--json Format output as json.
|
|
808
|
+
|
|
809
|
+
DESCRIPTION
|
|
810
|
+
Lists all builds of the Actor.
|
|
811
|
+
```
|
|
812
|
+
|
|
813
|
+
_See code: [src/commands/builds/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/builds/ls.ts)_
|
|
814
|
+
|
|
815
|
+
## `apify builds rm BUILDID`
|
|
816
|
+
|
|
817
|
+
Permanently removes an Actor build from the Apify platform.
|
|
818
|
+
|
|
819
|
+
```
|
|
820
|
+
USAGE
|
|
821
|
+
$ apify builds rm BUILDID
|
|
822
|
+
|
|
823
|
+
ARGUMENTS
|
|
824
|
+
BUILDID The build ID to delete.
|
|
825
|
+
|
|
826
|
+
DESCRIPTION
|
|
827
|
+
Permanently removes an Actor build from the Apify platform.
|
|
828
|
+
```
|
|
829
|
+
|
|
830
|
+
_See code: [src/commands/builds/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/builds/rm.ts)_
|
|
831
|
+
|
|
832
|
+
## `apify call [ACTORID]`
|
|
833
|
+
|
|
834
|
+
Executes Actor remotely using your authenticated account.
|
|
835
|
+
|
|
836
|
+
```
|
|
837
|
+
USAGE
|
|
838
|
+
$ apify call [ACTORID] [--json] [-b <value>] [-t <value>] [-m <value>] [-i <value> | --input-file
|
|
839
|
+
<value>] [-s] [-o]
|
|
840
|
+
|
|
841
|
+
ARGUMENTS
|
|
842
|
+
ACTORID Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not
|
|
843
|
+
provided, the command runs the remote Actor specified in the '.actor/actor.json' file.
|
|
844
|
+
|
|
845
|
+
FLAGS
|
|
846
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
847
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
848
|
+
-m, --memory=<value> Amount of memory allocated for the Actor run, in megabytes.
|
|
849
|
+
-o, --output-dataset Prints out the entire default dataset on successful run of the Actor.
|
|
850
|
+
-s, --silent Prevents printing the logs of the Actor run to the console.
|
|
851
|
+
-t, --timeout=<value> Timeout for the Actor run in seconds. Zero value means there is no timeout.
|
|
852
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid
|
|
853
|
+
JSON file. You can also specify `-` to read from standard input.
|
|
854
|
+
|
|
855
|
+
GLOBAL FLAGS
|
|
856
|
+
--json Format output as json.
|
|
857
|
+
|
|
858
|
+
DESCRIPTION
|
|
859
|
+
Executes Actor remotely using your authenticated account.
|
|
860
|
+
Reads input from local key-value store by default.
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/call.ts)_
|
|
864
|
+
|
|
865
|
+
## `apify create [ACTORNAME]`
|
|
866
|
+
|
|
867
|
+
Creates an Actor project from a template in a new directory.
|
|
868
|
+
|
|
869
|
+
```
|
|
870
|
+
USAGE
|
|
871
|
+
$ apify create [ACTORNAME] [-t <value>] [--skip-dependency-install] [--omit-optional-deps]
|
|
872
|
+
|
|
873
|
+
ARGUMENTS
|
|
874
|
+
ACTORNAME Name of the Actor and its directory
|
|
875
|
+
|
|
876
|
+
FLAGS
|
|
877
|
+
-t, --template=<value> Template for the Actor. If not provided, the command will prompt for it.
|
|
878
|
+
Visit
|
|
879
|
+
https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json
|
|
880
|
+
to find available template names.
|
|
881
|
+
--omit-optional-deps Skip installing optional dependencies.
|
|
882
|
+
--skip-dependency-install Skip installing Actor dependencies.
|
|
883
|
+
|
|
884
|
+
DESCRIPTION
|
|
885
|
+
Creates an Actor project from a template in a new directory.
|
|
886
|
+
```
|
|
887
|
+
|
|
888
|
+
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/create.ts)_
|
|
889
|
+
|
|
890
|
+
## `apify datasets`
|
|
891
|
+
|
|
892
|
+
Manages structured data storage and retrieval.
|
|
893
|
+
|
|
894
|
+
```
|
|
895
|
+
USAGE
|
|
896
|
+
$ apify datasets
|
|
897
|
+
|
|
898
|
+
DESCRIPTION
|
|
899
|
+
Manages structured data storage and retrieval.
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
_See code: [src/commands/datasets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/index.ts)_
|
|
903
|
+
|
|
904
|
+
## `apify datasets create [DATASETNAME]`
|
|
905
|
+
|
|
906
|
+
Creates a new dataset for storing structured data on your account.
|
|
907
|
+
|
|
908
|
+
```
|
|
909
|
+
USAGE
|
|
910
|
+
$ apify datasets create [DATASETNAME] [--json]
|
|
911
|
+
|
|
912
|
+
ARGUMENTS
|
|
913
|
+
DATASETNAME Optional name for the Dataset
|
|
914
|
+
|
|
915
|
+
GLOBAL FLAGS
|
|
916
|
+
--json Format output as json.
|
|
917
|
+
|
|
918
|
+
DESCRIPTION
|
|
919
|
+
Creates a new dataset for storing structured data on your account.
|
|
920
|
+
```
|
|
921
|
+
|
|
922
|
+
_See code: [src/commands/datasets/create.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/create.ts)_
|
|
923
|
+
|
|
924
|
+
## `apify datasets get-items DATASETID`
|
|
925
|
+
|
|
926
|
+
Retrieves dataset items in specified format (JSON, CSV, etc).
|
|
927
|
+
|
|
928
|
+
```
|
|
929
|
+
USAGE
|
|
930
|
+
$ apify datasets get-items DATASETID [--limit <value>] [--offset <value>] [--format json|jsonl|csv|html|rss|xml|xlsx]
|
|
931
|
+
|
|
932
|
+
ARGUMENTS
|
|
933
|
+
DATASETID The ID of the Dataset to export the items for
|
|
934
|
+
|
|
935
|
+
FLAGS
|
|
936
|
+
--format=<option> [default: json] The format of the returned output. By default, it is set to 'json'
|
|
937
|
+
<options: json|jsonl|csv|html|rss|xml|xlsx>
|
|
938
|
+
--limit=<value> The amount of elements to get from the dataset. By default, it will return all available items.
|
|
939
|
+
--offset=<value> The offset in the dataset where to start getting items.
|
|
940
|
+
|
|
941
|
+
DESCRIPTION
|
|
942
|
+
Retrieves dataset items in specified format (JSON, CSV, etc).
|
|
943
|
+
```
|
|
944
|
+
|
|
945
|
+
_See code: [src/commands/datasets/get-items.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/get-items.ts)_
|
|
946
|
+
|
|
947
|
+
## `apify datasets info STOREID`
|
|
948
|
+
|
|
949
|
+
Prints information about a specific dataset.
|
|
950
|
+
|
|
951
|
+
```
|
|
952
|
+
USAGE
|
|
953
|
+
$ apify datasets info STOREID [--json]
|
|
954
|
+
|
|
955
|
+
ARGUMENTS
|
|
956
|
+
STOREID The dataset store ID to print information about.
|
|
957
|
+
|
|
958
|
+
GLOBAL FLAGS
|
|
959
|
+
--json Format output as json.
|
|
960
|
+
|
|
961
|
+
DESCRIPTION
|
|
962
|
+
Prints information about a specific dataset.
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
_See code: [src/commands/datasets/info.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/info.ts)_
|
|
966
|
+
|
|
967
|
+
## `apify datasets ls`
|
|
968
|
+
|
|
969
|
+
Prints all datasets on your account.
|
|
970
|
+
|
|
971
|
+
```
|
|
972
|
+
USAGE
|
|
973
|
+
$ apify datasets ls [--json] [--offset <value>] [--limit <value>] [--desc] [--unnamed]
|
|
974
|
+
|
|
975
|
+
FLAGS
|
|
976
|
+
--desc Sorts datasets in descending order.
|
|
977
|
+
--limit=<value> [default: 20] Number of datasets that will be listed.
|
|
978
|
+
--offset=<value> Number of datasets that will be skipped.
|
|
979
|
+
--unnamed Lists datasets that don't have a name set.
|
|
980
|
+
|
|
981
|
+
GLOBAL FLAGS
|
|
982
|
+
--json Format output as json.
|
|
983
|
+
|
|
984
|
+
DESCRIPTION
|
|
985
|
+
Prints all datasets on your account.
|
|
986
|
+
```
|
|
987
|
+
|
|
988
|
+
_See code: [src/commands/datasets/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/ls.ts)_
|
|
989
|
+
|
|
990
|
+
## `apify datasets push-items NAMEORID [ITEM]`
|
|
991
|
+
|
|
992
|
+
Adds data items to specified dataset. Accepts single object or array of objects.
|
|
993
|
+
|
|
994
|
+
```
|
|
995
|
+
USAGE
|
|
996
|
+
$ apify datasets push-items NAMEORID [ITEM]
|
|
997
|
+
|
|
998
|
+
ARGUMENTS
|
|
999
|
+
NAMEORID The dataset ID or name to push the objects to
|
|
1000
|
+
ITEM The object or array of objects to be pushed.
|
|
1001
|
+
|
|
1002
|
+
DESCRIPTION
|
|
1003
|
+
Adds data items to specified dataset. Accepts single object or array of objects.
|
|
1004
|
+
```
|
|
1005
|
+
|
|
1006
|
+
_See code: [src/commands/datasets/push-items.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/push-items.ts)_
|
|
1007
|
+
|
|
1008
|
+
## `apify datasets rename NAMEORID [NEWNAME]`
|
|
1009
|
+
|
|
1010
|
+
Change dataset name or removes name with --unname flag.
|
|
1011
|
+
|
|
1012
|
+
```
|
|
1013
|
+
USAGE
|
|
1014
|
+
$ apify datasets rename NAMEORID [NEWNAME] [--unname]
|
|
1015
|
+
|
|
1016
|
+
ARGUMENTS
|
|
1017
|
+
NAMEORID The dataset ID or name to delete.
|
|
1018
|
+
NEWNAME The new name for the dataset.
|
|
1019
|
+
|
|
1020
|
+
FLAGS
|
|
1021
|
+
--unname Removes the unique name of the dataset.
|
|
1022
|
+
|
|
1023
|
+
DESCRIPTION
|
|
1024
|
+
Change dataset name or removes name with --unname flag.
|
|
1025
|
+
```
|
|
1026
|
+
|
|
1027
|
+
_See code: [src/commands/datasets/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/rename.ts)_
|
|
1028
|
+
|
|
1029
|
+
## `apify datasets rm DATASETNAMEORID`
|
|
1030
|
+
|
|
1031
|
+
Permanently removes a dataset.
|
|
1032
|
+
|
|
1033
|
+
```
|
|
1034
|
+
USAGE
|
|
1035
|
+
$ apify datasets rm DATASETNAMEORID
|
|
1036
|
+
|
|
1037
|
+
ARGUMENTS
|
|
1038
|
+
DATASETNAMEORID The dataset ID or name to delete
|
|
1039
|
+
|
|
1040
|
+
DESCRIPTION
|
|
1041
|
+
Permanently removes a dataset.
|
|
1042
|
+
```
|
|
1043
|
+
|
|
1044
|
+
_See code: [src/commands/datasets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/datasets/rm.ts)_
|
|
1045
|
+
|
|
1046
|
+
## `apify help [COMMAND]`
|
|
1047
|
+
|
|
1048
|
+
Display help for apify.
|
|
1049
|
+
|
|
1050
|
+
```
|
|
1051
|
+
USAGE
|
|
1052
|
+
$ apify help [COMMAND...] [-n]
|
|
1053
|
+
|
|
1054
|
+
ARGUMENTS
|
|
1055
|
+
COMMAND... Command to show help for.
|
|
1056
|
+
|
|
1057
|
+
FLAGS
|
|
1058
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
1059
|
+
|
|
1060
|
+
DESCRIPTION
|
|
1061
|
+
Display help for apify.
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.28/src/commands/help.ts)_
|
|
1065
|
+
|
|
1066
|
+
## `apify info`
|
|
1067
|
+
|
|
1068
|
+
Prints details about your currently authenticated Apify account.
|
|
1069
|
+
|
|
1070
|
+
```
|
|
1071
|
+
USAGE
|
|
1072
|
+
$ apify info
|
|
1073
|
+
|
|
1074
|
+
DESCRIPTION
|
|
1075
|
+
Prints details about your currently authenticated Apify account.
|
|
1076
|
+
```
|
|
1077
|
+
|
|
1078
|
+
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/info.ts)_
|
|
1079
|
+
|
|
1080
|
+
## `apify init [ACTORNAME]`
|
|
1081
|
+
|
|
1082
|
+
Sets up an Actor project in your current directory by creating actor.json and storage files.
|
|
1083
|
+
|
|
1084
|
+
```
|
|
1085
|
+
USAGE
|
|
1086
|
+
$ apify init [ACTORNAME] [-y]
|
|
1087
|
+
|
|
1088
|
+
ARGUMENTS
|
|
1089
|
+
ACTORNAME Name of the Actor. If not provided, you will be prompted for it.
|
|
1090
|
+
|
|
1091
|
+
FLAGS
|
|
1092
|
+
-y, --yes Automatic yes to prompts; assume "yes" as answer to all prompts. Note that in some cases, the command may
|
|
1093
|
+
still ask for confirmation.
|
|
1094
|
+
|
|
1095
|
+
DESCRIPTION
|
|
1096
|
+
Sets up an Actor project in your current directory by creating actor.json and storage files.
|
|
1097
|
+
If the directory contains a Scrapy project in Python, the command automatically creates wrappers so that you can run
|
|
1098
|
+
your scrapers without changes.
|
|
1099
|
+
Creates the '.actor/actor.json' file and the 'storage' directory in the current directory, but does not touch any
|
|
1100
|
+
other existing files or directories.
|
|
1101
|
+
|
|
1102
|
+
WARNING: Overwrites existing 'storage' directory.
|
|
1103
|
+
```
|
|
1104
|
+
|
|
1105
|
+
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/init.ts)_
|
|
1106
|
+
|
|
1107
|
+
## `apify key-value-stores`
|
|
1108
|
+
|
|
1109
|
+
Manages persistent key-value storage.
|
|
1110
|
+
|
|
1111
|
+
```
|
|
1112
|
+
USAGE
|
|
1113
|
+
$ apify key-value-stores
|
|
1114
|
+
|
|
1115
|
+
DESCRIPTION
|
|
1116
|
+
Manages persistent key-value storage.
|
|
1117
|
+
|
|
1118
|
+
Alias: kvs
|
|
1119
|
+
```
|
|
1120
|
+
|
|
1121
|
+
_See code: [src/commands/key-value-stores/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/index.ts)_
|
|
1122
|
+
|
|
1123
|
+
## `apify key-value-stores create [KEYVALUESTORENAME]`
|
|
1124
|
+
|
|
1125
|
+
Creates a new key-value store on your account.
|
|
1126
|
+
|
|
1127
|
+
```
|
|
1128
|
+
USAGE
|
|
1129
|
+
$ apify key-value-stores create [KEYVALUESTORENAME] [--json]
|
|
1130
|
+
|
|
1131
|
+
ARGUMENTS
|
|
1132
|
+
KEYVALUESTORENAME Optional name for the key-value store
|
|
1133
|
+
|
|
1134
|
+
GLOBAL FLAGS
|
|
1135
|
+
--json Format output as json.
|
|
1136
|
+
|
|
1137
|
+
DESCRIPTION
|
|
1138
|
+
Creates a new key-value store on your account.
|
|
1139
|
+
```
|
|
1140
|
+
|
|
1141
|
+
_See code: [src/commands/key-value-stores/create.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/create.ts)_
|
|
1142
|
+
|
|
1143
|
+
## `apify key-value-stores delete-value STOREID ITEMKEY`
|
|
1144
|
+
|
|
1145
|
+
Delete a value from a key-value store.
|
|
1146
|
+
|
|
1147
|
+
```
|
|
1148
|
+
USAGE
|
|
1149
|
+
$ apify key-value-stores delete-value STOREID ITEMKEY
|
|
1150
|
+
|
|
1151
|
+
ARGUMENTS
|
|
1152
|
+
STOREID The key-value store ID to delete the value from.
|
|
1153
|
+
ITEMKEY The key of the item in the key-value store.
|
|
1154
|
+
|
|
1155
|
+
DESCRIPTION
|
|
1156
|
+
Delete a value from a key-value store.
|
|
1157
|
+
```
|
|
1158
|
+
|
|
1159
|
+
_See code: [src/commands/key-value-stores/delete-value.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/delete-value.ts)_
|
|
1160
|
+
|
|
1161
|
+
## `apify key-value-stores get-value KEYVALUESTOREID ITEMKEY`
|
|
1162
|
+
|
|
1163
|
+
Retrieves stored value for specified key. Use --only-content-type to check MIME type.
|
|
1164
|
+
|
|
1165
|
+
```
|
|
1166
|
+
USAGE
|
|
1167
|
+
$ apify key-value-stores get-value KEYVALUESTOREID ITEMKEY [--only-content-type]
|
|
1168
|
+
|
|
1169
|
+
ARGUMENTS
|
|
1170
|
+
KEYVALUESTOREID The key-value store ID to get the value from.
|
|
1171
|
+
ITEMKEY The key of the item in the key-value store.
|
|
1172
|
+
|
|
1173
|
+
FLAGS
|
|
1174
|
+
--only-content-type Only return the content type of the specified key
|
|
1175
|
+
|
|
1176
|
+
DESCRIPTION
|
|
1177
|
+
Retrieves stored value for specified key. Use --only-content-type to check MIME type.
|
|
1178
|
+
```
|
|
1179
|
+
|
|
1180
|
+
_See code: [src/commands/key-value-stores/get-value.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/get-value.ts)_
|
|
1181
|
+
|
|
1182
|
+
## `apify key-value-stores info STOREID`
|
|
1183
|
+
|
|
1184
|
+
Shows information about a key-value store.
|
|
1185
|
+
|
|
1186
|
+
```
|
|
1187
|
+
USAGE
|
|
1188
|
+
$ apify key-value-stores info STOREID [--json]
|
|
1189
|
+
|
|
1190
|
+
ARGUMENTS
|
|
1191
|
+
STOREID The key-value store ID to print information about.
|
|
1192
|
+
|
|
1193
|
+
GLOBAL FLAGS
|
|
1194
|
+
--json Format output as json.
|
|
1195
|
+
|
|
1196
|
+
DESCRIPTION
|
|
1197
|
+
Shows information about a key-value store.
|
|
1198
|
+
```
|
|
1199
|
+
|
|
1200
|
+
_See code: [src/commands/key-value-stores/info.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/info.ts)_
|
|
1201
|
+
|
|
1202
|
+
## `apify key-value-stores keys STOREID`
|
|
1203
|
+
|
|
1204
|
+
Lists all keys in a key-value store.
|
|
1205
|
+
|
|
1206
|
+
```
|
|
1207
|
+
USAGE
|
|
1208
|
+
$ apify key-value-stores keys STOREID [--json] [--limit <value>] [--exclusive-start-key <value>]
|
|
1209
|
+
|
|
1210
|
+
ARGUMENTS
|
|
1211
|
+
STOREID The key-value store ID to list keys for.
|
|
1212
|
+
|
|
1213
|
+
FLAGS
|
|
1214
|
+
--exclusive-start-key=<value> The key to start the list from.
|
|
1215
|
+
--limit=<value> [default: 20] The maximum number of keys to return.
|
|
1216
|
+
|
|
1217
|
+
GLOBAL FLAGS
|
|
1218
|
+
--json Format output as json.
|
|
1219
|
+
|
|
1220
|
+
DESCRIPTION
|
|
1221
|
+
Lists all keys in a key-value store.
|
|
1222
|
+
```
|
|
1223
|
+
|
|
1224
|
+
_See code: [src/commands/key-value-stores/keys.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/keys.ts)_
|
|
1225
|
+
|
|
1226
|
+
## `apify key-value-stores ls`
|
|
1227
|
+
|
|
1228
|
+
Lists all key-value stores on your account.
|
|
1229
|
+
|
|
1230
|
+
```
|
|
1231
|
+
USAGE
|
|
1232
|
+
$ apify key-value-stores ls [--json] [--offset <value>] [--limit <value>] [--desc] [--unnamed]
|
|
1233
|
+
|
|
1234
|
+
FLAGS
|
|
1235
|
+
--desc Sorts key-value stores in descending order.
|
|
1236
|
+
--limit=<value> [default: 20] Number of key-value stores that will be listed.
|
|
1237
|
+
--offset=<value> Number of key-value stores that will be skipped.
|
|
1238
|
+
--unnamed Lists key-value stores that don't have a name set.
|
|
1239
|
+
|
|
1240
|
+
GLOBAL FLAGS
|
|
1241
|
+
--json Format output as json.
|
|
1242
|
+
|
|
1243
|
+
DESCRIPTION
|
|
1244
|
+
Lists all key-value stores on your account.
|
|
1245
|
+
```
|
|
1246
|
+
|
|
1247
|
+
_See code: [src/commands/key-value-stores/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/ls.ts)_
|
|
1248
|
+
|
|
1249
|
+
## `apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME]`
|
|
1250
|
+
|
|
1251
|
+
Renames a key-value store, or removes its unique name.
|
|
1252
|
+
|
|
1253
|
+
```
|
|
1254
|
+
USAGE
|
|
1255
|
+
$ apify key-value-stores rename KEYVALUESTORENAMEORID [NEWNAME] [--unname]
|
|
1256
|
+
|
|
1257
|
+
ARGUMENTS
|
|
1258
|
+
KEYVALUESTORENAMEORID The key-value store ID or name to delete
|
|
1259
|
+
NEWNAME The new name for the key-value store
|
|
1260
|
+
|
|
1261
|
+
FLAGS
|
|
1262
|
+
--unname Removes the unique name of the key-value store
|
|
1263
|
+
|
|
1264
|
+
DESCRIPTION
|
|
1265
|
+
Renames a key-value store, or removes its unique name.
|
|
1266
|
+
```
|
|
1267
|
+
|
|
1268
|
+
_See code: [src/commands/key-value-stores/rename.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/rename.ts)_
|
|
1269
|
+
|
|
1270
|
+
## `apify key-value-stores rm KEYVALUESTORENAMEORID`
|
|
1271
|
+
|
|
1272
|
+
Permanently removes a key-value store.
|
|
1273
|
+
|
|
1274
|
+
```
|
|
1275
|
+
USAGE
|
|
1276
|
+
$ apify key-value-stores rm KEYVALUESTORENAMEORID
|
|
1277
|
+
|
|
1278
|
+
ARGUMENTS
|
|
1279
|
+
KEYVALUESTORENAMEORID The key-value store ID or name to delete
|
|
1280
|
+
|
|
1281
|
+
DESCRIPTION
|
|
1282
|
+
Permanently removes a key-value store.
|
|
1283
|
+
```
|
|
1284
|
+
|
|
1285
|
+
_See code: [src/commands/key-value-stores/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/rm.ts)_
|
|
1286
|
+
|
|
1287
|
+
## `apify key-value-stores set-value STOREID ITEMKEY [VALUE]`
|
|
1288
|
+
|
|
1289
|
+
Stores value with specified key. Set content-type with --content-type flag.
|
|
1290
|
+
|
|
1291
|
+
```
|
|
1292
|
+
USAGE
|
|
1293
|
+
$ apify key-value-stores set-value STOREID ITEMKEY [VALUE] [--content-type <value>]
|
|
1294
|
+
|
|
1295
|
+
ARGUMENTS
|
|
1296
|
+
STOREID The key-value store ID to set the value in.
|
|
1297
|
+
ITEMKEY The key of the item in the key-value store.
|
|
1298
|
+
VALUE The value to set.
|
|
1299
|
+
|
|
1300
|
+
FLAGS
|
|
1301
|
+
--content-type=<value> [default: application/json] The MIME content type of the value. By default, "application/json"
|
|
1302
|
+
is assumed.
|
|
1303
|
+
|
|
1304
|
+
DESCRIPTION
|
|
1305
|
+
Stores value with specified key. Set content-type with --content-type flag.
|
|
1306
|
+
```
|
|
1307
|
+
|
|
1308
|
+
_See code: [src/commands/key-value-stores/set-value.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/key-value-stores/set-value.ts)_
|
|
1309
|
+
|
|
1310
|
+
## `apify login`
|
|
1311
|
+
|
|
1312
|
+
Authenticates your Apify account and saves credentials to '~/.apify'.
|
|
1313
|
+
|
|
1314
|
+
```
|
|
1315
|
+
USAGE
|
|
1316
|
+
$ apify login [-t <value>] [-m console|manual]
|
|
1317
|
+
|
|
1318
|
+
FLAGS
|
|
1319
|
+
-m, --method=<option> [Optional] Method of logging in to Apify
|
|
1320
|
+
<options: console|manual>
|
|
1321
|
+
-t, --token=<value> [Optional] Apify API token
|
|
1322
|
+
|
|
1323
|
+
DESCRIPTION
|
|
1324
|
+
Authenticates your Apify account and saves credentials to '~/.apify'.
|
|
1325
|
+
All other commands use these stored credentials.
|
|
1326
|
+
|
|
1327
|
+
Run 'apify logout' to remove authentication.
|
|
1328
|
+
```
|
|
1329
|
+
|
|
1330
|
+
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/login.ts)_
|
|
1331
|
+
|
|
1332
|
+
## `apify logout`
|
|
1333
|
+
|
|
1334
|
+
Removes authentication by deleting your API token and account information from '~/.apify'.
|
|
1335
|
+
|
|
1336
|
+
```
|
|
1337
|
+
USAGE
|
|
1338
|
+
$ apify logout
|
|
1339
|
+
|
|
1340
|
+
DESCRIPTION
|
|
1341
|
+
Removes authentication by deleting your API token and account information from '~/.apify'.
|
|
1342
|
+
Run 'apify login' to authenticate again.
|
|
1343
|
+
```
|
|
1344
|
+
|
|
1345
|
+
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/logout.ts)_
|
|
1346
|
+
|
|
1347
|
+
## `apify pull [ACTORID]`
|
|
1348
|
+
|
|
1349
|
+
Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
|
|
1350
|
+
|
|
1351
|
+
```
|
|
1352
|
+
USAGE
|
|
1353
|
+
$ apify pull [ACTORID] [-v <value>] [--dir <value>]
|
|
1354
|
+
|
|
1355
|
+
ARGUMENTS
|
|
1356
|
+
ACTORID Name or ID of the Actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
1357
|
+
command will update the Actor in the current directory based on its name in ".actor/actor.json" file.
|
|
1358
|
+
|
|
1359
|
+
FLAGS
|
|
1360
|
+
-v, --version=<value> Actor version number which will be pulled, e.g. 1.2. Default: the highest version
|
|
1361
|
+
--dir=<value> Directory where the Actor should be pulled to
|
|
1362
|
+
|
|
1363
|
+
DESCRIPTION
|
|
1364
|
+
Download Actor code to current directory. Clones Git repositories or fetches Actor files based on the source type.
|
|
1365
|
+
```
|
|
1366
|
+
|
|
1367
|
+
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/pull.ts)_
|
|
1368
|
+
|
|
1369
|
+
## `apify push [ACTORID]`
|
|
1370
|
+
|
|
1371
|
+
Deploys Actor to Apify platform using settings from '.actor/actor.json'.
|
|
1372
|
+
|
|
1373
|
+
```
|
|
1374
|
+
USAGE
|
|
1375
|
+
$ apify push [ACTORID] [-v <value>] [-b <value>] [-w <value>] [--no-prompt] [--force] [--dir <value>]
|
|
1376
|
+
|
|
1377
|
+
ARGUMENTS
|
|
1378
|
+
ACTORID Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
|
|
1379
|
+
command will create or modify the Actor with the name specified in '.actor/actor.json' file.
|
|
1380
|
+
|
|
1381
|
+
FLAGS
|
|
1382
|
+
-b, --build-tag=<value> Build tag to be applied to the successful Actor build. By default, it is taken from the
|
|
1383
|
+
'.actor/actor.json' file
|
|
1384
|
+
-v, --version=<value> Actor version number to which the files should be pushed. By default, it is taken from
|
|
1385
|
+
the '.actor/actor.json' file.
|
|
1386
|
+
-w, --wait-for-finish=<value> Seconds for waiting to build to finish, if no value passed, it waits forever.
|
|
1387
|
+
--dir=<value> Directory where the Actor is located
|
|
1388
|
+
--force Push an Actor even when the local files are older than the Actor on the platform.
|
|
1389
|
+
--no-prompt Do not prompt for opening the Actor details in a browser. This will also not open the
|
|
1390
|
+
browser automatically.
|
|
1391
|
+
|
|
1392
|
+
DESCRIPTION
|
|
1393
|
+
Deploys Actor to Apify platform using settings from '.actor/actor.json'.
|
|
1394
|
+
Files under '3' MB upload as "Multiple source files"; larger projects upload as ZIP file.
|
|
1395
|
+
Use --force to override newer remote versions.
|
|
1396
|
+
```
|
|
1397
|
+
|
|
1398
|
+
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/push.ts)_
|
|
1399
|
+
|
|
1400
|
+
## `apify request-queues`
|
|
1401
|
+
|
|
1402
|
+
Manages URL queues for web scraping and automation tasks.
|
|
1403
|
+
|
|
1404
|
+
```
|
|
1405
|
+
USAGE
|
|
1406
|
+
$ apify request-queues
|
|
1407
|
+
|
|
1408
|
+
DESCRIPTION
|
|
1409
|
+
Manages URL queues for web scraping and automation tasks.
|
|
1410
|
+
```
|
|
1411
|
+
|
|
1412
|
+
_See code: [src/commands/request-queues/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/request-queues/index.ts)_
|
|
1413
|
+
|
|
1414
|
+
## `apify run`
|
|
1415
|
+
|
|
1416
|
+
Executes Actor locally with simulated Apify environment variables.
|
|
1417
|
+
|
|
1418
|
+
```
|
|
1419
|
+
USAGE
|
|
1420
|
+
$ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store] [--entrypoint <value>] [-i
|
|
1421
|
+
<value> | --input-file <value>]
|
|
1422
|
+
|
|
1423
|
+
FLAGS
|
|
1424
|
+
-i, --input=<value> Optional JSON input to be given to the Actor.
|
|
1425
|
+
-p, --purge Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store
|
|
1426
|
+
options.
|
|
1427
|
+
--entrypoint=<value> Optional entrypoint for running with injected environment variables.
|
|
1428
|
+
For Python, it is the module name, or a path to a file.
|
|
1429
|
+
For node.js, it is the npm script name, or a path to a JS/MJS file. You can also pass in
|
|
1430
|
+
a directory name, provided that directory contains an "index.js" file.
|
|
1431
|
+
--input-file=<value> Optional path to a file with JSON input to be given to the Actor. The file must be a
|
|
1432
|
+
valid JSON file. You can also specify `-` to read from standard input.
|
|
1433
|
+
--purge-dataset Deletes the local directory containing the default dataset before the run starts.
|
|
1434
|
+
--purge-key-value-store Deletes all records from the default key-value store in the local directory before the
|
|
1435
|
+
run starts, except for the "INPUT" key.
|
|
1436
|
+
--purge-queue Deletes the local directory containing the default request queue before the run starts.
|
|
1437
|
+
|
|
1438
|
+
DESCRIPTION
|
|
1439
|
+
Executes Actor locally with simulated Apify environment variables.
|
|
1440
|
+
Stores data in local 'storage' directory.
|
|
1441
|
+
|
|
1442
|
+
NOTE: For Node.js Actors, customize behavior by modifying the 'start' script in package.json file.
|
|
1443
|
+
```
|
|
1444
|
+
|
|
1445
|
+
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/run.ts)_
|
|
1446
|
+
|
|
1447
|
+
## `apify runs`
|
|
1448
|
+
|
|
1449
|
+
Manages Actor run operations
|
|
1450
|
+
|
|
1451
|
+
```
|
|
1452
|
+
USAGE
|
|
1453
|
+
$ apify runs
|
|
1454
|
+
|
|
1455
|
+
DESCRIPTION
|
|
1456
|
+
Manages Actor run operations
|
|
1457
|
+
```
|
|
1458
|
+
|
|
1459
|
+
_See code: [src/commands/runs/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/runs/index.ts)_
|
|
1460
|
+
|
|
1461
|
+
## `apify runs abort RUNID`
|
|
1462
|
+
|
|
1463
|
+
Aborts an Actor run.
|
|
1464
|
+
|
|
1465
|
+
```
|
|
1466
|
+
USAGE
|
|
1467
|
+
$ apify runs abort RUNID [--json] [-f]
|
|
1468
|
+
|
|
1469
|
+
ARGUMENTS
|
|
1470
|
+
RUNID The run ID to abort.
|
|
1471
|
+
|
|
1472
|
+
FLAGS
|
|
1473
|
+
-f, --force Whether to force the run to abort immediately, instead of gracefully.
|
|
1474
|
+
|
|
1475
|
+
GLOBAL FLAGS
|
|
1476
|
+
--json Format output as json.
|
|
1477
|
+
|
|
1478
|
+
DESCRIPTION
|
|
1479
|
+
Aborts an Actor run.
|
|
1480
|
+
```
|
|
1481
|
+
|
|
1482
|
+
_See code: [src/commands/runs/abort.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/runs/abort.ts)_
|
|
1483
|
+
|
|
1484
|
+
## `apify runs info RUNID`
|
|
1485
|
+
|
|
1486
|
+
Prints information about an Actor run.
|
|
1487
|
+
|
|
1488
|
+
```
|
|
1489
|
+
USAGE
|
|
1490
|
+
$ apify runs info RUNID [--json] [-v]
|
|
1491
|
+
|
|
1492
|
+
ARGUMENTS
|
|
1493
|
+
RUNID The run ID to print information about.
|
|
1494
|
+
|
|
1495
|
+
FLAGS
|
|
1496
|
+
-v, --verbose Prints more in-depth information about the Actor run.
|
|
1497
|
+
|
|
1498
|
+
GLOBAL FLAGS
|
|
1499
|
+
--json Format output as json.
|
|
1500
|
+
|
|
1501
|
+
DESCRIPTION
|
|
1502
|
+
Prints information about an Actor run.
|
|
1503
|
+
```
|
|
1504
|
+
|
|
1505
|
+
_See code: [src/commands/runs/info.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/runs/info.ts)_
|
|
1506
|
+
|
|
1507
|
+
## `apify runs log RUNID`
|
|
1508
|
+
|
|
1509
|
+
Prints the log of a specific run.
|
|
1510
|
+
|
|
1511
|
+
```
|
|
1512
|
+
USAGE
|
|
1513
|
+
$ apify runs log RUNID
|
|
1514
|
+
|
|
1515
|
+
ARGUMENTS
|
|
1516
|
+
RUNID The run ID to get the log from.
|
|
1517
|
+
|
|
1518
|
+
DESCRIPTION
|
|
1519
|
+
Prints the log of a specific run.
|
|
1520
|
+
```
|
|
1521
|
+
|
|
1522
|
+
_See code: [src/commands/runs/log.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/runs/log.ts)_
|
|
1523
|
+
|
|
1524
|
+
## `apify runs ls [ACTORID]`
|
|
1525
|
+
|
|
1526
|
+
Lists all runs of the Actor.
|
|
1527
|
+
|
|
1528
|
+
```
|
|
1529
|
+
USAGE
|
|
1530
|
+
$ apify runs ls [ACTORID] [--json] [--offset <value>] [--limit <value>] [--desc] [-c]
|
|
1531
|
+
|
|
1532
|
+
ARGUMENTS
|
|
1533
|
+
ACTORID Optional Actor ID or Name to list runs for. By default, it will use the Actor from the current directory.
|
|
1534
|
+
|
|
1535
|
+
FLAGS
|
|
1536
|
+
-c, --compact Display a compact table.
|
|
1537
|
+
--desc Sort runs in descending order.
|
|
1538
|
+
--limit=<value> [default: 10] Number of runs that will be listed.
|
|
1539
|
+
--offset=<value> Number of runs that will be skipped.
|
|
1540
|
+
|
|
1541
|
+
GLOBAL FLAGS
|
|
1542
|
+
--json Format output as json.
|
|
1543
|
+
|
|
1544
|
+
DESCRIPTION
|
|
1545
|
+
Lists all runs of the Actor.
|
|
1546
|
+
```
|
|
1547
|
+
|
|
1548
|
+
_See code: [src/commands/runs/ls.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/runs/ls.ts)_
|
|
1549
|
+
|
|
1550
|
+
## `apify runs resurrect RUNID`
|
|
1551
|
+
|
|
1552
|
+
Resurrects an aborted or finished Actor Run.
|
|
1553
|
+
|
|
1554
|
+
```
|
|
1555
|
+
USAGE
|
|
1556
|
+
$ apify runs resurrect RUNID [--json]
|
|
1557
|
+
|
|
1558
|
+
ARGUMENTS
|
|
1559
|
+
RUNID The run ID to resurrect.
|
|
1560
|
+
|
|
1561
|
+
GLOBAL FLAGS
|
|
1562
|
+
--json Format output as json.
|
|
1563
|
+
|
|
1564
|
+
DESCRIPTION
|
|
1565
|
+
Resurrects an aborted or finished Actor Run.
|
|
1566
|
+
```
|
|
1567
|
+
|
|
1568
|
+
_See code: [src/commands/runs/resurrect.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/runs/resurrect.ts)_
|
|
1569
|
+
|
|
1570
|
+
## `apify runs rm RUNID`
|
|
1571
|
+
|
|
1572
|
+
Deletes an Actor Run.
|
|
1573
|
+
|
|
1574
|
+
```
|
|
1575
|
+
USAGE
|
|
1576
|
+
$ apify runs rm RUNID
|
|
1577
|
+
|
|
1578
|
+
ARGUMENTS
|
|
1579
|
+
RUNID The run ID to delete.
|
|
1580
|
+
|
|
1581
|
+
DESCRIPTION
|
|
1582
|
+
Deletes an Actor Run.
|
|
1583
|
+
```
|
|
1584
|
+
|
|
1585
|
+
_See code: [src/commands/runs/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/runs/rm.ts)_
|
|
1586
|
+
|
|
1587
|
+
## `apify secrets`
|
|
1588
|
+
|
|
1589
|
+
Manages secure environment variables for Actors.
|
|
1590
|
+
|
|
1591
|
+
```
|
|
1592
|
+
USAGE
|
|
1593
|
+
$ apify secrets
|
|
1594
|
+
|
|
1595
|
+
DESCRIPTION
|
|
1596
|
+
Manages secure environment variables for Actors.
|
|
1597
|
+
|
|
1598
|
+
Example:
|
|
1599
|
+
$ apify secrets add mySecret TopSecretValue123
|
|
1600
|
+
|
|
1601
|
+
The "mySecret" value can be used in an environment variable defined in '.actor/actor.json' file by adding the "@"
|
|
1602
|
+
prefix:
|
|
1603
|
+
|
|
1604
|
+
{
|
|
1605
|
+
"actorSpecification": 1,
|
|
1606
|
+
"name": "my_actor",
|
|
1607
|
+
"environmentVariables": { "SECRET_ENV_VAR": "@mySecret" },
|
|
1608
|
+
"version": "0.1"
|
|
1609
|
+
}
|
|
1610
|
+
|
|
1611
|
+
When the Actor is pushed to Apify cloud, the "SECRET_ENV_VAR" and its value is stored as a secret environment variable
|
|
1612
|
+
of the Actor.
|
|
1613
|
+
```
|
|
1614
|
+
|
|
1615
|
+
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/secrets/index.ts)_
|
|
1616
|
+
|
|
1617
|
+
## `apify secrets add NAME VALUE`
|
|
1618
|
+
|
|
1619
|
+
Adds a new secret to '~/.apify' for use in Actor environment variables.
|
|
1620
|
+
|
|
1621
|
+
```
|
|
1622
|
+
USAGE
|
|
1623
|
+
$ apify secrets add NAME VALUE
|
|
1624
|
+
|
|
1625
|
+
ARGUMENTS
|
|
1626
|
+
NAME Name of the secret
|
|
1627
|
+
VALUE Value of the secret
|
|
1628
|
+
|
|
1629
|
+
DESCRIPTION
|
|
1630
|
+
Adds a new secret to '~/.apify' for use in Actor environment variables.
|
|
1631
|
+
```
|
|
1632
|
+
|
|
1633
|
+
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/secrets/add.ts)_
|
|
1634
|
+
|
|
1635
|
+
## `apify secrets rm NAME`
|
|
1636
|
+
|
|
1637
|
+
Permanently deletes a secret from your stored credentials.
|
|
1638
|
+
|
|
1639
|
+
```
|
|
1640
|
+
USAGE
|
|
1641
|
+
$ apify secrets rm NAME
|
|
1642
|
+
|
|
1643
|
+
ARGUMENTS
|
|
1644
|
+
NAME Name of the secret
|
|
1645
|
+
|
|
1646
|
+
DESCRIPTION
|
|
1647
|
+
Permanently deletes a secret from your stored credentials.
|
|
1648
|
+
```
|
|
1649
|
+
|
|
1650
|
+
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/secrets/rm.ts)_
|
|
1651
|
+
|
|
1652
|
+
## `apify task`
|
|
1653
|
+
|
|
1654
|
+
Manages scheduled and predefined Actor configurations.
|
|
1655
|
+
|
|
1656
|
+
```
|
|
1657
|
+
USAGE
|
|
1658
|
+
$ apify task
|
|
1659
|
+
|
|
1660
|
+
DESCRIPTION
|
|
1661
|
+
Manages scheduled and predefined Actor configurations.
|
|
1662
|
+
```
|
|
1663
|
+
|
|
1664
|
+
_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/task/index.ts)_
|
|
1665
|
+
|
|
1666
|
+
## `apify task run TASKID`
|
|
1667
|
+
|
|
1668
|
+
Executes predefined Actor task remotely using local key-value store for input.
|
|
1669
|
+
|
|
1670
|
+
```
|
|
1671
|
+
USAGE
|
|
1672
|
+
$ apify task run TASKID [-b <value>] [-t <value>] [-m <value>]
|
|
1673
|
+
|
|
1674
|
+
ARGUMENTS
|
|
1675
|
+
TASKID Name or ID of the Task to run (e.g. "my-task" or "E2jjCZBezvAZnX8Rb").
|
|
1676
|
+
|
|
1677
|
+
FLAGS
|
|
1678
|
+
-b, --build=<value> Tag or number of the build to run (e.g. "latest" or "1.2.34").
|
|
1679
|
+
-m, --memory=<value> Amount of memory allocated for the Task run, in megabytes.
|
|
1680
|
+
-t, --timeout=<value> Timeout for the Task run in seconds. Zero value means there is no timeout.
|
|
1681
|
+
|
|
1682
|
+
DESCRIPTION
|
|
1683
|
+
Executes predefined Actor task remotely using local key-value store for input.
|
|
1684
|
+
Customize with --memory and --timeout flags.
|
|
1685
|
+
```
|
|
1686
|
+
|
|
1687
|
+
_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/task/run.ts)_
|
|
1688
|
+
|
|
1689
|
+
## `apify validate-schema [PATH]`
|
|
1690
|
+
|
|
1691
|
+
Validates Actor input schema from one of these locations (in priority order):
|
|
1692
|
+
|
|
1693
|
+
```
|
|
1694
|
+
USAGE
|
|
1695
|
+
$ apify validate-schema [PATH]
|
|
1696
|
+
|
|
1697
|
+
ARGUMENTS
|
|
1698
|
+
PATH Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
|
|
1699
|
+
|
|
1700
|
+
DESCRIPTION
|
|
1701
|
+
Validates Actor input schema from one of these locations (in priority order):
|
|
1702
|
+
1. Object in '.actor/actor.json' under "input" key
|
|
1703
|
+
2. JSON file path in '.actor/actor.json' "input" key
|
|
1704
|
+
3. .actor/INPUT_SCHEMA.json
|
|
1705
|
+
4. INPUT_SCHEMA.json
|
|
1706
|
+
|
|
1707
|
+
Optionally specify custom schema path to validate.
|
|
1708
|
+
```
|
|
1709
|
+
|
|
1710
|
+
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.21.9/src/commands/validate-schema.ts)_
|
|
1711
|
+
<!-- commandsstop -->
|
|
1712
|
+
<!-- prettier-ignore-end -->
|