@heroku/plugin-compute 0.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 (116) hide show
  1. package/LICENSE.txt +207 -0
  2. package/README.md +93 -0
  3. package/lib/commands/compute/config/get.d.ts +19 -0
  4. package/lib/commands/compute/config/get.js +76 -0
  5. package/lib/commands/compute/config/get.js.map +1 -0
  6. package/lib/commands/compute/config/list.d.ts +16 -0
  7. package/lib/commands/compute/config/list.js +57 -0
  8. package/lib/commands/compute/config/list.js.map +1 -0
  9. package/lib/commands/compute/config/set.d.ts +20 -0
  10. package/lib/commands/compute/config/set.js +99 -0
  11. package/lib/commands/compute/config/set.js.map +1 -0
  12. package/lib/commands/compute/config/unset.d.ts +20 -0
  13. package/lib/commands/compute/config/unset.js +93 -0
  14. package/lib/commands/compute/config/unset.js.map +1 -0
  15. package/lib/commands/compute/deploy.d.ts +18 -0
  16. package/lib/commands/compute/deploy.js +95 -0
  17. package/lib/commands/compute/deploy.js.map +1 -0
  18. package/lib/commands/compute/display.d.ts +26 -0
  19. package/lib/commands/compute/display.js +188 -0
  20. package/lib/commands/compute/display.js.map +1 -0
  21. package/lib/commands/compute/generate.d.ts +21 -0
  22. package/lib/commands/compute/generate.js +174 -0
  23. package/lib/commands/compute/generate.js.map +1 -0
  24. package/lib/commands/compute/get/build-log.d.ts +17 -0
  25. package/lib/commands/compute/get/build-log.js +62 -0
  26. package/lib/commands/compute/get/build-log.js.map +1 -0
  27. package/lib/commands/compute/get/runtime-log.d.ts +17 -0
  28. package/lib/commands/compute/get/runtime-log.js +79 -0
  29. package/lib/commands/compute/get/runtime-log.js.map +1 -0
  30. package/lib/commands/compute/list.d.ts +13 -0
  31. package/lib/commands/compute/list.js +55 -0
  32. package/lib/commands/compute/list.js.map +1 -0
  33. package/lib/commands/compute/scale.d.ts +23 -0
  34. package/lib/commands/compute/scale.js +112 -0
  35. package/lib/commands/compute/scale.js.map +1 -0
  36. package/lib/commands/compute/source/retrieve.d.ts +18 -0
  37. package/lib/commands/compute/source/retrieve.js +71 -0
  38. package/lib/commands/compute/source/retrieve.js.map +1 -0
  39. package/lib/commands/compute/tail/runtime-log.d.ts +17 -0
  40. package/lib/commands/compute/tail/runtime-log.js +82 -0
  41. package/lib/commands/compute/tail/runtime-log.js.map +1 -0
  42. package/lib/index.d.ts +2 -0
  43. package/lib/index.js +20 -0
  44. package/lib/index.js.map +1 -0
  45. package/lib/shared/computeApp.d.ts +10 -0
  46. package/lib/shared/computeApp.js +82 -0
  47. package/lib/shared/computeApp.js.map +1 -0
  48. package/lib/shared/computeBundle.d.ts +9 -0
  49. package/lib/shared/computeBundle.js +202 -0
  50. package/lib/shared/computeBundle.js.map +1 -0
  51. package/lib/shared/computeConfig.d.ts +2 -0
  52. package/lib/shared/computeConfig.js +37 -0
  53. package/lib/shared/computeConfig.js.map +1 -0
  54. package/lib/shared/computeConnectApi.d.ts +16 -0
  55. package/lib/shared/computeConnectApi.js +59 -0
  56. package/lib/shared/computeConnectApi.js.map +1 -0
  57. package/lib/shared/computeGenerateSkeletons.d.ts +2 -0
  58. package/lib/shared/computeGenerateSkeletons.js +262 -0
  59. package/lib/shared/computeGenerateSkeletons.js.map +1 -0
  60. package/lib/shared/computeGenerateSource.d.ts +8 -0
  61. package/lib/shared/computeGenerateSource.js +120 -0
  62. package/lib/shared/computeGenerateSource.js.map +1 -0
  63. package/lib/shared/computeLogStream.d.ts +4 -0
  64. package/lib/shared/computeLogStream.js +108 -0
  65. package/lib/shared/computeLogStream.js.map +1 -0
  66. package/lib/shared/computeQuery.d.ts +52 -0
  67. package/lib/shared/computeQuery.js +168 -0
  68. package/lib/shared/computeQuery.js.map +1 -0
  69. package/lib/shared/computeTelemetryDrain.d.ts +11 -0
  70. package/lib/shared/computeTelemetryDrain.js +78 -0
  71. package/lib/shared/computeTelemetryDrain.js.map +1 -0
  72. package/lib/shared/herokuProxyApi.d.ts +62 -0
  73. package/lib/shared/herokuProxyApi.js +243 -0
  74. package/lib/shared/herokuProxyApi.js.map +1 -0
  75. package/lib/shared/metadataApiVersion.d.ts +2 -0
  76. package/lib/shared/metadataApiVersion.js +25 -0
  77. package/lib/shared/metadataApiVersion.js.map +1 -0
  78. package/lib/shared/metadataDeploy.d.ts +5 -0
  79. package/lib/shared/metadataDeploy.js +90 -0
  80. package/lib/shared/metadataDeploy.js.map +1 -0
  81. package/lib/shared/metadataRetrieve.d.ts +2 -0
  82. package/lib/shared/metadataRetrieve.js +68 -0
  83. package/lib/shared/metadataRetrieve.js.map +1 -0
  84. package/lib/shared/plugin-name.d.ts +13 -0
  85. package/lib/shared/plugin-name.js +29 -0
  86. package/lib/shared/plugin-name.js.map +1 -0
  87. package/messages/compute.config.get.md +39 -0
  88. package/messages/compute.config.list.md +24 -0
  89. package/messages/compute.config.set.md +49 -0
  90. package/messages/compute.config.unset.md +39 -0
  91. package/messages/compute.deploy.md +84 -0
  92. package/messages/compute.display.md +46 -0
  93. package/messages/compute.errors.md +182 -0
  94. package/messages/compute.generate.md +74 -0
  95. package/messages/compute.get.build-log.md +36 -0
  96. package/messages/compute.get.runtime-log.md +46 -0
  97. package/messages/compute.list.md +23 -0
  98. package/messages/compute.scale.md +67 -0
  99. package/messages/compute.source.retrieve.md +59 -0
  100. package/messages/compute.tail.runtime-log.md +55 -0
  101. package/npm-shrinkwrap.json +16162 -0
  102. package/oclif.manifest.json +982 -0
  103. package/package.json +117 -0
  104. package/schemas/compute-config-get.json +25 -0
  105. package/schemas/compute-config-list.json +25 -0
  106. package/schemas/compute-config-set.json +28 -0
  107. package/schemas/compute-config-unset.json +28 -0
  108. package/schemas/compute-deploy.json +30 -0
  109. package/schemas/compute-display.json +138 -0
  110. package/schemas/compute-generate.json +40 -0
  111. package/schemas/compute-get-build__log.json +30 -0
  112. package/schemas/compute-get-runtime__log.json +24 -0
  113. package/schemas/compute-list.json +94 -0
  114. package/schemas/compute-scale.json +41 -0
  115. package/schemas/compute-source-retrieve.json +26 -0
  116. package/schemas/compute-tail-runtime__log.json +18 -0
