apify-cli 1.0.0-beta.99 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (221) hide show
  1. package/CHANGELOG.md +236 -84
  2. package/LICENSE.md +201 -0
  3. package/README.md +50 -535
  4. package/dist/.tsbuildinfo +1 -1
  5. package/dist/actor.js +3 -0
  6. package/dist/actor.js.map +1 -0
  7. package/dist/apify.js +3 -0
  8. package/dist/apify.js.map +1 -0
  9. package/dist/chunk-TJMCNXPV.js +242 -0
  10. package/dist/chunk-TJMCNXPV.js.map +1 -0
  11. package/dist/index.js +2 -3
  12. package/package.json +116 -89
  13. package/bin/dev.cmd +0 -3
  14. package/bin/dev.js +0 -21
  15. package/bin/dev.sh +0 -4
  16. package/bin/run.cmd +0 -3
  17. package/bin/run.js +0 -23
  18. package/dist/commands/actor/get-input.d.ts +0 -6
  19. package/dist/commands/actor/get-input.d.ts.map +0 -1
  20. package/dist/commands/actor/get-input.js +0 -14
  21. package/dist/commands/actor/get-input.js.map +0 -1
  22. package/dist/commands/actor/get-value.d.ts +0 -9
  23. package/dist/commands/actor/get-value.d.ts.map +0 -1
  24. package/dist/commands/actor/get-value.js +0 -27
  25. package/dist/commands/actor/get-value.js.map +0 -1
  26. package/dist/commands/actor/index.d.ts +0 -6
  27. package/dist/commands/actor/index.d.ts.map +0 -1
  28. package/dist/commands/actor/index.js +0 -13
  29. package/dist/commands/actor/index.js.map +0 -1
  30. package/dist/commands/actor/push-data.d.ts +0 -11
  31. package/dist/commands/actor/push-data.d.ts.map +0 -1
  32. package/dist/commands/actor/push-data.js +0 -56
  33. package/dist/commands/actor/push-data.js.map +0 -1
  34. package/dist/commands/actor/set-value.d.ts +0 -15
  35. package/dist/commands/actor/set-value.d.ts.map +0 -1
  36. package/dist/commands/actor/set-value.js +0 -76
  37. package/dist/commands/actor/set-value.js.map +0 -1
  38. package/dist/commands/call.d.ts +0 -16
  39. package/dist/commands/call.d.ts.map +0 -1
  40. package/dist/commands/call.js +0 -108
  41. package/dist/commands/call.js.map +0 -1
  42. package/dist/commands/check-version.d.ts +0 -11
  43. package/dist/commands/check-version.d.ts.map +0 -1
  44. package/dist/commands/check-version.js +0 -39
  45. package/dist/commands/check-version.js.map +0 -1
  46. package/dist/commands/create.d.ts +0 -15
  47. package/dist/commands/create.d.ts.map +0 -1
  48. package/dist/commands/create.js +0 -201
  49. package/dist/commands/create.js.map +0 -1
  50. package/dist/commands/edit-input-schema.d.ts +0 -11
  51. package/dist/commands/edit-input-schema.d.ts.map +0 -1
  52. package/dist/commands/edit-input-schema.js +0 -176
  53. package/dist/commands/edit-input-schema.js.map +0 -1
  54. package/dist/commands/info.d.ts +0 -6
  55. package/dist/commands/info.d.ts.map +0 -1
  56. package/dist/commands/info.js +0 -26
  57. package/dist/commands/info.js.map +0 -1
  58. package/dist/commands/init-wrap-scrapy.d.ts +0 -10
  59. package/dist/commands/init-wrap-scrapy.d.ts.map +0 -1
  60. package/dist/commands/init-wrap-scrapy.js +0 -41
  61. package/dist/commands/init-wrap-scrapy.js.map +0 -1
  62. package/dist/commands/init.d.ts +0 -12
  63. package/dist/commands/init.d.ts.map +0 -1
  64. package/dist/commands/init.js +0 -88
  65. package/dist/commands/init.js.map +0 -1
  66. package/dist/commands/login.d.ts +0 -10
  67. package/dist/commands/login.d.ts.map +0 -1
  68. package/dist/commands/login.js +0 -174
  69. package/dist/commands/login.js.map +0 -1
  70. package/dist/commands/logout.d.ts +0 -6
  71. package/dist/commands/logout.d.ts.map +0 -1
  72. package/dist/commands/logout.js +0 -20
  73. package/dist/commands/logout.js.map +0 -1
  74. package/dist/commands/pull.d.ts +0 -12
  75. package/dist/commands/pull.d.ts.map +0 -1
  76. package/dist/commands/pull.js +0 -148
  77. package/dist/commands/pull.js.map +0 -1
  78. package/dist/commands/push.d.ts +0 -18
  79. package/dist/commands/push.d.ts.map +0 -1
  80. package/dist/commands/push.js +0 -298
  81. package/dist/commands/push.js.map +0 -1
  82. package/dist/commands/run.d.ts +0 -13
  83. package/dist/commands/run.d.ts.map +0 -1
  84. package/dist/commands/run.js +0 -257
  85. package/dist/commands/run.js.map +0 -1
  86. package/dist/commands/secrets/add.d.ts +0 -10
  87. package/dist/commands/secrets/add.d.ts.map +0 -1
  88. package/dist/commands/secrets/add.js +0 -31
  89. package/dist/commands/secrets/add.js.map +0 -1
  90. package/dist/commands/secrets/index.d.ts +0 -6
  91. package/dist/commands/secrets/index.d.ts.map +0 -1
  92. package/dist/commands/secrets/index.js +0 -24
  93. package/dist/commands/secrets/index.js.map +0 -1
  94. package/dist/commands/secrets/rm.d.ts +0 -9
  95. package/dist/commands/secrets/rm.d.ts.map +0 -1
  96. package/dist/commands/secrets/rm.js +0 -27
  97. package/dist/commands/secrets/rm.js.map +0 -1
  98. package/dist/commands/task/index.d.ts +0 -6
  99. package/dist/commands/task/index.d.ts.map +0 -1
  100. package/dist/commands/task/index.js +0 -13
  101. package/dist/commands/task/index.js.map +0 -1
  102. package/dist/commands/task/run.d.ts +0 -16
  103. package/dist/commands/task/run.d.ts.map +0 -1
  104. package/dist/commands/task/run.js +0 -91
  105. package/dist/commands/task/run.js.map +0 -1
  106. package/dist/commands/validate-schema.d.ts +0 -10
  107. package/dist/commands/validate-schema.d.ts.map +0 -1
  108. package/dist/commands/validate-schema.js +0 -58
  109. package/dist/commands/validate-schema.js.map +0 -1
  110. package/dist/hooks/deprecations.d.ts +0 -4
  111. package/dist/hooks/deprecations.d.ts.map +0 -1
  112. package/dist/hooks/deprecations.js +0 -18
  113. package/dist/hooks/deprecations.js.map +0 -1
  114. package/dist/hooks/init.d.ts +0 -7
  115. package/dist/hooks/init.d.ts.map +0 -1
  116. package/dist/hooks/init.js +0 -17
  117. package/dist/hooks/init.js.map +0 -1
  118. package/dist/index.d.ts +0 -2
  119. package/dist/index.d.ts.map +0 -1
  120. package/dist/index.js.map +0 -1
  121. package/dist/lib/actor.d.ts +0 -27
  122. package/dist/lib/actor.d.ts.map +0 -1
  123. package/dist/lib/actor.js +0 -67
  124. package/dist/lib/actor.js.map +0 -1
  125. package/dist/lib/apify-oclif-help.d.ts +0 -15
  126. package/dist/lib/apify-oclif-help.d.ts.map +0 -1
  127. package/dist/lib/apify-oclif-help.js +0 -19
  128. package/dist/lib/apify-oclif-help.js.map +0 -1
  129. package/dist/lib/apify_command.d.ts +0 -22
  130. package/dist/lib/apify_command.d.ts.map +0 -1
  131. package/dist/lib/apify_command.js +0 -103
  132. package/dist/lib/apify_command.js.map +0 -1
  133. package/dist/lib/commands/run-on-cloud.d.ts +0 -19
  134. package/dist/lib/commands/run-on-cloud.d.ts.map +0 -1
  135. package/dist/lib/commands/run-on-cloud.js +0 -90
  136. package/dist/lib/commands/run-on-cloud.js.map +0 -1
  137. package/dist/lib/community.d.ts +0 -2
  138. package/dist/lib/community.d.ts.map +0 -1
  139. package/dist/lib/community.js +0 -4
  140. package/dist/lib/community.js.map +0 -1
  141. package/dist/lib/consts.d.ts +0 -53
  142. package/dist/lib/consts.d.ts.map +0 -1
  143. package/dist/lib/consts.js +0 -64
  144. package/dist/lib/consts.js.map +0 -1
  145. package/dist/lib/create-utils.d.ts +0 -8
  146. package/dist/lib/create-utils.d.ts.map +0 -1
  147. package/dist/lib/create-utils.js +0 -148
  148. package/dist/lib/create-utils.js.map +0 -1
  149. package/dist/lib/exec.d.ts +0 -4
  150. package/dist/lib/exec.d.ts.map +0 -1
  151. package/dist/lib/exec.js +0 -40
  152. package/dist/lib/exec.js.map +0 -1
  153. package/dist/lib/files.d.ts +0 -14
  154. package/dist/lib/files.d.ts.map +0 -1
  155. package/dist/lib/files.js +0 -58
  156. package/dist/lib/files.js.map +0 -1
  157. package/dist/lib/input_schema.d.ts +0 -26
  158. package/dist/lib/input_schema.d.ts.map +0 -1
  159. package/dist/lib/input_schema.js +0 -93
  160. package/dist/lib/input_schema.js.map +0 -1
  161. package/dist/lib/local_state.d.ts +0 -11
  162. package/dist/lib/local_state.d.ts.map +0 -1
  163. package/dist/lib/local_state.js +0 -27
  164. package/dist/lib/local_state.js.map +0 -1
  165. package/dist/lib/outputs.d.ts +0 -19
  166. package/dist/lib/outputs.d.ts.map +0 -1
  167. package/dist/lib/outputs.js +0 -45
  168. package/dist/lib/outputs.js.map +0 -1
  169. package/dist/lib/project_analyzer.d.ts +0 -4
  170. package/dist/lib/project_analyzer.d.ts.map +0 -1
  171. package/dist/lib/project_analyzer.js +0 -30
  172. package/dist/lib/project_analyzer.js.map +0 -1
  173. package/dist/lib/projects/CrawleeAnalyzer.d.ts +0 -4
  174. package/dist/lib/projects/CrawleeAnalyzer.d.ts.map +0 -1
  175. package/dist/lib/projects/CrawleeAnalyzer.js +0 -20
  176. package/dist/lib/projects/CrawleeAnalyzer.js.map +0 -1
  177. package/dist/lib/projects/OldApifySDKAnalyzer.d.ts +0 -4
  178. package/dist/lib/projects/OldApifySDKAnalyzer.d.ts.map +0 -1
  179. package/dist/lib/projects/OldApifySDKAnalyzer.js +0 -38
  180. package/dist/lib/projects/OldApifySDKAnalyzer.js.map +0 -1
  181. package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.d.ts +0 -17
  182. package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.d.ts.map +0 -1
  183. package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.js +0 -87
  184. package/dist/lib/projects/scrapy/ScrapyProjectAnalyzer.js.map +0 -1
  185. package/dist/lib/projects/scrapy/Spider.d.ts +0 -14
  186. package/dist/lib/projects/scrapy/Spider.d.ts.map +0 -1
  187. package/dist/lib/projects/scrapy/Spider.js +0 -33
  188. package/dist/lib/projects/scrapy/Spider.js.map +0 -1
  189. package/dist/lib/projects/scrapy/SpiderFileAnalyzer.d.ts +0 -7
  190. package/dist/lib/projects/scrapy/SpiderFileAnalyzer.d.ts.map +0 -1
  191. package/dist/lib/projects/scrapy/SpiderFileAnalyzer.js +0 -25
  192. package/dist/lib/projects/scrapy/SpiderFileAnalyzer.js.map +0 -1
  193. package/dist/lib/projects/scrapy/wrapScrapyProject.d.ts +0 -4
  194. package/dist/lib/projects/scrapy/wrapScrapyProject.d.ts.map +0 -1
  195. package/dist/lib/projects/scrapy/wrapScrapyProject.js +0 -109
  196. package/dist/lib/projects/scrapy/wrapScrapyProject.js.map +0 -1
  197. package/dist/lib/projects/shared.d.ts +0 -2
  198. package/dist/lib/projects/shared.d.ts.map +0 -1
  199. package/dist/lib/projects/shared.js +0 -13
  200. package/dist/lib/projects/shared.js.map +0 -1
  201. package/dist/lib/secrets.d.ts +0 -22
  202. package/dist/lib/secrets.d.ts.map +0 -1
  203. package/dist/lib/secrets.js +0 -104
  204. package/dist/lib/secrets.js.map +0 -1
  205. package/dist/lib/telemetry.d.ts +0 -21
  206. package/dist/lib/telemetry.d.ts.map +0 -1
  207. package/dist/lib/telemetry.js +0 -87
  208. package/dist/lib/telemetry.js.map +0 -1
  209. package/dist/lib/types.d.ts +0 -11
  210. package/dist/lib/types.d.ts.map +0 -1
  211. package/dist/lib/types.js +0 -2
  212. package/dist/lib/types.js.map +0 -1
  213. package/dist/lib/utils.d.ts +0 -105
  214. package/dist/lib/utils.d.ts.map +0 -1
  215. package/dist/lib/utils.js +0 -575
  216. package/dist/lib/utils.js.map +0 -1
  217. package/dist/lib/version_check.d.ts +0 -14
  218. package/dist/lib/version_check.d.ts.map +0 -1
  219. package/dist/lib/version_check.js +0 -90
  220. package/dist/lib/version_check.js.map +0 -1
  221. package/oclif.manifest.json +0 -815
