UNPKG

17.2 kBJSONView Raw
1{
2 "version": "8.0.2",
3 "commands": {
4 "pipelines:add": {
5 "id": "pipelines:add",
6 "description": "add this app to a pipeline\nThe app and pipeline names must be specified.\nThe stage of the app will be guessed based on its name if not specified.",
7 "strict": true,
8 "pluginName": "@heroku-cli/plugin-pipelines",
9 "pluginAlias": "@heroku-cli/plugin-pipelines",
10 "pluginType": "core",
11 "aliases": [],
12 "examples": [
13 "$ heroku pipelines:add my-pipeline -a my-app -s production"
14 ],
15 "flags": {
16 "app": {
17 "name": "app",
18 "type": "option",
19 "char": "a",
20 "description": "app to run command against",
21 "required": true,
22 "multiple": false
23 },
24 "remote": {
25 "name": "remote",
26 "type": "option",
27 "char": "r",
28 "description": "git remote of app to use",
29 "multiple": false
30 },
31 "stage": {
32 "name": "stage",
33 "type": "option",
34 "char": "s",
35 "description": "stage of first app in pipeline",
36 "multiple": false
37 }
38 },
39 "args": {
40 "pipeline": {
41 "name": "pipeline",
42 "description": "name of pipeline",
43 "required": true
44 }
45 }
46 },
47 "pipelines:connect": {
48 "id": "pipelines:connect",
49 "description": "connect a github repo to an existing pipeline",
50 "strict": true,
51 "pluginName": "@heroku-cli/plugin-pipelines",
52 "pluginAlias": "@heroku-cli/plugin-pipelines",
53 "pluginType": "core",
54 "aliases": [],
55 "examples": [
56 "$ heroku pipelines:connect my-pipeline -r githuborg/reponame"
57 ],
58 "flags": {
59 "repo": {
60 "name": "repo",
61 "type": "option",
62 "char": "r",
63 "description": "the GitHub repository to connect to",
64 "required": true,
65 "multiple": false
66 }
67 },
68 "args": {
69 "name": {
70 "name": "name",
71 "description": "name of pipeline",
72 "required": true
73 }
74 }
75 },
76 "pipelines:create": {
77 "id": "pipelines:create",
78 "description": "create a new pipeline\n An existing app must be specified as the first app in the pipeline.\n The pipeline name will be inferred from the app name if not specified.\n The stage of the app will be guessed based on its name if not specified.\n The pipeline owner will be the user creating the pipeline if not specified with -t for teams or -o for orgs.",
79 "strict": true,
80 "pluginName": "@heroku-cli/plugin-pipelines",
81 "pluginAlias": "@heroku-cli/plugin-pipelines",
82 "pluginType": "core",
83 "aliases": [],
84 "examples": [
85 "$ heroku pipelines:create -a my-app-staging",
86 "$ heroku pipelines:create my-pipeline -a my-app-staging"
87 ],
88 "flags": {
89 "app": {
90 "name": "app",
91 "type": "option",
92 "char": "a",
93 "description": "app to run command against",
94 "required": true,
95 "multiple": false
96 },
97 "remote": {
98 "name": "remote",
99 "type": "option",
100 "char": "r",
101 "description": "git remote of app to use",
102 "multiple": false
103 },
104 "stage": {
105 "name": "stage",
106 "type": "option",
107 "char": "s",
108 "description": "stage of first app in pipeline",
109 "multiple": false
110 },
111 "team": {
112 "name": "team",
113 "type": "option",
114 "char": "t",
115 "description": "the team which will own the apps",
116 "multiple": false
117 }
118 },
119 "args": {
120 "name": {
121 "name": "name",
122 "description": "name of pipeline (defaults to basename of the app)",
123 "required": false
124 }
125 }
126 },
127 "pipelines:destroy": {
128 "id": "pipelines:destroy",
129 "description": "destroy a pipeline",
130 "strict": true,
131 "pluginName": "@heroku-cli/plugin-pipelines",
132 "pluginAlias": "@heroku-cli/plugin-pipelines",
133 "pluginType": "core",
134 "aliases": [],
135 "examples": [
136 "$ heroku pipelines:destroy my-pipeline"
137 ],
138 "flags": {},
139 "args": {
140 "pipeline": {
141 "name": "pipeline",
142 "description": "name of pipeline",
143 "required": true
144 }
145 }
146 },
147 "pipelines:diff": {
148 "id": "pipelines:diff",
149 "description": "compares the latest release of this app to its downstream app(s)",
150 "strict": true,
151 "pluginName": "@heroku-cli/plugin-pipelines",
152 "pluginAlias": "@heroku-cli/plugin-pipelines",
153 "pluginType": "core",
154 "aliases": [],
155 "examples": [
156 "$ heroku pipelines:diff -a my-app-staging"
157 ],
158 "flags": {
159 "app": {
160 "name": "app",
161 "type": "option",
162 "char": "a",
163 "description": "app to run command against",
164 "required": true,
165 "multiple": false
166 },
167 "remote": {
168 "name": "remote",
169 "type": "option",
170 "char": "r",
171 "description": "git remote of app to use",
172 "multiple": false
173 }
174 },
175 "args": {}
176 },
177 "pipelines": {
178 "id": "pipelines",
179 "description": "list pipelines you have access to",
180 "strict": true,
181 "pluginName": "@heroku-cli/plugin-pipelines",
182 "pluginAlias": "@heroku-cli/plugin-pipelines",
183 "pluginType": "core",
184 "aliases": [],
185 "examples": [
186 "$ heroku pipelines"
187 ],
188 "flags": {
189 "json": {
190 "name": "json",
191 "type": "boolean",
192 "description": "output in json format",
193 "allowNo": false
194 }
195 },
196 "args": {}
197 },
198 "pipelines:info": {
199 "id": "pipelines:info",
200 "description": "show list of apps in a pipeline",
201 "strict": true,
202 "pluginName": "@heroku-cli/plugin-pipelines",
203 "pluginAlias": "@heroku-cli/plugin-pipelines",
204 "pluginType": "core",
205 "aliases": [],
206 "examples": [
207 "$ heroku pipelines:info my-pipeline"
208 ],
209 "flags": {
210 "json": {
211 "name": "json",
212 "type": "boolean",
213 "description": "output in json format",
214 "allowNo": false
215 },
216 "with-owners": {
217 "name": "with-owners",
218 "type": "boolean",
219 "description": "shows owner of every app",
220 "hidden": true,
221 "allowNo": false
222 }
223 },
224 "args": {
225 "pipeline": {
226 "name": "pipeline",
227 "description": "pipeline to show list of apps for",
228 "required": true
229 }
230 }
231 },
232 "pipelines:open": {
233 "id": "pipelines:open",
234 "description": "open a pipeline in dashboard",
235 "strict": true,
236 "pluginName": "@heroku-cli/plugin-pipelines",
237 "pluginAlias": "@heroku-cli/plugin-pipelines",
238 "pluginType": "core",
239 "aliases": [],
240 "examples": [
241 "$ heroku pipelines:open my-pipeline"
242 ],
243 "flags": {},
244 "args": {
245 "pipeline": {
246 "name": "pipeline",
247 "description": "name of pipeline",
248 "required": true
249 }
250 }
251 },
252 "pipelines:promote": {
253 "id": "pipelines:promote",
254 "description": "promote the latest release of this app to its downstream app(s)",
255 "strict": true,
256 "pluginName": "@heroku-cli/plugin-pipelines",
257 "pluginAlias": "@heroku-cli/plugin-pipelines",
258 "pluginType": "core",
259 "aliases": [],
260 "examples": [
261 "$ heroku pipelines:promote -a my-app-staging"
262 ],
263 "flags": {
264 "app": {
265 "name": "app",
266 "type": "option",
267 "char": "a",
268 "description": "app to run command against",
269 "required": true,
270 "multiple": false
271 },
272 "remote": {
273 "name": "remote",
274 "type": "option",
275 "char": "r",
276 "description": "git remote of app to use",
277 "multiple": false
278 },
279 "to": {
280 "name": "to",
281 "type": "option",
282 "char": "t",
283 "description": "comma separated list of apps to promote to",
284 "multiple": false
285 }
286 },
287 "args": {}
288 },
289 "pipelines:remove": {
290 "id": "pipelines:remove",
291 "description": "remove this app from its pipeline",
292 "strict": true,
293 "pluginName": "@heroku-cli/plugin-pipelines",
294 "pluginAlias": "@heroku-cli/plugin-pipelines",
295 "pluginType": "core",
296 "aliases": [],
297 "examples": [
298 "$ heroku pipelines:remove -a my-app"
299 ],
300 "flags": {
301 "app": {
302 "name": "app",
303 "type": "option",
304 "char": "a",
305 "description": "app to run command against",
306 "required": true,
307 "multiple": false
308 },
309 "remote": {
310 "name": "remote",
311 "type": "option",
312 "char": "r",
313 "description": "git remote of app to use",
314 "multiple": false
315 }
316 },
317 "args": {}
318 },
319 "pipelines:rename": {
320 "id": "pipelines:rename",
321 "description": "rename a pipeline",
322 "strict": true,
323 "pluginName": "@heroku-cli/plugin-pipelines",
324 "pluginAlias": "@heroku-cli/plugin-pipelines",
325 "pluginType": "core",
326 "aliases": [],
327 "examples": [
328 "$ heroku pipelines:rename my-pipeline new-pipeline-name"
329 ],
330 "flags": {},
331 "args": {
332 "pipeline": {
333 "name": "pipeline",
334 "description": "current name of pipeline",
335 "required": true
336 },
337 "name": {
338 "name": "name",
339 "description": "new name of pipeline",
340 "required": true
341 }
342 }
343 },
344 "pipelines:setup": {
345 "id": "pipelines:setup",
346 "description": "bootstrap a new pipeline with common settings and create a production and staging app (requires a fully formed app.json in the repo)",
347 "strict": true,
348 "pluginName": "@heroku-cli/plugin-pipelines",
349 "pluginAlias": "@heroku-cli/plugin-pipelines",
350 "pluginType": "core",
351 "aliases": [],
352 "examples": [
353 "$ heroku pipelines:setup my-pipeline githuborg/reponame -t my-team"
354 ],
355 "flags": {
356 "team": {
357 "name": "team",
358 "type": "option",
359 "char": "t",
360 "description": "the team to assign pipeline ownership to (defaults to current user)",
361 "multiple": false
362 },
363 "yes": {
364 "name": "yes",
365 "type": "boolean",
366 "char": "y",
367 "description": "accept all default settings without prompting",
368 "allowNo": false
369 }
370 },
371 "args": {
372 "name": {
373 "name": "name",
374 "description": "name of pipeline",
375 "required": false
376 },
377 "repo": {
378 "name": "repo",
379 "description": "a GitHub repository to connect the pipeline to",
380 "required": false
381 }
382 }
383 },
384 "pipelines:transfer": {
385 "id": "pipelines:transfer",
386 "description": "transfer ownership of a pipeline",
387 "strict": true,
388 "pluginName": "@heroku-cli/plugin-pipelines",
389 "pluginAlias": "@heroku-cli/plugin-pipelines",
390 "pluginType": "core",
391 "aliases": [],
392 "examples": [
393 "$ heroku pipelines:transfer admin@example.com -p my-pipeline",
394 "$ heroku pipelines:transfer admin-team -p my-pipeline"
395 ],
396 "flags": {
397 "pipeline": {
398 "name": "pipeline",
399 "type": "option",
400 "char": "p",
401 "description": "name of pipeline",
402 "required": true,
403 "multiple": false
404 },
405 "confirm": {
406 "name": "confirm",
407 "type": "option",
408 "char": "c",
409 "multiple": false
410 }
411 },
412 "args": {
413 "owner": {
414 "name": "owner",
415 "description": "the owner to transfer the pipeline to",
416 "required": true
417 }
418 }
419 },
420 "pipelines:update": {
421 "id": "pipelines:update",
422 "description": "update the app's stage in a pipeline",
423 "strict": true,
424 "pluginName": "@heroku-cli/plugin-pipelines",
425 "pluginAlias": "@heroku-cli/plugin-pipelines",
426 "pluginType": "core",
427 "aliases": [],
428 "examples": [
429 "$ heroku pipelines:update -s staging -a my-app"
430 ],
431 "flags": {
432 "app": {
433 "name": "app",
434 "type": "option",
435 "char": "a",
436 "description": "app to run command against",
437 "required": true,
438 "multiple": false
439 },
440 "remote": {
441 "name": "remote",
442 "type": "option",
443 "char": "r",
444 "description": "git remote of app to use",
445 "multiple": false
446 },
447 "stage": {
448 "name": "stage",
449 "type": "option",
450 "char": "s",
451 "description": "new stage of app",
452 "required": true,
453 "multiple": false
454 }
455 },
456 "args": {}
457 },
458 "reviewapps:disable": {
459 "id": "reviewapps:disable",
460 "description": "disable review apps and/or settings on an existing pipeline",
461 "strict": true,
462 "pluginName": "@heroku-cli/plugin-pipelines",
463 "pluginAlias": "@heroku-cli/plugin-pipelines",
464 "pluginType": "core",
465 "aliases": [],
466 "examples": [
467 "$ heroku reviewapps:disable -p my-pipeline -a my-app --no-autodeploy"
468 ],
469 "flags": {
470 "app": {
471 "name": "app",
472 "type": "option",
473 "char": "a",
474 "description": "parent app used by review apps",
475 "multiple": false
476 },
477 "remote": {
478 "name": "remote",
479 "type": "option",
480 "char": "r",
481 "description": "git remote of app to use",
482 "multiple": false
483 },
484 "pipeline": {
485 "name": "pipeline",
486 "type": "option",
487 "char": "p",
488 "description": "name of pipeline",
489 "required": true,
490 "multiple": false
491 },
492 "autodeploy": {
493 "name": "autodeploy",
494 "type": "boolean",
495 "description": "disable autodeployments",
496 "hidden": true,
497 "allowNo": false
498 },
499 "autodestroy": {
500 "name": "autodestroy",
501 "type": "boolean",
502 "description": "disable automatically destroying review apps",
503 "hidden": true,
504 "allowNo": false
505 },
506 "wait-for-ci": {
507 "name": "wait-for-ci",
508 "type": "boolean",
509 "description": "disable wait for CI",
510 "hidden": true,
511 "allowNo": false
512 },
513 "no-autodeploy": {
514 "name": "no-autodeploy",
515 "type": "boolean",
516 "description": "disable autodeployments",
517 "allowNo": false
518 },
519 "no-autodestroy": {
520 "name": "no-autodestroy",
521 "type": "boolean",
522 "description": "disable automatically destroying review apps",
523 "allowNo": false
524 },
525 "no-wait-for-ci": {
526 "name": "no-wait-for-ci",
527 "type": "boolean",
528 "description": "disable wait for CI",
529 "allowNo": false
530 }
531 },
532 "args": {}
533 },
534 "reviewapps:enable": {
535 "id": "reviewapps:enable",
536 "description": "enable review apps and/or settings on an existing pipeline",
537 "strict": true,
538 "pluginName": "@heroku-cli/plugin-pipelines",
539 "pluginAlias": "@heroku-cli/plugin-pipelines",
540 "pluginType": "core",
541 "aliases": [],
542 "examples": [
543 "$ heroku reviewapps:enable -p my-pipeline -a my-app --autodeploy --autodestroy"
544 ],
545 "flags": {
546 "app": {
547 "name": "app",
548 "type": "option",
549 "char": "a",
550 "description": "parent app used by review apps",
551 "multiple": false
552 },
553 "remote": {
554 "name": "remote",
555 "type": "option",
556 "char": "r",
557 "description": "git remote of app to use",
558 "multiple": false
559 },
560 "pipeline": {
561 "name": "pipeline",
562 "type": "option",
563 "char": "p",
564 "description": "name of pipeline",
565 "required": true,
566 "multiple": false
567 },
568 "autodeploy": {
569 "name": "autodeploy",
570 "type": "boolean",
571 "description": "autodeploy the review app",
572 "allowNo": false
573 },
574 "autodestroy": {
575 "name": "autodestroy",
576 "type": "boolean",
577 "description": "autodestroy the review app",
578 "allowNo": false
579 },
580 "wait-for-ci": {
581 "name": "wait-for-ci",
582 "type": "boolean",
583 "description": "wait for CI to pass before deploying",
584 "allowNo": false
585 }
586 },
587 "args": {}
588 }
589 }
590}
\No newline at end of file