@@ -0,0 +1,982 @@
1
+ {
2
+ "commands": {
3
+ "compute:deploy": {
4
+ "aliases": [],
5
+ "args": {},
6
+ "description": "Packages the compute app's source (everything under its directory except the\ncompute metadata file and .forceignore) together with its api-spec.yaml into\na deployment bundle, uploads it to the org through the Connect API, then\ndeploys the app's <name>.compute-meta.xml through the\nMetadata API to trigger the build. The metadata deploy itself returns a job\nID that can be checked independently with \"sf project deploy report\n--job-id <id>\". Deploy is asynchronous: this command returns once the build\nhas been enqueued, it doesn't wait for the build to finish.\n\nFiles matching patterns in a .forceignore are excluded from the source\nbundle. Both the compute app's own .forceignore and the one at the project\nroot (next to sfdx-project.json) are applied, if present. api-spec.yaml and\nproject.toml are always included, since the build can't succeed without them.",
7
+ "examples": [
8
+ "Deploy a compute app to an org, from inside the app's own directory:\ncd force-app/main/default/platformComputeApps/CreditRatingScorer\n<%= config.bin %> <%= command.id %> --target-org my-org",
9
+ "Deploy a compute app to an org, from anywhere, by pointing --source-dir at it:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/platformComputeApps/CreditRatingScorer --target-org my-org"
10
+ ],
11
+ "flags": {
12
+ "json": {
13
+ "description": "Format output as json.",
14
+ "helpGroup": "GLOBAL",
15
+ "name": "json",
16
+ "allowNo": false,
17
+ "type": "boolean"
18
+ },
19
+ "flags-dir": {
20
+ "helpGroup": "GLOBAL",
21
+ "name": "flags-dir",
22
+ "summary": "Import flag values from a directory.",
23
+ "hasDynamicHelp": false,
24
+ "multiple": false,
25
+ "type": "option"
26
+ },
27
+ "source-dir": {
28
+ "char": "d",
29
+ "name": "source-dir",
30
+ "summary": "Directory containing the compute app to deploy. Defaults to the current directory.",
31
+ "default": "current directory",
32
+ "hasDynamicHelp": true,
33
+ "multiple": false,
34
+ "type": "option"
35
+ },
36
+ "target-org": {
37
+ "char": "o",
38
+ "name": "target-org",
39
+ "noCacheDefault": true,
40
+ "required": true,
41
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
42
+ "hasDynamicHelp": true,
43
+ "multiple": false,
44
+ "type": "option"
45
+ }
46
+ },
47
+ "hasDynamicHelp": true,
48
+ "hiddenAliases": [],
49
+ "id": "compute:deploy",
50
+ "pluginAlias": "@heroku/plugin-compute",
51
+ "pluginName": "@heroku/plugin-compute",
52
+ "pluginType": "core",
53
+ "strict": true,
54
+ "summary": "Deploy a compute app's source and metadata to an org.",
55
+ "enableJsonFlag": true,
56
+ "requiresProject": true,
57
+ "isESM": true,
58
+ "relativePath": [
59
+ "lib",
60
+ "commands",
61
+ "compute",
62
+ "deploy.js"
63
+ ],
64
+ "aliasPermutations": [],
65
+ "permutations": [
66
+ "compute:deploy",
67
+ "deploy:compute"
68
+ ]
69
+ },
70
+ "compute:display": {
71
+ "aliases": [],
72
+ "args": {},
73
+ "description": "Queries the org for the compute app's current deployment status: its master\nlabel, description, and overall status. With --verbose, also shows whether\nan external service has been registered for it (and whether it's active),\nplus the phase, timestamps, and error detail of its current build.\n\nThis is a read-only, live lookup by --name (the app's DeveloperName) -- it\ndoesn't read from or require a local Salesforce DX project.",
74
+ "examples": [
75
+ "Show the current status of a compute app:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --target-org my-org",
76
+ "Include external service and current build detail:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --target-org my-org --verbose"
77
+ ],
78
+ "flags": {
79
+ "json": {
80
+ "description": "Format output as json.",
81
+ "helpGroup": "GLOBAL",
82
+ "name": "json",
83
+ "allowNo": false,
84
+ "type": "boolean"
85
+ },
86
+ "flags-dir": {
87
+ "helpGroup": "GLOBAL",
88
+ "name": "flags-dir",
89
+ "summary": "Import flag values from a directory.",
90
+ "hasDynamicHelp": false,
91
+ "multiple": false,
92
+ "type": "option"
93
+ },
94
+ "name": {
95
+ "char": "n",
96
+ "env": "COMPUTE_APP_NAME",
97
+ "name": "name",
98
+ "summary": "DeveloperName of the compute app to show status for (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
99
+ "hasDynamicHelp": false,
100
+ "multiple": false,
101
+ "type": "option"
102
+ },
103
+ "target-org": {
104
+ "char": "o",
105
+ "name": "target-org",
106
+ "noCacheDefault": true,
107
+ "required": true,
108
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
109
+ "hasDynamicHelp": true,
110
+ "multiple": false,
111
+ "type": "option"
112
+ },
113
+ "verbose": {
114
+ "char": "v",
115
+ "name": "verbose",
116
+ "summary": "Also show external service registration and current build detail.",
117
+ "allowNo": false,
118
+ "type": "boolean"
119
+ }
120
+ },
121
+ "hasDynamicHelp": true,
122
+ "hiddenAliases": [],
123
+ "id": "compute:display",
124
+ "pluginAlias": "@heroku/plugin-compute",
125
+ "pluginName": "@heroku/plugin-compute",
126
+ "pluginType": "core",
127
+ "strict": true,
128
+ "summary": "Show the current org-side status of a deployed compute app.",
129
+ "enableJsonFlag": true,
130
+ "requiresProject": false,
131
+ "isESM": true,
132
+ "relativePath": [
133
+ "lib",
134
+ "commands",
135
+ "compute",
136
+ "display.js"
137
+ ],
138
+ "aliasPermutations": [],
139
+ "permutations": [
140
+ "compute:display",
141
+ "display:compute"
142
+ ]
143
+ },
144
+ "compute:generate": {
145
+ "aliases": [],
146
+ "args": {},
147
+ "description": "Creates the app directory under force-app/main/default/platformComputeApps/<name>/ (or\n--output-dir) with a compute metadata file, a Procfile, a project.toml, and\nstarter source in the language you choose with --language. No org is\ncontacted, but this command does fetch the starter source for the chosen\nlanguage from its Heroku AppLink reference app on GitHub, so it requires\noutbound network access.",
148
+ "examples": [
149
+ "Scaffold a Node.js compute app named CreditRatingScorer:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer",
150
+ "Scaffold a Python compute app into a custom directory:\n<%= config.bin %> <%= command.id %> --name ReceiptOcr --language python --output-dir force-app/main/default/platformComputeApps/scorers"
151
+ ],
152
+ "flags": {
153
+ "json": {
154
+ "description": "Format output as json.",
155
+ "helpGroup": "GLOBAL",
156
+ "name": "json",
157
+ "allowNo": false,
158
+ "type": "boolean"
159
+ },
160
+ "flags-dir": {
161
+ "helpGroup": "GLOBAL",
162
+ "name": "flags-dir",
163
+ "summary": "Import flag values from a directory.",
164
+ "hasDynamicHelp": false,
165
+ "multiple": false,
166
+ "type": "option"
167
+ },
168
+ "name": {
169
+ "char": "n",
170
+ "name": "name",
171
+ "required": true,
172
+ "summary": "Name for the new compute app. Use <namespace>\\_\\_<developerName> to scaffold\nit under a namespace.",
173
+ "hasDynamicHelp": false,
174
+ "multiple": false,
175
+ "type": "option"
176
+ },
177
+ "output-dir": {
178
+ "char": "d",
179
+ "description": "Defaults to force-app/main/default/platformComputeApps. The app itself is created in a\nsubdirectory named after --name.",
180
+ "name": "output-dir",
181
+ "summary": "Directory to create the app in.",
182
+ "default": "force-app/main/default/platformComputeApps",
183
+ "hasDynamicHelp": false,
184
+ "multiple": false,
185
+ "type": "option"
186
+ },
187
+ "language": {
188
+ "char": "l",
189
+ "description": "Compute apps can run any Heroku-supported language, but generate currently\nscaffolds starters for node and python only.",
190
+ "name": "language",
191
+ "summary": "Language to scaffold the starter project in.",
192
+ "default": "node",
193
+ "hasDynamicHelp": false,
194
+ "multiple": false,
195
+ "options": [
196
+ "node",
197
+ "python"
198
+ ],
199
+ "type": "option"
200
+ }
201
+ },
202
+ "hasDynamicHelp": false,
203
+ "hiddenAliases": [],
204
+ "id": "compute:generate",
205
+ "pluginAlias": "@heroku/plugin-compute",
206
+ "pluginName": "@heroku/plugin-compute",
207
+ "pluginType": "core",
208
+ "strict": true,
209
+ "summary": "Scaffold a new compute app into your Salesforce DX project.",
210
+ "enableJsonFlag": true,
211
+ "requiresProject": true,
212
+ "isESM": true,
213
+ "relativePath": [
214
+ "lib",
215
+ "commands",
216
+ "compute",
217
+ "generate.js"
218
+ ],
219
+ "aliasPermutations": [],
220
+ "permutations": [
221
+ "compute:generate",
222
+ "generate:compute"
223
+ ]
224
+ },
225
+ "compute:list": {
226
+ "aliases": [],
227
+ "args": {},
228
+ "description": "Queries the org for every compute app (PlatformComputeApp). The table shows\neach app's master label, status, and status reason; for description, external\nservice registration, and current build detail on a single app, use compute\ndisplay (the full detail is also available here via --json).\n\nThis is a read-only, live lookup -- it doesn't read from or require a local\nSalesforce DX project.",
229
+ "examples": [
230
+ "List the compute apps in an org:\n<%= config.bin %> <%= command.id %> --target-org my-org"
231
+ ],
232
+ "flags": {
233
+ "json": {
234
+ "description": "Format output as json.",
235
+ "helpGroup": "GLOBAL",
236
+ "name": "json",
237
+ "allowNo": false,
238
+ "type": "boolean"
239
+ },
240
+ "flags-dir": {
241
+ "helpGroup": "GLOBAL",
242
+ "name": "flags-dir",
243
+ "summary": "Import flag values from a directory.",
244
+ "hasDynamicHelp": false,
245
+ "multiple": false,
246
+ "type": "option"
247
+ },
248
+ "target-org": {
249
+ "char": "o",
250
+ "name": "target-org",
251
+ "noCacheDefault": true,
252
+ "required": true,
253
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
254
+ "hasDynamicHelp": true,
255
+ "multiple": false,
256
+ "type": "option"
257
+ }
258
+ },
259
+ "hasDynamicHelp": true,
260
+ "hiddenAliases": [],
261
+ "id": "compute:list",
262
+ "pluginAlias": "@heroku/plugin-compute",
263
+ "pluginName": "@heroku/plugin-compute",
264
+ "pluginType": "core",
265
+ "strict": true,
266
+ "summary": "List the compute apps deployed in an org.",
267
+ "enableJsonFlag": true,
268
+ "requiresProject": false,
269
+ "isESM": true,
270
+ "relativePath": [
271
+ "lib",
272
+ "commands",
273
+ "compute",
274
+ "list.js"
275
+ ],
276
+ "aliasPermutations": [],
277
+ "permutations": [
278
+ "compute:list",
279
+ "list:compute"
280
+ ]
281
+ },
282
+ "compute:scale": {
283
+ "aliases": [],
284
+ "args": {},
285
+ "description": "Updates a single process type's dyno size and/or quantity for a deployed\ncompute app. Pass the process type with --process-type and at least one of\n--quantity or --size. This goes through the target org's Salesforce Connect\nAPI, which calls Heroku on your behalf.",
286
+ "examples": [
287
+ "Change a process type's dyno size:\n<%= config.bin %> <%= command.id %> --process-type web --size dyno-2c-8gb --name CreditRatingScorer --target-org my-org",
288
+ "Scale a process type's dyno count:\n<%= config.bin %> <%= command.id %> --process-type worker --quantity 3 --name CreditRatingScorer --target-org my-org",
289
+ "Change size and quantity together:\n<%= config.bin %> <%= command.id %> --process-type web --quantity 2 --size dyno-4c-16gb --name CreditRatingScorer --target-org my-org",
290
+ "Stop all dynos of a process type:\n<%= config.bin %> <%= command.id %> --process-type worker --quantity 0 --name CreditRatingScorer --target-org my-org"
291
+ ],
292
+ "flags": {
293
+ "json": {
294
+ "description": "Format output as json.",
295
+ "helpGroup": "GLOBAL",
296
+ "name": "json",
297
+ "allowNo": false,
298
+ "type": "boolean"
299
+ },
300
+ "flags-dir": {
301
+ "helpGroup": "GLOBAL",
302
+ "name": "flags-dir",
303
+ "summary": "Import flag values from a directory.",
304
+ "hasDynamicHelp": false,
305
+ "multiple": false,
306
+ "type": "option"
307
+ },
308
+ "name": {
309
+ "char": "n",
310
+ "env": "COMPUTE_APP_NAME",
311
+ "name": "name",
312
+ "summary": "DeveloperName of the compute app to scale (or <namespace>\\_\\_<developerName>\nif it was deployed under a namespace). Defaults to the COMPUTE_APP_NAME\nenvironment variable, or the current directory's app name if that isn't set\neither.",
313
+ "hasDynamicHelp": false,
314
+ "multiple": false,
315
+ "type": "option"
316
+ },
317
+ "target-org": {
318
+ "char": "o",
319
+ "name": "target-org",
320
+ "noCacheDefault": true,
321
+ "required": true,
322
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
323
+ "hasDynamicHelp": true,
324
+ "multiple": false,
325
+ "type": "option"
326
+ },
327
+ "process-type": {
328
+ "name": "process-type",
329
+ "required": true,
330
+ "summary": "Process type to scale, for example web or worker.",
331
+ "hasDynamicHelp": false,
332
+ "multiple": false,
333
+ "type": "option"
334
+ },
335
+ "quantity": {
336
+ "name": "quantity",
337
+ "summary": "Number of dynos to run for the process type (0 stops all dynos of that type).",
338
+ "hasDynamicHelp": false,
339
+ "multiple": false,
340
+ "type": "option"
341
+ },
342
+ "size": {
343
+ "name": "size",
344
+ "summary": "Dyno size to run the process type on, for example dyno-1c-4gb.",
345
+ "hasDynamicHelp": false,
346
+ "multiple": false,
347
+ "type": "option"
348
+ }
349
+ },
350
+ "hasDynamicHelp": true,
351
+ "hiddenAliases": [],
352
+ "id": "compute:scale",
353
+ "pluginAlias": "@heroku/plugin-compute",
354
+ "pluginName": "@heroku/plugin-compute",
355
+ "pluginType": "core",
356
+ "strict": true,
357
+ "summary": "Resize or rescale a compute app's dyno formation.",
358
+ "enableJsonFlag": true,
359
+ "requiresProject": false,
360
+ "isESM": true,
361
+ "relativePath": [
362
+ "lib",
363
+ "commands",
364
+ "compute",
365
+ "scale.js"
366
+ ],
367
+ "aliasPermutations": [],
368
+ "permutations": [
369
+ "compute:scale",
370
+ "scale:compute"
371
+ ]
372
+ },
373
+ "compute:config:get": {
374
+ "aliases": [],
375
+ "args": {
376
+ "key": {
377
+ "multiple": true,
378
+ "name": "key"
379
+ }
380
+ },
381
+ "description": "Goes through the target org's Salesforce Connect API, which calls Heroku on\nyour behalf. Pass a single key to print its bare value, or more than one to\nprint each as key: value. Fails if any requested key isn't currently set.",
382
+ "examples": [
383
+ "Print a single config var's value:\n<%= config.bin %> <%= command.id %> STRIPE_KEY --name CreditRatingScorer --target-org my-org",
384
+ "Print more than one config var:\n<%= config.bin %> <%= command.id %> STRIPE_KEY LOG_LEVEL --name CreditRatingScorer --target-org my-org"
385
+ ],
386
+ "flags": {
387
+ "json": {
388
+ "description": "Format output as json.",
389
+ "helpGroup": "GLOBAL",
390
+ "name": "json",
391
+ "allowNo": false,
392
+ "type": "boolean"
393
+ },
394
+ "flags-dir": {
395
+ "helpGroup": "GLOBAL",
396
+ "name": "flags-dir",
397
+ "summary": "Import flag values from a directory.",
398
+ "hasDynamicHelp": false,
399
+ "multiple": false,
400
+ "type": "option"
401
+ },
402
+ "name": {
403
+ "char": "n",
404
+ "env": "COMPUTE_APP_NAME",
405
+ "name": "name",
406
+ "summary": "DeveloperName of the compute app to read config from (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
407
+ "hasDynamicHelp": false,
408
+ "multiple": false,
409
+ "type": "option"
410
+ },
411
+ "target-org": {
412
+ "char": "o",
413
+ "name": "target-org",
414
+ "noCacheDefault": true,
415
+ "required": true,
416
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
417
+ "hasDynamicHelp": true,
418
+ "multiple": false,
419
+ "type": "option"
420
+ }
421
+ },
422
+ "hasDynamicHelp": true,
423
+ "hiddenAliases": [],
424
+ "id": "compute:config:get",
425
+ "pluginAlias": "@heroku/plugin-compute",
426
+ "pluginName": "@heroku/plugin-compute",
427
+ "pluginType": "core",
428
+ "strict": true,
429
+ "summary": "Print one or more of a compute app's config var values.",
430
+ "enableJsonFlag": true,
431
+ "requiresProject": false,
432
+ "isESM": true,
433
+ "relativePath": [
434
+ "lib",
435
+ "commands",
436
+ "compute",
437
+ "config",
438
+ "get.js"
439
+ ],
440
+ "aliasPermutations": [],
441
+ "permutations": [
442
+ "compute:config:get",
443
+ "config:compute:get",
444
+ "config:get:compute",
445
+ "compute:get:config",
446
+ "get:compute:config",
447
+ "get:config:compute"
448
+ ]
449
+ },
450
+ "compute:config:list": {
451
+ "aliases": [],
452
+ "args": {},
453
+ "description": "Shows every config var (environment variable) currently set for a deployed\ncompute app, sorted alphabetically. Goes through the target org's Salesforce\nConnect API, which calls Heroku on your behalf. Use sf compute config get to\nread a single var's value, sf compute config set to add or change vars, or\nsf compute config unset to remove them.",
454
+ "examples": [
455
+ "List all config vars for a compute app:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --target-org my-org"
456
+ ],
457
+ "flags": {
458
+ "json": {
459
+ "description": "Format output as json.",
460
+ "helpGroup": "GLOBAL",
461
+ "name": "json",
462
+ "allowNo": false,
463
+ "type": "boolean"
464
+ },
465
+ "flags-dir": {
466
+ "helpGroup": "GLOBAL",
467
+ "name": "flags-dir",
468
+ "summary": "Import flag values from a directory.",
469
+ "hasDynamicHelp": false,
470
+ "multiple": false,
471
+ "type": "option"
472
+ },
473
+ "name": {
474
+ "char": "n",
475
+ "env": "COMPUTE_APP_NAME",
476
+ "name": "name",
477
+ "summary": "DeveloperName of the compute app to list config vars for (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
478
+ "hasDynamicHelp": false,
479
+ "multiple": false,
480
+ "type": "option"
481
+ },
482
+ "target-org": {
483
+ "char": "o",
484
+ "name": "target-org",
485
+ "noCacheDefault": true,
486
+ "required": true,
487
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
488
+ "hasDynamicHelp": true,
489
+ "multiple": false,
490
+ "type": "option"
491
+ }
492
+ },
493
+ "hasDynamicHelp": true,
494
+ "hiddenAliases": [],
495
+ "id": "compute:config:list",
496
+ "pluginAlias": "@heroku/plugin-compute",
497
+ "pluginName": "@heroku/plugin-compute",
498
+ "pluginType": "core",
499
+ "strict": true,
500
+ "summary": "List a compute app's config vars.",
501
+ "enableJsonFlag": true,
502
+ "requiresProject": false,
503
+ "isESM": true,
504
+ "relativePath": [
505
+ "lib",
506
+ "commands",
507
+ "compute",
508
+ "config",
509
+ "list.js"
510
+ ],
511
+ "aliasPermutations": [],
512
+ "permutations": [
513
+ "compute:config:list",
514
+ "config:compute:list",
515
+ "config:list:compute",
516
+ "compute:list:config",
517
+ "list:compute:config",
518
+ "list:config:compute"
519
+ ]
520
+ },
521
+ "compute:config:set": {
522
+ "aliases": [],
523
+ "args": {
524
+ "pair": {
525
+ "multiple": true,
526
+ "name": "pair"
527
+ }
528
+ },
529
+ "description": "Goes through the target org's Salesforce Connect API, which calls Heroku on\nyour behalf. Setting a config var restarts the app's dynos so the new value\ntakes effect. Pass one or more KEY=VALUE pairs; a key that doesn't already\nexist is created.",
530
+ "examples": [
531
+ "Set a single config var:\n<%= config.bin %> <%= command.id %> STRIPE_KEY=sk_live_xyz789 --name CreditRatingScorer --target-org my-org",
532
+ "Set more than one config var in one command:\n<%= config.bin %> <%= command.id %> STRIPE_KEY=sk_live_xyz789 LOG_LEVEL=debug --name CreditRatingScorer --target-org my-org"
533
+ ],
534
+ "flags": {
535
+ "json": {
536
+ "description": "Format output as json.",
537
+ "helpGroup": "GLOBAL",
538
+ "name": "json",
539
+ "allowNo": false,
540
+ "type": "boolean"
541
+ },
542
+ "flags-dir": {
543
+ "helpGroup": "GLOBAL",
544
+ "name": "flags-dir",
545
+ "summary": "Import flag values from a directory.",
546
+ "hasDynamicHelp": false,
547
+ "multiple": false,
548
+ "type": "option"
549
+ },
550
+ "name": {
551
+ "char": "n",
552
+ "env": "COMPUTE_APP_NAME",
553
+ "name": "name",
554
+ "summary": "DeveloperName of the compute app to change config for (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
555
+ "hasDynamicHelp": false,
556
+ "multiple": false,
557
+ "type": "option"
558
+ },
559
+ "target-org": {
560
+ "char": "o",
561
+ "name": "target-org",
562
+ "noCacheDefault": true,
563
+ "required": true,
564
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
565
+ "hasDynamicHelp": true,
566
+ "multiple": false,
567
+ "type": "option"
568
+ }
569
+ },
570
+ "hasDynamicHelp": true,
571
+ "hiddenAliases": [],
572
+ "id": "compute:config:set",
573
+ "pluginAlias": "@heroku/plugin-compute",
574
+ "pluginName": "@heroku/plugin-compute",
575
+ "pluginType": "core",
576
+ "strict": true,
577
+ "summary": "Set one or more of a compute app's config vars.",
578
+ "enableJsonFlag": true,
579
+ "requiresProject": false,
580
+ "isESM": true,
581
+ "relativePath": [
582
+ "lib",
583
+ "commands",
584
+ "compute",
585
+ "config",
586
+ "set.js"
587
+ ],
588
+ "aliasPermutations": [],
589
+ "permutations": [
590
+ "compute:config:set",
591
+ "config:compute:set",
592
+ "config:set:compute",
593
+ "compute:set:config",
594
+ "set:compute:config",
595
+ "set:config:compute"
596
+ ]
597
+ },
598
+ "compute:config:unset": {
599
+ "aliases": [],
600
+ "args": {
601
+ "key": {
602
+ "multiple": true,
603
+ "name": "key"
604
+ }
605
+ },
606
+ "description": "Goes through the target org's Salesforce Connect API, which calls Heroku on\nyour behalf. Unsetting a config var restarts the app's dynos so the removal\ntakes effect. Fails if any requested key isn't currently set.",
607
+ "examples": [
608
+ "Unset a single config var:\n<%= config.bin %> <%= command.id %> LOG_LEVEL --name CreditRatingScorer --target-org my-org",
609
+ "Unset more than one config var in one command:\n<%= config.bin %> <%= command.id %> LOG_LEVEL DEBUG_MODE --name CreditRatingScorer --target-org my-org"
610
+ ],
611
+ "flags": {
612
+ "json": {
613
+ "description": "Format output as json.",
614
+ "helpGroup": "GLOBAL",
615
+ "name": "json",
616
+ "allowNo": false,
617
+ "type": "boolean"
618
+ },
619
+ "flags-dir": {
620
+ "helpGroup": "GLOBAL",
621
+ "name": "flags-dir",
622
+ "summary": "Import flag values from a directory.",
623
+ "hasDynamicHelp": false,
624
+ "multiple": false,
625
+ "type": "option"
626
+ },
627
+ "name": {
628
+ "char": "n",
629
+ "env": "COMPUTE_APP_NAME",
630
+ "name": "name",
631
+ "summary": "DeveloperName of the compute app to change config for (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
632
+ "hasDynamicHelp": false,
633
+ "multiple": false,
634
+ "type": "option"
635
+ },
636
+ "target-org": {
637
+ "char": "o",
638
+ "name": "target-org",
639
+ "noCacheDefault": true,
640
+ "required": true,
641
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
642
+ "hasDynamicHelp": true,
643
+ "multiple": false,
644
+ "type": "option"
645
+ }
646
+ },
647
+ "hasDynamicHelp": true,
648
+ "hiddenAliases": [],
649
+ "id": "compute:config:unset",
650
+ "pluginAlias": "@heroku/plugin-compute",
651
+ "pluginName": "@heroku/plugin-compute",
652
+ "pluginType": "core",
653
+ "strict": true,
654
+ "summary": "Unset one or more of a compute app's config vars.",
655
+ "enableJsonFlag": true,
656
+ "requiresProject": false,
657
+ "isESM": true,
658
+ "relativePath": [
659
+ "lib",
660
+ "commands",
661
+ "compute",
662
+ "config",
663
+ "unset.js"
664
+ ],
665
+ "aliasPermutations": [],
666
+ "permutations": [
667
+ "compute:config:unset",
668
+ "config:compute:unset",
669
+ "config:unset:compute",
670
+ "compute:unset:config",
671
+ "unset:compute:config",
672
+ "unset:config:compute"
673
+ ]
674
+ },
675
+ "compute:get:build-log": {
676
+ "aliases": [],
677
+ "args": {},
678
+ "description": "Fetches the bounded build/compile log (dependency install, slug compile,\nrelease) for the most recent build of a compute app -- useful right after\ndeploy to confirm the build compiled. This is a one-shot fetch of a\nfinished-or-in-progress log, not a live stream; use compute tail runtime-log\nfor the ongoing runtime log.\n\nThis is a read-only, org-mediated lookup by --name (the app's DeveloperName)\n-- the org calls Heroku's Build Info API on your behalf. It doesn't read from\nor require a local Salesforce DX project.",
679
+ "examples": [
680
+ "Print the latest build's log:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --target-org my-org"
681
+ ],
682
+ "flags": {
683
+ "json": {
684
+ "description": "Format output as json.",
685
+ "helpGroup": "GLOBAL",
686
+ "name": "json",
687
+ "allowNo": false,
688
+ "type": "boolean"
689
+ },
690
+ "flags-dir": {
691
+ "helpGroup": "GLOBAL",
692
+ "name": "flags-dir",
693
+ "summary": "Import flag values from a directory.",
694
+ "hasDynamicHelp": false,
695
+ "multiple": false,
696
+ "type": "option"
697
+ },
698
+ "name": {
699
+ "char": "n",
700
+ "env": "COMPUTE_APP_NAME",
701
+ "name": "name",
702
+ "summary": "DeveloperName of the compute app to fetch build output for (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
703
+ "hasDynamicHelp": false,
704
+ "multiple": false,
705
+ "type": "option"
706
+ },
707
+ "target-org": {
708
+ "char": "o",
709
+ "name": "target-org",
710
+ "noCacheDefault": true,
711
+ "required": true,
712
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
713
+ "hasDynamicHelp": true,
714
+ "multiple": false,
715
+ "type": "option"
716
+ }
717
+ },
718
+ "hasDynamicHelp": true,
719
+ "hiddenAliases": [],
720
+ "id": "compute:get:build-log",
721
+ "pluginAlias": "@heroku/plugin-compute",
722
+ "pluginName": "@heroku/plugin-compute",
723
+ "pluginType": "core",
724
+ "strict": true,
725
+ "summary": "Print the build/compile log for a compute app's latest build.",
726
+ "enableJsonFlag": true,
727
+ "requiresProject": false,
728
+ "isESM": true,
729
+ "relativePath": [
730
+ "lib",
731
+ "commands",
732
+ "compute",
733
+ "get",
734
+ "build-log.js"
735
+ ],
736
+ "aliasPermutations": [],
737
+ "permutations": [
738
+ "compute:get:build-log",
739
+ "get:compute:build-log",
740
+ "get:build-log:compute",
741
+ "compute:build-log:get",
742
+ "build-log:compute:get",
743
+ "build-log:get:compute"
744
+ ]
745
+ },
746
+ "compute:get:runtime-log": {
747
+ "aliases": [],
748
+ "args": {},
749
+ "description": "Fetches a compute app's runtime log -- the app's ongoing output (request\nhandling, application logs), not the build/compile log; use compute get\nbuild-log for that.\n\nThis prints the most recent log lines and exits. To keep the session open and\nstream new lines as they arrive, use compute tail runtime-log.\n\nThis is an org-mediated operation by --name (the app's DeveloperName) -- the\norg creates a log session with Heroku on your behalf and hands back a\nshort-lived, pre-authorized URL that the CLI reads from directly. It doesn't\nread from or require a local Salesforce DX project.",
750
+ "examples": [
751
+ "Print the most recent log lines:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --target-org my-org",
752
+ "Print the most recent 500 log lines:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --num 500 --target-org my-org"
753
+ ],
754
+ "flags": {
755
+ "json": {
756
+ "description": "Format output as json.",
757
+ "helpGroup": "GLOBAL",
758
+ "name": "json",
759
+ "allowNo": false,
760
+ "type": "boolean"
761
+ },
762
+ "flags-dir": {
763
+ "helpGroup": "GLOBAL",
764
+ "name": "flags-dir",
765
+ "summary": "Import flag values from a directory.",
766
+ "hasDynamicHelp": false,
767
+ "multiple": false,
768
+ "type": "option"
769
+ },
770
+ "name": {
771
+ "char": "n",
772
+ "env": "COMPUTE_APP_NAME",
773
+ "name": "name",
774
+ "summary": "DeveloperName of the compute app to fetch logs for (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
775
+ "hasDynamicHelp": false,
776
+ "multiple": false,
777
+ "type": "option"
778
+ },
779
+ "target-org": {
780
+ "char": "o",
781
+ "name": "target-org",
782
+ "noCacheDefault": true,
783
+ "required": true,
784
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
785
+ "hasDynamicHelp": true,
786
+ "multiple": false,
787
+ "type": "option"
788
+ },
789
+ "num": {
790
+ "name": "num",
791
+ "summary": "Number of recent log lines to print.",
792
+ "default": 100,
793
+ "hasDynamicHelp": false,
794
+ "multiple": false,
795
+ "type": "option"
796
+ }
797
+ },
798
+ "hasDynamicHelp": true,
799
+ "hiddenAliases": [],
800
+ "id": "compute:get:runtime-log",
801
+ "pluginAlias": "@heroku/plugin-compute",
802
+ "pluginName": "@heroku/plugin-compute",
803
+ "pluginType": "core",
804
+ "strict": true,
805
+ "summary": "Print the recent runtime log for a compute app.",
806
+ "enableJsonFlag": true,
807
+ "requiresProject": false,
808
+ "isESM": true,
809
+ "relativePath": [
810
+ "lib",
811
+ "commands",
812
+ "compute",
813
+ "get",
814
+ "runtime-log.js"
815
+ ],
816
+ "aliasPermutations": [],
817
+ "permutations": [
818
+ "compute:get:runtime-log",
819
+ "get:compute:runtime-log",
820
+ "get:runtime-log:compute",
821
+ "compute:runtime-log:get",
822
+ "runtime-log:compute:get",
823
+ "runtime-log:get:compute"
824
+ ]
825
+ },
826
+ "compute:source:retrieve": {
827
+ "aliases": [],
828
+ "args": {},
829
+ "description": "Creates the compute app's directory under force-app/main/default/platformComputeApps/<name>/\n(or --output-dir), retrieves its <name>.compute-meta.xml through the Metadata\nAPI, then downloads its source code through the Connect API and extracts it\ninto that same directory. This is the inverse of sf compute deploy.",
830
+ "examples": [
831
+ "Retrieve a compute app's source and metadata from an org:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --target-org my-org"
832
+ ],
833
+ "flags": {
834
+ "json": {
835
+ "description": "Format output as json.",
836
+ "helpGroup": "GLOBAL",
837
+ "name": "json",
838
+ "allowNo": false,
839
+ "type": "boolean"
840
+ },
841
+ "flags-dir": {
842
+ "helpGroup": "GLOBAL",
843
+ "name": "flags-dir",
844
+ "summary": "Import flag values from a directory.",
845
+ "hasDynamicHelp": false,
846
+ "multiple": false,
847
+ "type": "option"
848
+ },
849
+ "name": {
850
+ "char": "n",
851
+ "name": "name",
852
+ "required": true,
853
+ "summary": "DeveloperName of the compute app to retrieve (or <namespace>\\_\\_<developerName>\nif it was deployed under a namespace).",
854
+ "hasDynamicHelp": false,
855
+ "multiple": false,
856
+ "type": "option"
857
+ },
858
+ "target-org": {
859
+ "char": "o",
860
+ "name": "target-org",
861
+ "noCacheDefault": true,
862
+ "required": true,
863
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
864
+ "hasDynamicHelp": true,
865
+ "multiple": false,
866
+ "type": "option"
867
+ },
868
+ "output-dir": {
869
+ "char": "d",
870
+ "description": "Defaults to force-app/main/default/platformComputeApps. The app itself is created in a\nsubdirectory named after --name.",
871
+ "name": "output-dir",
872
+ "summary": "Directory to create the app in.",
873
+ "default": "force-app/main/default/platformComputeApps",
874
+ "hasDynamicHelp": false,
875
+ "multiple": false,
876
+ "type": "option"
877
+ }
878
+ },
879
+ "hasDynamicHelp": true,
880
+ "hiddenAliases": [],
881
+ "id": "compute:source:retrieve",
882
+ "pluginAlias": "@heroku/plugin-compute",
883
+ "pluginName": "@heroku/plugin-compute",
884
+ "pluginType": "core",
885
+ "strict": true,
886
+ "summary": "Retrieve a compute app's source and metadata from an org into your local Salesforce DX project.",
887
+ "enableJsonFlag": true,
888
+ "requiresProject": true,
889
+ "isESM": true,
890
+ "relativePath": [
891
+ "lib",
892
+ "commands",
893
+ "compute",
894
+ "source",
895
+ "retrieve.js"
896
+ ],
897
+ "aliasPermutations": [],
898
+ "permutations": [
899
+ "compute:source:retrieve",
900
+ "source:compute:retrieve",
901
+ "source:retrieve:compute",
902
+ "compute:retrieve:source",
903
+ "retrieve:compute:source",
904
+ "retrieve:source:compute"
905
+ ]
906
+ },
907
+ "compute:tail:runtime-log": {
908
+ "aliases": [],
909
+ "args": {},
910
+ "description": "Streams a compute app's runtime log -- the app's ongoing output (request\nhandling, application logs), not the build/compile log; use compute get\nbuild-log for that.\n\nKeeps the session open and prints new log lines as they arrive, until you stop\nit with Ctrl-C or the session ends on its own. For a one-time snapshot of the\nmost recent lines, use compute get runtime-log.\n\nThis is an org-mediated operation by --name (the app's DeveloperName) -- the\norg creates a log session with Heroku on your behalf and hands back a\nshort-lived, pre-authorized URL that the CLI reads from directly. It doesn't\nread from or require a local Salesforce DX project.",
911
+ "examples": [
912
+ "Tail the log until stopped with Ctrl-C:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --target-org my-org",
913
+ "Print the most recent 500 lines, then keep streaming:\n<%= config.bin %> <%= command.id %> --name CreditRatingScorer --num 500 --target-org my-org"
914
+ ],
915
+ "flags": {
916
+ "flags-dir": {
917
+ "helpGroup": "GLOBAL",
918
+ "name": "flags-dir",
919
+ "summary": "Import flag values from a directory.",
920
+ "hasDynamicHelp": false,
921
+ "multiple": false,
922
+ "type": "option"
923
+ },
924
+ "name": {
925
+ "char": "n",
926
+ "env": "COMPUTE_APP_NAME",
927
+ "name": "name",
928
+ "summary": "DeveloperName of the compute app to tail logs for (or\n<namespace>\\_\\_<developerName> if it was deployed under a namespace).\nDefaults to the COMPUTE_APP_NAME environment variable, or the current\ndirectory's app name if that isn't set either.",
929
+ "hasDynamicHelp": false,
930
+ "multiple": false,
931
+ "type": "option"
932
+ },
933
+ "target-org": {
934
+ "char": "o",
935
+ "name": "target-org",
936
+ "noCacheDefault": true,
937
+ "required": true,
938
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
939
+ "hasDynamicHelp": true,
940
+ "multiple": false,
941
+ "type": "option"
942
+ },
943
+ "num": {
944
+ "name": "num",
945
+ "summary": "Number of recent log lines to print before streaming new output.",
946
+ "default": 100,
947
+ "hasDynamicHelp": false,
948
+ "multiple": false,
949
+ "type": "option"
950
+ }
951
+ },
952
+ "hasDynamicHelp": true,
953
+ "hiddenAliases": [],
954
+ "id": "compute:tail:runtime-log",
955
+ "pluginAlias": "@heroku/plugin-compute",
956
+ "pluginName": "@heroku/plugin-compute",
957
+ "pluginType": "core",
958
+ "strict": true,
959
+ "summary": "Stream the live runtime log for a compute app.",
960
+ "enableJsonFlag": false,
961
+ "requiresProject": false,
962
+ "isESM": true,
963
+ "relativePath": [
964
+ "lib",
965
+ "commands",
966
+ "compute",
967
+ "tail",
968
+ "runtime-log.js"
969
+ ],
970
+ "aliasPermutations": [],
971
+ "permutations": [
972
+ "compute:tail:runtime-log",
973
+ "tail:compute:runtime-log",
974
+ "tail:runtime-log:compute",
975
+ "compute:runtime-log:tail",
976
+ "runtime-log:compute:tail",
977
+ "runtime-log:tail:compute"
978
+ ]
979
+ }
980
+ },
981
+ "version": "0.1.0"
982
+ }