@@ -1,815 +0,0 @@
1
- {
2
- "commands": {
3
- "call": {
4
- "aliases": [],
5
- "args": {
6
- "actorId": {
7
- "description": "Name or ID of the Actor to run (e.g. \"my-actor\", \"apify/hello-world\" or \"E2jjCZBezvAZnX8Rb\"). If not provided, the command runs the remote Actor specified in the \".actor/actor.json\" file.",
8
- "name": "actorId",
9
- "required": false
10
- }
11
- },
12
- "description": "Runs a specific Actor remotely on the Apify cloud platform.\nThe Actor is run under your current Apify account. Therefore you need to be logged in by calling \"apify login\". It takes input for the Actor from the default local key-value store by default.",
13
- "flags": {
14
- "build": {
15
- "char": "b",
16
- "description": "Tag or number of the build to run (e.g. \"latest\" or \"1.2.34\").",
17
- "name": "build",
18
- "required": false,
19
- "hasDynamicHelp": false,
20
- "multiple": false,
21
- "type": "option"
22
- },
23
- "timeout": {
24
- "char": "t",
25
- "description": "Timeout for the Actor run in seconds. Zero value means there is no timeout.",
26
- "name": "timeout",
27
- "required": false,
28
- "hasDynamicHelp": false,
29
- "multiple": false,
30
- "type": "option"
31
- },
32
- "memory": {
33
- "char": "m",
34
- "description": "Amount of memory allocated for the Actor run, in megabytes.",
35
- "name": "memory",
36
- "required": false,
37
- "hasDynamicHelp": false,
38
- "multiple": false,
39
- "type": "option"
40
- },
41
- "wait-for-finish": {
42
- "char": "w",
43
- "description": "Seconds for waiting to run to finish, if no value passed, it waits forever.",
44
- "name": "wait-for-finish",
45
- "required": false,
46
- "hasDynamicHelp": false,
47
- "multiple": false,
48
- "type": "option"
49
- }
50
- },
51
- "hasDynamicHelp": false,
52
- "hiddenAliases": [],
53
- "id": "call",
54
- "pluginAlias": "apify-cli",
55
- "pluginName": "apify-cli",
56
- "pluginType": "core",
57
- "strict": true,
58
- "isESM": true,
59
- "relativePath": [
60
- "dist",
61
- "commands",
62
- "call.js"
63
- ]
64
- },
65
- "check-version": {
66
- "aliases": [],
67
- "args": {},
68
- "description": "Checks that installed Apify CLI version is up to date.",
69
- "flags": {
70
- "enforce-update": {
71
- "char": "e",
72
- "description": "[Optional] Enforce version update from NPM",
73
- "name": "enforce-update",
74
- "required": false,
75
- "allowNo": false,
76
- "type": "boolean"
77
- }
78
- },
79
- "hasDynamicHelp": false,
80
- "hidden": true,
81
- "hiddenAliases": [
82
- "cv"
83
- ],
84
- "id": "check-version",
85
- "pluginAlias": "apify-cli",
86
- "pluginName": "apify-cli",
87
- "pluginType": "core",
88
- "strict": true,
89
- "isESM": true,
90
- "relativePath": [
91
- "dist",
92
- "commands",
93
- "check-version.js"
94
- ]
95
- },
96
- "create": {
97
- "aliases": [],
98
- "args": {
99
- "actorName": {
100
- "description": "Name of the Actor and its directory",
101
- "name": "actorName",
102
- "required": false
103
- }
104
- },
105
- "description": "Creates a new Actor project directory from a selected boilerplate template.",
106
- "flags": {
107
- "template": {
108
- "char": "t",
109
- "description": "Template for the Actor. If not provided, the command will prompt for it.\nVisit https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to find available template names.",
110
- "name": "template",
111
- "required": false,
112
- "hasDynamicHelp": false,
113
- "multiple": false,
114
- "type": "option"
115
- },
116
- "skip-dependency-install": {
117
- "description": "Skip installing Actor dependencies.",
118
- "name": "skip-dependency-install",
119
- "required": false,
120
- "allowNo": false,
121
- "type": "boolean"
122
- },
123
- "template-archive-url": {
124
- "description": "Actor template archive url. Useful for developing new templates.",
125
- "hidden": true,
126
- "name": "template-archive-url",
127
- "required": false,
128
- "hasDynamicHelp": false,
129
- "multiple": false,
130
- "type": "option"
131
- },
132
- "omit-optional-deps": {
133
- "aliases": [
134
- "no-optional"
135
- ],
136
- "description": "Skip installing optional dependencies.",
137
- "name": "omit-optional-deps",
138
- "required": false,
139
- "allowNo": false,
140
- "type": "boolean"
141
- }
142
- },
143
- "hasDynamicHelp": false,
144
- "hiddenAliases": [],
145
- "id": "create",
146
- "pluginAlias": "apify-cli",
147
- "pluginName": "apify-cli",
148
- "pluginType": "core",
149
- "strict": true,
150
- "isESM": true,
151
- "relativePath": [
152
- "dist",
153
- "commands",
154
- "create.js"
155
- ]
156
- },
157
- "edit-input-schema": {
158
- "aliases": [],
159
- "args": {
160
- "path": {
161
- "description": "Optional path to your INPUT_SCHEMA.json file. If not provided default platform location for input schema is used.",
162
- "name": "path",
163
- "required": false
164
- }
165
- },
166
- "description": "Lets you edit your input schema that would be used on the platform in a visual input schema editor.",
167
- "flags": {},
168
- "hasDynamicHelp": false,
169
- "hidden": true,
170
- "hiddenAliases": [
171
- "eis"
172
- ],
173
- "id": "edit-input-schema",
174
- "pluginAlias": "apify-cli",
175
- "pluginName": "apify-cli",
176
- "pluginType": "core",
177
- "strict": true,
178
- "isESM": true,
179
- "relativePath": [
180
- "dist",
181
- "commands",
182
- "edit-input-schema.js"
183
- ]
184
- },
185
- "info": {
186
- "aliases": [],
187
- "args": {},
188
- "description": "Displays information about the currently active Apify account.\nThe information is printed to the console.",
189
- "flags": {},
190
- "hasDynamicHelp": false,
191
- "hiddenAliases": [],
192
- "id": "info",
193
- "pluginAlias": "apify-cli",
194
- "pluginName": "apify-cli",
195
- "pluginType": "core",
196
- "strict": true,
197
- "isESM": true,
198
- "relativePath": [
199
- "dist",
200
- "commands",
201
- "info.js"
202
- ]
203
- },
204
- "init-wrap-scrapy": {
205
- "aliases": [],
206
- "args": {
207
- "path": {
208
- "description": "Optional path to your scrapy project. If not provided, the current directory is used.",
209
- "name": "path",
210
- "required": false
211
- }
212
- },
213
- "description": "Wraps your existing Scrapy project to work like an Apify Actor.\n\nIt adds the following features:\n- Automatic retry of failed requests\n- Automatic proxy rotation\n- Automatic user agent rotation\n...\n",
214
- "flags": {},
215
- "hasDynamicHelp": false,
216
- "hidden": true,
217
- "hiddenAliases": [],
218
- "id": "init-wrap-scrapy",
219
- "pluginAlias": "apify-cli",
220
- "pluginName": "apify-cli",
221
- "pluginType": "core",
222
- "strict": true,
223
- "isESM": true,
224
- "relativePath": [
225
- "dist",
226
- "commands",
227
- "init-wrap-scrapy.js"
228
- ]
229
- },
230
- "init": {
231
- "aliases": [],
232
- "args": {
233
- "actorName": {
234
- "description": "Name of the Actor. If not provided, you will be prompted for it.",
235
- "name": "actorName",
236
- "required": false
237
- }
238
- },
239
- "description": "Initializes a new Actor project in an existing directory.\nIf the directory contains a Scrapy project in Python, the command automatically creates wrappers so that you can run your scrapers without changes.\n\nThe command creates the \".actor/actor.json\" file and the \"storage\" directory in the current directory, but does not touch any other existing files or directories.\n\nWARNING: The directory at \"storage\" will be overwritten if it already exists.",
240
- "flags": {
241
- "yes": {
242
- "char": "y",
243
- "description": "Automatic yes to prompts; assume \"yes\" as answer to all prompts. Note that in some cases, the command may still ask for confirmation.",
244
- "name": "yes",
245
- "required": false,
246
- "allowNo": false,
247
- "type": "boolean"
248
- }
249
- },
250
- "hasDynamicHelp": false,
251
- "hiddenAliases": [],
252
- "id": "init",
253
- "pluginAlias": "apify-cli",
254
- "pluginName": "apify-cli",
255
- "pluginType": "core",
256
- "strict": true,
257
- "isESM": true,
258
- "relativePath": [
259
- "dist",
260
- "commands",
261
- "init.js"
262
- ]
263
- },
264
- "login": {
265
- "aliases": [],
266
- "args": {},
267
- "description": "Logs in to your Apify account.\nThe API token and other account information is stored in the ~/.apify directory, from where it is read by all other \"apify\" commands. To log out, call \"apify logout\".",
268
- "flags": {
269
- "token": {
270
- "char": "t",
271
- "description": "[Optional] Apify API token",
272
- "name": "token",
273
- "required": false,
274
- "hasDynamicHelp": false,
275
- "multiple": false,
276
- "type": "option"
277
- },
278
- "method": {
279
- "char": "m",
280
- "description": "[Optional] Method of logging in to Apify",
281
- "name": "method",
282
- "required": false,
283
- "hasDynamicHelp": false,
284
- "multiple": false,
285
- "options": [
286
- "console",
287
- "manual"
288
- ],
289
- "type": "option"
290
- }
291
- },
292
- "hasDynamicHelp": false,
293
- "hiddenAliases": [],
294
- "id": "login",
295
- "pluginAlias": "apify-cli",
296
- "pluginName": "apify-cli",
297
- "pluginType": "core",
298
- "strict": true,
299
- "isESM": true,
300
- "relativePath": [
301
- "dist",
302
- "commands",
303
- "login.js"
304
- ]
305
- },
306
- "logout": {
307
- "aliases": [],
308
- "args": {},
309
- "description": "Logs out of your Apify account.\nThe command deletes the API token and all other account information stored in the ~/.apify directory. To log in again, call \"apify login\".",
310
- "flags": {},
311
- "hasDynamicHelp": false,
312
- "hiddenAliases": [],
313
- "id": "logout",
314
- "pluginAlias": "apify-cli",
315
- "pluginName": "apify-cli",
316
- "pluginType": "core",
317
- "strict": true,
318
- "isESM": true,
319
- "relativePath": [
320
- "dist",
321
- "commands",
322
- "logout.js"
323
- ]
324
- },
325
- "pull": {
326
- "aliases": [],
327
- "args": {
328
- "actorId": {
329
- "description": "Name or ID of the Actor to run (e.g. \"apify/hello-world\" or \"E2jjCZBezvAZnX8Rb\"). If not provided, the command will update the Actor in the current directory based on its name in \".actor/actor.json\" file.",
330
- "name": "actorId",
331
- "required": false
332
- }
333
- },
334
- "description": "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.",
335
- "flags": {
336
- "version": {
337
- "char": "v",
338
- "description": "Actor version number which will be pulled, e.g. 1.2. Default: the highest version",
339
- "name": "version",
340
- "required": false,
341
- "hasDynamicHelp": false,
342
- "multiple": false,
343
- "type": "option"
344
- }
345
- },
346
- "hasDynamicHelp": false,
347
- "hiddenAliases": [],
348
- "id": "pull",
349
- "pluginAlias": "apify-cli",
350
- "pluginName": "apify-cli",
351
- "pluginType": "core",
352
- "strict": true,
353
- "isESM": true,
354
- "relativePath": [
355
- "dist",
356
- "commands",
357
- "pull.js"
358
- ]
359
- },
360
- "push": {
361
- "aliases": [],
362
- "args": {
363
- "actorId": {
364
- "description": "Name or ID of the Actor to push (e.g. \"apify/hello-world\" or \"E2jjCZBezvAZnX8Rb\"). If not provided, the command will create or modify the Actor with the name specified in \".actor/actor.json\" file.",
365
- "name": "actorId",
366
- "required": false
367
- }
368
- },
369
- "description": "Uploads the Actor to the Apify platform and builds it there.\nThe Actor settings are read from the \".actor/actor.json\" file in the current directory, but they can be overridden using command-line options.\nNOTE: If the source files are smaller than 3 MB then they are uploaded as \n\"Multiple source files\", otherwise they are uploaded as \"Zip file\".\n\nWhen there's an attempt to push files that are older than the Actor on the platform, the command will fail. Can be overwritten with --force flag.",
370
- "flags": {
371
- "version-number": {
372
- "deprecated": true,
373
- "description": "DEPRECATED: Use flag version instead. Actor version number to which the files should be pushed. By default, it is taken from the \".actor/actor.json\" file.",
374
- "name": "version-number",
375
- "required": false,
376
- "hasDynamicHelp": false,
377
- "multiple": false,
378
- "type": "option"
379
- },
380
- "version": {
381
- "char": "v",
382
- "description": "Actor version number to which the files should be pushed. By default, it is taken from the \".actor/actor.json\" file.",
383
- "name": "version",
384
- "required": false,
385
- "hasDynamicHelp": false,
386
- "multiple": false,
387
- "type": "option"
388
- },
389
- "build-tag": {
390
- "char": "b",
391
- "description": "Build tag to be applied to the successful Actor build. By default, it is taken from the \".actor/actor.json\" file",
392
- "name": "build-tag",
393
- "required": false,
394
- "hasDynamicHelp": false,
395
- "multiple": false,
396
- "type": "option"
397
- },
398
- "wait-for-finish": {
399
- "char": "w",
400
- "description": "Seconds for waiting to build to finish, if no value passed, it waits forever.",
401
- "name": "wait-for-finish",
402
- "required": false,
403
- "hasDynamicHelp": false,
404
- "multiple": false,
405
- "type": "option"
406
- },
407
- "no-prompt": {
408
- "description": "Do not prompt for opening the Actor details in a browser. This will also not open the browser automatically.",
409
- "name": "no-prompt",
410
- "required": false,
411
- "allowNo": false,
412
- "type": "boolean"
413
- },
414
- "force": {
415
- "description": "Push an Actor even when the local files are older than the Actor on the platform.",
416
- "name": "force",
417
- "required": false,
418
- "allowNo": false,
419
- "type": "boolean"
420
- }
421
- },
422
- "hasDynamicHelp": false,
423
- "hiddenAliases": [],
424
- "id": "push",
425
- "pluginAlias": "apify-cli",
426
- "pluginName": "apify-cli",
427
- "pluginType": "core",
428
- "strict": true,
429
- "isESM": true,
430
- "relativePath": [
431
- "dist",
432
- "commands",
433
- "push.js"
434
- ]
435
- },
436
- "run": {
437
- "aliases": [],
438
- "args": {},
439
- "description": "Runs the Actor locally in the current directory.\nIt sets various APIFY_XYZ environment variables in order to provide a working execution environment for the Actor. For example, this causes the Actor input, as well as all other data in key-value stores, datasets or request queues to be stored in the \"storage\" directory, rather than on the Apify platform.\n\nNOTE: You can override the command's default behavior for Node.js Actors by overriding the \"start\" script in the package.json file. You can set up your own main file or environment variables by changing it.",
440
- "flags": {
441
- "purge": {
442
- "char": "p",
443
- "description": "Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store options.",
444
- "name": "purge",
445
- "required": false,
446
- "allowNo": false,
447
- "type": "boolean"
448
- },
449
- "purge-queue": {
450
- "description": "Deletes the local directory containing the default request queue before the run starts.",
451
- "name": "purge-queue",
452
- "required": false,
453
- "allowNo": false,
454
- "type": "boolean"
455
- },
456
- "purge-dataset": {
457
- "description": "Deletes the local directory containing the default dataset before the run starts.",
458
- "name": "purge-dataset",
459
- "required": false,
460
- "allowNo": false,
461
- "type": "boolean"
462
- },
463
- "purge-key-value-store": {
464
- "description": "Deletes all records from the default key-value store in the local directory before the run starts, except for the \"INPUT\" key.",
465
- "name": "purge-key-value-store",
466
- "required": false,
467
- "allowNo": false,
468
- "type": "boolean"
469
- },
470
- "entrypoint": {
471
- "description": "Optional entrypoint for running with injected environment variables. \n For Python, it is the module name, or a path to a file. \n For node.js, it is the npm script name, or a path to a JS/MJS file. You can also pass in a directory name, provided that directory contains an \"index.js\" file.",
472
- "name": "entrypoint",
473
- "required": false,
474
- "hasDynamicHelp": false,
475
- "multiple": false,
476
- "type": "option"
477
- }
478
- },
479
- "hasDynamicHelp": false,
480
- "hiddenAliases": [],
481
- "id": "run",
482
- "pluginAlias": "apify-cli",
483
- "pluginName": "apify-cli",
484
- "pluginType": "core",
485
- "strict": true,
486
- "isESM": true,
487
- "relativePath": [
488
- "dist",
489
- "commands",
490
- "run.js"
491
- ]
492
- },
493
- "validate-schema": {
494
- "aliases": [],
495
- "args": {
496
- "path": {
497
- "description": "Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.",
498
- "name": "path",
499
- "required": false
500
- }
501
- },
502
- "description": "Validates input schema and prints errors found.\nThe input schema for the Actor is used from these locations in order of preference.\nThe first one found is validated as it would be the one used on the Apify platform.\n1. Directly embedded object in \".actor/actor.json\" under 'input' key\n2. Path to JSON file referenced in \".actor/actor.json\" under 'input' key\n3. JSON file at .actor/INPUT_SCHEMA.json\n4. JSON file at INPUT_SCHEMA.json\n\nYou can also pass any custom path to your input schema to have it validated instead.\n",
503
- "flags": {},
504
- "hasDynamicHelp": false,
505
- "hiddenAliases": [
506
- "vis"
507
- ],
508
- "id": "validate-schema",
509
- "pluginAlias": "apify-cli",
510
- "pluginName": "apify-cli",
511
- "pluginType": "core",
512
- "strict": true,
513
- "isESM": true,
514
- "relativePath": [
515
- "dist",
516
- "commands",
517
- "validate-schema.js"
518
- ]
519
- },
520
- "actor:get-input": {
521
- "aliases": [],
522
- "args": {},
523
- "description": "Gets the Actor input value from the default key-value store associated with the Actor run.",
524
- "flags": {},
525
- "hasDynamicHelp": false,
526
- "hiddenAliases": [],
527
- "id": "actor:get-input",
528
- "pluginAlias": "apify-cli",
529
- "pluginName": "apify-cli",
530
- "pluginType": "core",
531
- "strict": true,
532
- "isESM": true,
533
- "relativePath": [
534
- "dist",
535
- "commands",
536
- "actor",
537
- "get-input.js"
538
- ]
539
- },
540
- "actor:get-value": {
541
- "aliases": [],
542
- "args": {
543
- "key": {
544
- "description": "Key of the record in key-value store",
545
- "name": "key",
546
- "required": true
547
- }
548
- },
549
- "description": "Gets a value from the default key-value store associated with the Actor run.",
550
- "flags": {},
551
- "hasDynamicHelp": false,
552
- "hiddenAliases": [],
553
- "id": "actor:get-value",
554
- "pluginAlias": "apify-cli",
555
- "pluginName": "apify-cli",
556
- "pluginType": "core",
557
- "strict": true,
558
- "isESM": true,
559
- "relativePath": [
560
- "dist",
561
- "commands",
562
- "actor",
563
- "get-value.js"
564
- ]
565
- },
566
- "actor": {
567
- "aliases": [],
568
- "args": {},
569
- "description": "Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.\n",
570
- "flags": {},
571
- "hasDynamicHelp": false,
572
- "hiddenAliases": [],
573
- "id": "actor",
574
- "pluginAlias": "apify-cli",
575
- "pluginName": "apify-cli",
576
- "pluginType": "core",
577
- "strict": true,
578
- "isESM": true,
579
- "relativePath": [
580
- "dist",
581
- "commands",
582
- "actor",
583
- "index.js"
584
- ]
585
- },
586
- "actor:push-data": {
587
- "aliases": [],
588
- "args": {
589
- "item": {
590
- "description": "JSON string with one object or array of objects containing data to be stored in the default dataset.",
591
- "name": "item",
592
- "required": false
593
- }
594
- },
595
- "description": "Stores an object or an array of objects to the default dataset of the Actor run.\nIt is possible to pass data using item argument or stdin.\nPassing data using argument:\n$ apify actor push-data {\"foo\": \"bar\"}\nPassing data using stdin with pipe:\n$ cat ./test.json | apify actor push-data\n",
596
- "flags": {},
597
- "hasDynamicHelp": false,
598
- "hiddenAliases": [],
599
- "id": "actor:push-data",
600
- "pluginAlias": "apify-cli",
601
- "pluginName": "apify-cli",
602
- "pluginType": "core",
603
- "strict": true,
604
- "isESM": true,
605
- "relativePath": [
606
- "dist",
607
- "commands",
608
- "actor",
609
- "push-data.js"
610
- ]
611
- },
612
- "actor:set-value": {
613
- "aliases": [],
614
- "args": {
615
- "key": {
616
- "description": "Key of the record in key-value store.",
617
- "name": "key",
618
- "required": true
619
- },
620
- "value": {
621
- "description": "Record data, which can be one of the following values:\n- If empty, the record in the key-value store is deleted.\n- If no `contentType` flag is specified, value is expected to be any JSON string value.\n- If options.contentType is set, value is taken as is.",
622
- "name": "value",
623
- "required": false
624
- }
625
- },
626
- "description": "Sets or removes record into the default KeyValueStore associated with the Actor run.\nIt is possible to pass data using argument or stdin.\nPassing data using argument:\n$ apify actor set-value KEY my-value\nPassing data using stdin with pipe:\n$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain\n",
627
- "flags": {
628
- "contentType": {
629
- "char": "c",
630
- "description": "Specifies a custom MIME content type of the record. By default \"application/json\" is used.",
631
- "name": "contentType",
632
- "required": false,
633
- "hasDynamicHelp": false,
634
- "multiple": false,
635
- "type": "option"
636
- }
637
- },
638
- "hasDynamicHelp": false,
639
- "hiddenAliases": [],
640
- "id": "actor:set-value",
641
- "pluginAlias": "apify-cli",
642
- "pluginName": "apify-cli",
643
- "pluginType": "core",
644
- "strict": true,
645
- "isESM": true,
646
- "relativePath": [
647
- "dist",
648
- "commands",
649
- "actor",
650
- "set-value.js"
651
- ]
652
- },
653
- "secrets:add": {
654
- "aliases": [],
655
- "args": {
656
- "name": {
657
- "description": "Name of the secret",
658
- "name": "name",
659
- "required": true
660
- },
661
- "value": {
662
- "description": "Value of the secret",
663
- "name": "value",
664
- "required": true
665
- }
666
- },
667
- "description": "Adds a new secret value.\nThe secrets are stored to a file at ~/.apify",
668
- "flags": {},
669
- "hasDynamicHelp": false,
670
- "hiddenAliases": [],
671
- "id": "secrets:add",
672
- "pluginAlias": "apify-cli",
673
- "pluginName": "apify-cli",
674
- "pluginType": "core",
675
- "strict": true,
676
- "isESM": true,
677
- "relativePath": [
678
- "dist",
679
- "commands",
680
- "secrets",
681
- "add.js"
682
- ]
683
- },
684
- "secrets": {
685
- "aliases": [],
686
- "args": {},
687
- "description": "Manages secret values for Actor environment variables.\n\nExample:\n$ apify secrets add mySecret TopSecretValue123\n\nNow the \"mySecret\" value can be used in an environment variable defined in \".actor/actor.json\" file by adding the \"@\" prefix:\n\n{\n \"actorSpecification\": 1,\n \"name\": \"my_actor\",\n \"environmentVariables\": { \"SECRET_ENV_VAR\": \"@mySecret\" },\n \"version\": \"0.1\n}\n\nWhen the Actor is pushed to Apify cloud, the \"SECRET_ENV_VAR\" and its value is stored as a secret environment variable of the Actor.",
688
- "flags": {},
689
- "hasDynamicHelp": false,
690
- "hiddenAliases": [],
691
- "id": "secrets",
692
- "pluginAlias": "apify-cli",
693
- "pluginName": "apify-cli",
694
- "pluginType": "core",
695
- "strict": true,
696
- "isESM": true,
697
- "relativePath": [
698
- "dist",
699
- "commands",
700
- "secrets",
701
- "index.js"
702
- ]
703
- },
704
- "secrets:rm": {
705
- "aliases": [],
706
- "args": {
707
- "name": {
708
- "description": "Name of the secret",
709
- "name": "name",
710
- "required": true
711
- }
712
- },
713
- "description": "Removes the secret.",
714
- "flags": {},
715
- "hasDynamicHelp": false,
716
- "hiddenAliases": [],
717
- "id": "secrets:rm",
718
- "pluginAlias": "apify-cli",
719
- "pluginName": "apify-cli",
720
- "pluginType": "core",
721
- "strict": true,
722
- "isESM": true,
723
- "relativePath": [
724
- "dist",
725
- "commands",
726
- "secrets",
727
- "rm.js"
728
- ]
729
- },
730
- "task": {
731
- "aliases": [],
732
- "args": {},
733
- "description": "Commands are designed to be used to interact with Tasks.",
734
- "flags": {},
735
- "hasDynamicHelp": false,
736
- "hiddenAliases": [],
737
- "id": "task",
738
- "pluginAlias": "apify-cli",
739
- "pluginName": "apify-cli",
740
- "pluginType": "core",
741
- "strict": true,
742
- "isESM": true,
743
- "relativePath": [
744
- "dist",
745
- "commands",
746
- "task",
747
- "index.js"
748
- ]
749
- },
750
- "task:run": {
751
- "aliases": [],
752
- "args": {
753
- "taskId": {
754
- "description": "Name or ID of the Task to run (e.g. \"my-task\" or \"E2jjCZBezvAZnX8Rb\").",
755
- "name": "taskId",
756
- "required": true
757
- }
758
- },
759
- "description": "Runs a specific Actor remotely on the Apify cloud platform.\nThe Actor is run under your current Apify account. Therefore you need to be logged in by calling \"apify login\". It takes input for the Actor from the default local key-value store by default.",
760
- "flags": {
761
- "build": {
762
- "char": "b",
763
- "description": "Tag or number of the build to run (e.g. \"latest\" or \"1.2.34\").",
764
- "name": "build",
765
- "required": false,
766
- "hasDynamicHelp": false,
767
- "multiple": false,
768
- "type": "option"
769
- },
770
- "timeout": {
771
- "char": "t",
772
- "description": "Timeout for the Task run in seconds. Zero value means there is no timeout.",
773
- "name": "timeout",
774
- "required": false,
775
- "hasDynamicHelp": false,
776
- "multiple": false,
777
- "type": "option"
778
- },
779
- "memory": {
780
- "char": "m",
781
- "description": "Amount of memory allocated for the Task run, in megabytes.",
782
- "name": "memory",
783
- "required": false,
784
- "hasDynamicHelp": false,
785
- "multiple": false,
786
- "type": "option"
787
- },
788
- "wait-for-finish": {
789
- "char": "w",
790
- "description": "Seconds for waiting to run to finish, if no value passed, it waits forever.",
791
- "name": "wait-for-finish",
792
- "required": false,
793
- "hasDynamicHelp": false,
794
- "multiple": false,
795
- "type": "option"
796
- }
797
- },
798
- "hasDynamicHelp": false,
799
- "hiddenAliases": [],
800
- "id": "task:run",
801
- "pluginAlias": "apify-cli",
802
- "pluginName": "apify-cli",
803
- "pluginType": "core",
804
- "strict": true,
805
- "isESM": true,
806
- "relativePath": [
807
- "dist",
808
- "commands",
809
- "task",
810
- "run.js"
811
- ]
812
- }
813
- },
814
- "version": "1.0.0-beta.99"
815
- }