heroku 9.3.2 → 9.4.0-beta.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 (140) hide show
  1. package/lib/commands/access/add.js +1 -1
  2. package/lib/commands/access/index.js +2 -1
  3. package/lib/commands/access/update.js +1 -1
  4. package/lib/commands/addons/attach.js +1 -1
  5. package/lib/commands/addons/create.js +1 -1
  6. package/lib/commands/addons/destroy.js +1 -1
  7. package/lib/commands/addons/detach.js +1 -1
  8. package/lib/commands/addons/docs.js +1 -1
  9. package/lib/commands/addons/info.js +1 -1
  10. package/lib/commands/addons/open.js +1 -1
  11. package/lib/commands/addons/plans.js +1 -1
  12. package/lib/commands/addons/rename.js +2 -2
  13. package/lib/commands/addons/upgrade.js +2 -2
  14. package/lib/commands/addons/wait.js +1 -1
  15. package/lib/commands/apps/open.js +1 -1
  16. package/lib/commands/apps/rename.js +1 -1
  17. package/lib/commands/apps/stacks/set.js +1 -1
  18. package/lib/commands/authorizations/info.js +1 -1
  19. package/lib/commands/authorizations/revoke.js +1 -1
  20. package/lib/commands/authorizations/rotate.js +1 -1
  21. package/lib/commands/authorizations/update.js +1 -1
  22. package/lib/commands/certs/add.js +2 -2
  23. package/lib/commands/certs/generate.js +1 -1
  24. package/lib/commands/certs/update.js +2 -2
  25. package/lib/commands/ci/config/get.js +1 -1
  26. package/lib/commands/ci/info.js +1 -1
  27. package/lib/commands/ci/rerun.js +1 -1
  28. package/lib/commands/clients/create.js +2 -2
  29. package/lib/commands/clients/destroy.js +1 -1
  30. package/lib/commands/clients/info.js +1 -1
  31. package/lib/commands/clients/rotate.js +1 -1
  32. package/lib/commands/clients/update.js +1 -1
  33. package/lib/commands/config/get.js +1 -1
  34. package/lib/commands/domains/add.js +1 -1
  35. package/lib/commands/domains/info.js +1 -1
  36. package/lib/commands/domains/remove.js +1 -1
  37. package/lib/commands/domains/update.js +1 -1
  38. package/lib/commands/domains/wait.js +1 -1
  39. package/lib/commands/drains/add.js +1 -1
  40. package/lib/commands/drains/remove.js +1 -1
  41. package/lib/commands/features/disable.js +1 -1
  42. package/lib/commands/features/enable.js +1 -1
  43. package/lib/commands/features/info.js +1 -1
  44. package/lib/commands/git/credentials.js +1 -1
  45. package/lib/commands/keys/add.js +1 -1
  46. package/lib/commands/keys/remove.js +1 -1
  47. package/lib/commands/labs/disable.js +1 -1
  48. package/lib/commands/labs/enable.js +1 -1
  49. package/lib/commands/labs/info.js +1 -1
  50. package/lib/commands/local/index.js +1 -1
  51. package/lib/commands/members/add.js +1 -1
  52. package/lib/commands/pg/backups/cancel.js +1 -1
  53. package/lib/commands/pg/backups/capture.js +2 -1
  54. package/lib/commands/pg/backups/delete.js +1 -1
  55. package/lib/commands/pg/backups/download.js +1 -1
  56. package/lib/commands/pg/backups/info.js +1 -1
  57. package/lib/commands/pg/backups/restore.d.ts +1 -0
  58. package/lib/commands/pg/backups/restore.js +29 -2
  59. package/lib/commands/pg/backups/schedule.js +2 -1
  60. package/lib/commands/pg/backups/unschedule.js +2 -1
  61. package/lib/commands/pg/backups/url.js +1 -1
  62. package/lib/commands/pg/bloat.js +2 -1
  63. package/lib/commands/pg/blocking.js +2 -1
  64. package/lib/commands/pg/connection-pooling/attach.js +2 -1
  65. package/lib/commands/pg/copy.js +2 -2
  66. package/lib/commands/pg/credentials/create.js +2 -1
  67. package/lib/commands/pg/credentials/destroy.js +2 -1
  68. package/lib/commands/pg/credentials/repair-default.js +2 -1
  69. package/lib/commands/pg/credentials/rotate.js +2 -1
  70. package/lib/commands/pg/credentials/url.js +2 -1
  71. package/lib/commands/pg/credentials.js +2 -1
  72. package/lib/commands/pg/diagnose.js +1 -1
  73. package/lib/commands/pg/info.js +2 -1
  74. package/lib/commands/pg/kill.js +3 -2
  75. package/lib/commands/pg/killall.js +2 -1
  76. package/lib/commands/pg/links/create.js +3 -2
  77. package/lib/commands/pg/links/destroy.js +3 -2
  78. package/lib/commands/pg/links/index.js +2 -1
  79. package/lib/commands/pg/locks.js +2 -1
  80. package/lib/commands/pg/maintenance/index.js +2 -1
  81. package/lib/commands/pg/maintenance/run.js +2 -1
  82. package/lib/commands/pg/maintenance/window.js +3 -2
  83. package/lib/commands/pg/outliers.js +2 -1
  84. package/lib/commands/pg/promote.js +2 -1
  85. package/lib/commands/pg/ps.js +2 -1
  86. package/lib/commands/pg/psql.js +2 -1
  87. package/lib/commands/pg/pull.js +3 -2
  88. package/lib/commands/pg/push.js +4 -3
  89. package/lib/commands/pg/reset.js +2 -1
  90. package/lib/commands/pg/settings/auto-explain/log-analyze.js +3 -2
  91. package/lib/commands/pg/settings/auto-explain/log-buffers.js +3 -2
  92. package/lib/commands/pg/settings/auto-explain/log-format.js +3 -2
  93. package/lib/commands/pg/settings/auto-explain/log-min-duration.js +3 -2
  94. package/lib/commands/pg/settings/auto-explain/log-nested-statements.js +3 -2
  95. package/lib/commands/pg/settings/auto-explain/log-triggers.js +3 -2
  96. package/lib/commands/pg/settings/auto-explain/log-verbose.js +3 -2
  97. package/lib/commands/pg/settings/auto-explain.js +3 -2
  98. package/lib/commands/pg/settings/explain-data-connector-details.js +3 -2
  99. package/lib/commands/pg/settings/index.js +2 -1
  100. package/lib/commands/pg/settings/log-connections.js +3 -2
  101. package/lib/commands/pg/settings/log-lock-waits.js +3 -2
  102. package/lib/commands/pg/settings/log-min-duration-statement.js +3 -2
  103. package/lib/commands/pg/settings/log-min-error-statement.js +2 -1
  104. package/lib/commands/pg/settings/log-statement.js +3 -2
  105. package/lib/commands/pg/settings/track-functions.js +3 -2
  106. package/lib/commands/pg/unfollow.js +2 -1
  107. package/lib/commands/pg/upgrade.js +2 -1
  108. package/lib/commands/pg/vacuum-stats.js +2 -1
  109. package/lib/commands/pg/wait.js +2 -1
  110. package/lib/commands/ps/restart.js +1 -1
  111. package/lib/commands/ps/stop.js +1 -1
  112. package/lib/commands/redis/cli.js +1 -1
  113. package/lib/commands/redis/credentials.js +1 -1
  114. package/lib/commands/redis/info.js +1 -1
  115. package/lib/commands/redis/keyspace-notifications.js +1 -1
  116. package/lib/commands/redis/maintenance.js +1 -1
  117. package/lib/commands/redis/maxmemory.js +1 -1
  118. package/lib/commands/redis/promote.js +1 -1
  119. package/lib/commands/redis/stats-reset.js +1 -1
  120. package/lib/commands/redis/timeout.js +1 -1
  121. package/lib/commands/redis/upgrade.js +1 -1
  122. package/lib/commands/redis/wait.js +1 -1
  123. package/lib/commands/releases/info.js +1 -1
  124. package/lib/commands/releases/output.js +1 -1
  125. package/lib/commands/releases/rollback.js +1 -1
  126. package/lib/commands/sessions/destroy.js +1 -1
  127. package/lib/commands/spaces/drains/set.js +1 -1
  128. package/lib/commands/spaces/trusted-ips/add.js +1 -1
  129. package/lib/commands/spaces/trusted-ips/remove.js +1 -1
  130. package/lib/commands/webhooks/deliveries/info.js +1 -1
  131. package/lib/commands/webhooks/events/info.js +1 -1
  132. package/lib/commands/webhooks/info.js +1 -1
  133. package/lib/commands/webhooks/update.js +1 -1
  134. package/lib/hooks/plugins/preinstall/disclaimers.d.ts +3 -0
  135. package/lib/hooks/plugins/preinstall/disclaimers.js +26 -0
  136. package/lib/nls.d.ts +8 -0
  137. package/lib/nls.js +14 -0
  138. package/lib/package.nls.json +6 -0
  139. package/oclif.manifest.json +833 -667
  140. package/package.json +5 -2
@@ -298,6 +298,7 @@
298
298
  "aliases": [],
299
299
  "args": {
300
300
  "email": {
301
+ "description": "email address of the team member",
301
302
  "name": "email",
302
303
  "required": true
303
304
  }
@@ -439,6 +440,7 @@
439
440
  "aliases": [],
440
441
  "args": {
441
442
  "email": {
443
+ "description": "email address of the team member",
442
444
  "name": "email",
443
445
  "required": true
444
446
  }
@@ -488,125 +490,124 @@
488
490
  "update.js"
489
491
  ]
490
492
  },
491
- "apps:create": {
493
+ "addons:attach": {
492
494
  "aliases": [],
493
495
  "args": {
494
- "app": {
495
- "description": "name of app to create",
496
- "name": "app",
497
- "required": false
496
+ "addon_name": {
497
+ "description": "unique identifier or globally unique name of the add-on",
498
+ "name": "addon_name",
499
+ "required": true
498
500
  }
499
501
  },
500
- "description": "creates a new app",
501
- "examples": [
502
- "$ heroku apps:create\nCreating app... done, stack is heroku-24\nhttps://floating-dragon-42.heroku.com/ | https://git.heroku.com/floating-dragon-42.git\n\n# or just\n$ heroku create\n\n# use a heroku.yml manifest file\n$ heroku apps:create --manifest\n\n# specify a buildpack\n$ heroku apps:create --buildpack https://github.com/some/buildpack.git\n\n# specify a name\n$ heroku apps:create example\n\n# create a staging app\n$ heroku apps:create example-staging --remote staging\n\n# create an app in the eu region\n$ heroku apps:create --region eu"
503
- ],
502
+ "description": "attach an existing add-on resource to an app",
504
503
  "flags": {
505
- "app": {
506
- "hidden": true,
507
- "name": "app",
504
+ "as": {
505
+ "description": "name for add-on attachment",
506
+ "name": "as",
508
507
  "hasDynamicHelp": false,
509
508
  "multiple": false,
510
509
  "type": "option"
511
510
  },
512
- "addons": {
513
- "description": "comma-delimited list of addons to install",
514
- "name": "addons",
511
+ "credential": {
512
+ "description": "credential name for scoped access to Heroku Postgres",
513
+ "name": "credential",
515
514
  "hasDynamicHelp": false,
516
515
  "multiple": false,
517
516
  "type": "option"
518
517
  },
519
- "buildpack": {
520
- "char": "b",
521
- "description": "buildpack url to use for this app",
522
- "name": "buildpack",
518
+ "confirm": {
519
+ "description": "overwrite existing add-on attachment with same name",
520
+ "name": "confirm",
523
521
  "hasDynamicHelp": false,
524
522
  "multiple": false,
525
523
  "type": "option"
526
524
  },
527
- "manifest": {
528
- "char": "m",
529
- "description": "use heroku.yml settings for this app",
530
- "hidden": true,
531
- "name": "manifest",
532
- "allowNo": false,
533
- "type": "boolean"
534
- },
535
- "no-remote": {
536
- "char": "n",
537
- "description": "do not create a git remote",
538
- "name": "no-remote",
539
- "allowNo": false,
540
- "type": "boolean"
525
+ "app": {
526
+ "char": "a",
527
+ "description": "app to run command against",
528
+ "name": "app",
529
+ "required": true,
530
+ "hasDynamicHelp": false,
531
+ "multiple": false,
532
+ "type": "option"
541
533
  },
542
534
  "remote": {
543
535
  "char": "r",
544
- "description": "the git remote to create, default \"heroku\"",
536
+ "description": "git remote of app to use",
545
537
  "name": "remote",
546
- "default": "heroku",
547
538
  "hasDynamicHelp": false,
548
539
  "multiple": false,
549
540
  "type": "option"
550
- },
551
- "stack": {
552
- "char": "s",
553
- "description": "the stack to create the app on",
554
- "name": "stack",
541
+ }
542
+ },
543
+ "hasDynamicHelp": false,
544
+ "hiddenAliases": [],
545
+ "id": "addons:attach",
546
+ "pluginAlias": "heroku",
547
+ "pluginName": "heroku",
548
+ "pluginType": "core",
549
+ "strict": true,
550
+ "topic": "addons",
551
+ "isESM": false,
552
+ "relativePath": [
553
+ "lib",
554
+ "commands",
555
+ "addons",
556
+ "attach.js"
557
+ ]
558
+ },
559
+ "addons:create": {
560
+ "aliases": [],
561
+ "args": {
562
+ "service:plan": {
563
+ "description": "unique identifier or unique name of the add-on service plan",
564
+ "name": "service:plan",
565
+ "required": true
566
+ }
567
+ },
568
+ "description": "Create a new add-on resource.\n\nIn order to add additional config items, please place them at the end of the command after a double-dash (--).\n",
569
+ "examples": "Create an add-on resource:\n$heroku addons:create heroku-redis --app my-app\n\nCreate an add-on resource with additional config items:\n$heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE\n",
570
+ "flags": {
571
+ "name": {
572
+ "description": "name for the add-on resource",
573
+ "name": "name",
555
574
  "hasDynamicHelp": false,
556
575
  "multiple": false,
557
576
  "type": "option"
558
577
  },
559
- "space": {
560
- "description": "the private space to create the app in",
561
- "name": "space",
578
+ "as": {
579
+ "description": "name for the initial add-on attachment",
580
+ "name": "as",
562
581
  "hasDynamicHelp": false,
563
582
  "multiple": false,
564
583
  "type": "option"
565
584
  },
566
- "region": {
567
- "description": "specify region for the app to run in",
568
- "name": "region",
585
+ "confirm": {
586
+ "description": "overwrite existing config vars or existing add-on attachments",
587
+ "name": "confirm",
569
588
  "hasDynamicHelp": false,
570
589
  "multiple": false,
571
590
  "type": "option"
572
591
  },
573
- "internal-routing": {
574
- "description": "private space-only. create as an Internal Web App that is only routable in the local network.",
575
- "hidden": true,
576
- "name": "internal-routing",
592
+ "wait": {
593
+ "description": "watch add-on creation status and exit when complete",
594
+ "name": "wait",
577
595
  "allowNo": false,
578
596
  "type": "boolean"
579
597
  },
580
- "features": {
581
- "hidden": true,
582
- "name": "features",
583
- "hasDynamicHelp": false,
584
- "multiple": false,
585
- "type": "option"
586
- },
587
- "kernel": {
588
- "hidden": true,
589
- "name": "kernel",
598
+ "app": {
599
+ "char": "a",
600
+ "description": "app to run command against",
601
+ "name": "app",
602
+ "required": true,
590
603
  "hasDynamicHelp": false,
591
604
  "multiple": false,
592
605
  "type": "option"
593
606
  },
594
- "locked": {
595
- "hidden": true,
596
- "name": "locked",
597
- "allowNo": false,
598
- "type": "boolean"
599
- },
600
- "json": {
601
- "description": "output in json format",
602
- "name": "json",
603
- "allowNo": false,
604
- "type": "boolean"
605
- },
606
- "team": {
607
- "char": "t",
608
- "description": "team to use",
609
- "name": "team",
607
+ "remote": {
608
+ "char": "r",
609
+ "description": "git remote of app to use",
610
+ "name": "remote",
610
611
  "hasDynamicHelp": false,
611
612
  "multiple": false,
612
613
  "type": "option"
@@ -614,31 +615,57 @@
614
615
  },
615
616
  "hasDynamicHelp": false,
616
617
  "hiddenAliases": [
617
- "create"
618
+ "addons:add"
618
619
  ],
619
- "id": "apps:create",
620
+ "id": "addons:create",
620
621
  "pluginAlias": "heroku",
621
622
  "pluginName": "heroku",
622
623
  "pluginType": "core",
623
- "strict": true,
624
+ "strict": false,
625
+ "topic": "addons",
626
+ "example": "Create an add-on resource:\n$heroku addons:create heroku-redis --app my-app\n\nCreate an add-on resource with additional config items:\n$heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE\n",
624
627
  "isESM": false,
625
628
  "relativePath": [
626
629
  "lib",
627
630
  "commands",
628
- "apps",
631
+ "addons",
629
632
  "create.js"
630
633
  ]
631
634
  },
632
- "apps:destroy": {
635
+ "addons:destroy": {
633
636
  "aliases": [],
634
637
  "args": {
635
- "app": {
636
- "hidden": true,
637
- "name": "app"
638
+ "addonName": {
639
+ "description": "unique identifier or globally unique name of the add-on",
640
+ "name": "addonName",
641
+ "required": true
638
642
  }
639
643
  },
640
- "description": "permanently destroy an app",
644
+ "description": "permanently destroy an add-on resource",
645
+ "examples": [
646
+ "addons:destroy [ADDON]... [flags]"
647
+ ],
641
648
  "flags": {
649
+ "force": {
650
+ "char": "f",
651
+ "description": "allow destruction even if connected to other apps",
652
+ "name": "force",
653
+ "allowNo": false,
654
+ "type": "boolean"
655
+ },
656
+ "confirm": {
657
+ "char": "c",
658
+ "name": "confirm",
659
+ "hasDynamicHelp": false,
660
+ "multiple": false,
661
+ "type": "option"
662
+ },
663
+ "wait": {
664
+ "description": "watch add-on destruction status and exit when complete",
665
+ "name": "wait",
666
+ "allowNo": false,
667
+ "type": "boolean"
668
+ },
642
669
  "app": {
643
670
  "char": "a",
644
671
  "description": "app to run command against",
@@ -654,38 +681,36 @@
654
681
  "hasDynamicHelp": false,
655
682
  "multiple": false,
656
683
  "type": "option"
657
- },
658
- "confirm": {
659
- "char": "c",
660
- "name": "confirm",
661
- "hasDynamicHelp": false,
662
- "multiple": false,
663
- "type": "option"
664
684
  }
665
685
  },
666
686
  "hasDynamicHelp": false,
667
687
  "hiddenAliases": [
668
- "destroy",
669
- "apps:delete"
688
+ "addons:remove"
670
689
  ],
671
- "id": "apps:destroy",
690
+ "id": "addons:destroy",
672
691
  "pluginAlias": "heroku",
673
692
  "pluginName": "heroku",
674
693
  "pluginType": "core",
675
- "strict": true,
676
- "help": "This will also destroy all add-ons on the app.",
694
+ "strict": false,
695
+ "topic": "addons",
677
696
  "isESM": false,
678
697
  "relativePath": [
679
698
  "lib",
680
699
  "commands",
681
- "apps",
700
+ "addons",
682
701
  "destroy.js"
683
702
  ]
684
703
  },
685
- "apps:errors": {
704
+ "addons:detach": {
686
705
  "aliases": [],
687
- "args": {},
688
- "description": "view app errors",
706
+ "args": {
707
+ "attachment_name": {
708
+ "description": "unique identifier of the add-on attachment",
709
+ "name": "attachment_name",
710
+ "required": true
711
+ }
712
+ },
713
+ "description": "detach an existing add-on resource from an app",
689
714
  "flags": {
690
715
  "app": {
691
716
  "char": "a",
@@ -703,205 +728,100 @@
703
728
  "hasDynamicHelp": false,
704
729
  "multiple": false,
705
730
  "type": "option"
706
- },
707
- "json": {
708
- "description": "output in json format",
709
- "name": "json",
710
- "allowNo": false,
711
- "type": "boolean"
712
- },
713
- "hours": {
714
- "description": "number of hours to look back (default 24)",
715
- "name": "hours",
716
- "default": "24",
717
- "hasDynamicHelp": false,
718
- "multiple": false,
719
- "type": "option"
720
- },
721
- "router": {
722
- "description": "show only router errors",
723
- "name": "router",
724
- "allowNo": false,
725
- "type": "boolean"
726
- },
727
- "dyno": {
728
- "description": "show only dyno errors",
729
- "name": "dyno",
730
- "allowNo": false,
731
- "type": "boolean"
732
731
  }
733
732
  },
734
733
  "hasDynamicHelp": false,
735
734
  "hiddenAliases": [],
736
- "id": "apps:errors",
735
+ "id": "addons:detach",
737
736
  "pluginAlias": "heroku",
738
737
  "pluginName": "heroku",
739
738
  "pluginType": "core",
740
739
  "strict": true,
740
+ "topic": "addons",
741
741
  "isESM": false,
742
742
  "relativePath": [
743
743
  "lib",
744
744
  "commands",
745
- "apps",
746
- "errors.js"
745
+ "addons",
746
+ "detach.js"
747
747
  ]
748
748
  },
749
- "apps": {
749
+ "addons:docs": {
750
750
  "aliases": [],
751
- "args": {},
752
- "description": "list your apps",
753
- "examples": [
754
- "$ heroku apps"
755
- ],
751
+ "args": {
752
+ "addon": {
753
+ "description": "unique identifier or globally unique name of the add-on",
754
+ "name": "addon",
755
+ "required": true
756
+ }
757
+ },
758
+ "description": "open an add-on's Dev Center documentation in your browser",
756
759
  "flags": {
757
- "all": {
758
- "char": "A",
759
- "description": "include apps in all teams",
760
- "name": "all",
761
- "allowNo": false,
762
- "type": "boolean"
763
- },
764
- "json": {
765
- "char": "j",
766
- "description": "output in json format",
767
- "name": "json",
760
+ "show-url": {
761
+ "description": "show URL, do not open browser",
762
+ "name": "show-url",
768
763
  "allowNo": false,
769
764
  "type": "boolean"
770
765
  },
771
- "space": {
772
- "char": "s",
773
- "description": "filter by space",
774
- "name": "space",
766
+ "app": {
767
+ "char": "a",
768
+ "description": "app to run command against",
769
+ "name": "app",
775
770
  "hasDynamicHelp": false,
776
771
  "multiple": false,
777
772
  "type": "option"
778
773
  },
779
- "personal": {
780
- "char": "p",
781
- "description": "list apps in personal account when a default team is set",
782
- "name": "personal",
783
- "allowNo": false,
784
- "type": "boolean"
785
- },
786
- "internal-routing": {
787
- "char": "i",
788
- "description": "filter to Internal Web Apps",
789
- "hidden": true,
790
- "name": "internal-routing",
791
- "allowNo": false,
792
- "type": "boolean"
793
- },
794
- "team": {
795
- "char": "t",
796
- "description": "team to use",
797
- "name": "team",
774
+ "remote": {
775
+ "char": "r",
776
+ "description": "git remote of app to use",
777
+ "name": "remote",
798
778
  "hasDynamicHelp": false,
799
779
  "multiple": false,
800
780
  "type": "option"
801
781
  }
802
782
  },
803
783
  "hasDynamicHelp": false,
804
- "hiddenAliases": [
805
- "list",
806
- "apps:list"
807
- ],
808
- "id": "apps",
784
+ "hiddenAliases": [],
785
+ "id": "addons:docs",
809
786
  "pluginAlias": "heroku",
810
787
  "pluginName": "heroku",
811
788
  "pluginType": "core",
812
789
  "strict": true,
813
- "topic": "apps",
790
+ "topic": "addons",
814
791
  "isESM": false,
815
792
  "relativePath": [
816
793
  "lib",
817
794
  "commands",
818
- "apps",
819
- "index.js"
795
+ "addons",
796
+ "docs.js"
820
797
  ]
821
798
  },
822
- "apps:info": {
799
+ "addons": {
823
800
  "aliases": [],
824
- "args": {
825
- "app": {
826
- "hidden": true,
827
- "name": "app"
828
- }
829
- },
830
- "description": "show detailed app information",
801
+ "args": {},
802
+ "description": "Lists your add-ons and attachments.\n\n The default filter applied depends on whether you are in a Heroku app\n directory. If so, the --app flag is implied. If not, the default of --all\n is implied. Explicitly providing either flag overrides the default\n behavior.\n ",
831
803
  "examples": [
832
- "$ heroku apps:info",
833
- "$ heroku apps:info --shell"
804
+ "$ heroku addons --all",
805
+ "$ heroku addons --app acme-inc-www"
834
806
  ],
835
807
  "flags": {
836
- "app": {
837
- "char": "a",
838
- "description": "app to run command against",
839
- "name": "app",
840
- "hasDynamicHelp": false,
841
- "multiple": false,
842
- "type": "option"
843
- },
844
- "remote": {
845
- "char": "r",
846
- "description": "git remote of app to use",
847
- "name": "remote",
848
- "hasDynamicHelp": false,
849
- "multiple": false,
850
- "type": "option"
851
- },
852
- "shell": {
853
- "char": "s",
854
- "description": "output more shell friendly key/value pairs",
855
- "name": "shell",
856
- "allowNo": false,
857
- "type": "boolean"
858
- },
859
- "extended": {
860
- "char": "x",
861
- "hidden": true,
862
- "name": "extended",
808
+ "all": {
809
+ "char": "A",
810
+ "description": "show add-ons and attachments for all accessible apps",
811
+ "name": "all",
863
812
  "allowNo": false,
864
813
  "type": "boolean"
865
814
  },
866
815
  "json": {
867
- "char": "j",
868
- "description": "output in json format",
816
+ "description": "return add-ons in json format",
869
817
  "name": "json",
870
818
  "allowNo": false,
871
819
  "type": "boolean"
872
- }
873
- },
874
- "hasDynamicHelp": false,
875
- "hiddenAliases": [
876
- "info"
877
- ],
878
- "id": "apps:info",
879
- "pluginAlias": "heroku",
880
- "pluginName": "heroku",
881
- "pluginType": "core",
882
- "strict": true,
883
- "topic": "apps",
884
- "help": "$ heroku apps:info\n=== example\nGit URL: https://git.heroku.com/example.git\nRepo Size: 5M\n...\n\n$ heroku apps:info --shell\ngit_url=https://git.heroku.com/example.git\nrepo_size=5000000\n...",
885
- "isESM": false,
886
- "relativePath": [
887
- "lib",
888
- "commands",
889
- "apps",
890
- "info.js"
891
- ]
892
- },
893
- "apps:join": {
894
- "aliases": [
895
- "join"
896
- ],
897
- "args": {},
898
- "description": "add yourself to a team app",
899
- "flags": {
820
+ },
900
821
  "app": {
901
822
  "char": "a",
902
823
  "description": "app to run command against",
903
824
  "name": "app",
904
- "required": true,
905
825
  "hasDynamicHelp": false,
906
826
  "multiple": false,
907
827
  "type": "option"
@@ -917,33 +837,36 @@
917
837
  },
918
838
  "hasDynamicHelp": false,
919
839
  "hiddenAliases": [],
920
- "id": "apps:join",
840
+ "id": "addons",
921
841
  "pluginAlias": "heroku",
922
842
  "pluginName": "heroku",
923
843
  "pluginType": "core",
924
844
  "strict": true,
925
- "topic": "apps",
845
+ "usage": "addons [--all|--app APP]",
846
+ "topic": "addons",
926
847
  "isESM": false,
927
848
  "relativePath": [
928
849
  "lib",
929
850
  "commands",
930
- "apps",
931
- "join.js"
851
+ "addons",
852
+ "index.js"
932
853
  ]
933
854
  },
934
- "apps:leave": {
935
- "aliases": [
936
- "leave"
937
- ],
938
- "args": {},
939
- "description": "remove yourself from a team app",
940
- "examples": "heroku apps:leave -a APP",
855
+ "addons:info": {
856
+ "aliases": [],
857
+ "args": {
858
+ "addon": {
859
+ "description": "unique identifier or globally unique name of the add-on",
860
+ "name": "addon",
861
+ "required": true
862
+ }
863
+ },
864
+ "description": "show detailed add-on resource and attachment information",
941
865
  "flags": {
942
866
  "app": {
943
867
  "char": "a",
944
868
  "description": "app to run command against",
945
869
  "name": "app",
946
- "required": true,
947
870
  "hasDynamicHelp": false,
948
871
  "multiple": false,
949
872
  "type": "option"
@@ -959,33 +882,42 @@
959
882
  },
960
883
  "hasDynamicHelp": false,
961
884
  "hiddenAliases": [],
962
- "id": "apps:leave",
885
+ "id": "addons:info",
963
886
  "pluginAlias": "heroku",
964
887
  "pluginName": "heroku",
965
888
  "pluginType": "core",
966
889
  "strict": true,
967
- "topic": "apps",
968
- "example": "heroku apps:leave -a APP",
890
+ "usage": "addons:info ADDON",
891
+ "topic": "addons",
969
892
  "isESM": false,
970
893
  "relativePath": [
971
894
  "lib",
972
895
  "commands",
973
- "apps",
974
- "leave.js"
896
+ "addons",
897
+ "info.js"
975
898
  ]
976
899
  },
977
- "apps:lock": {
978
- "aliases": [
979
- "lock"
980
- ],
981
- "args": {},
982
- "description": "prevent team members from joining an app",
900
+ "addons:open": {
901
+ "aliases": [],
902
+ "args": {
903
+ "addon": {
904
+ "description": "unique identifier or globally unique name of the add-on",
905
+ "name": "addon",
906
+ "required": true
907
+ }
908
+ },
909
+ "description": "open an add-on's dashboard in your browser",
983
910
  "flags": {
911
+ "show-url": {
912
+ "description": "show URL, do not open browser",
913
+ "name": "show-url",
914
+ "allowNo": false,
915
+ "type": "boolean"
916
+ },
984
917
  "app": {
985
918
  "char": "a",
986
919
  "description": "app to run command against",
987
920
  "name": "app",
988
- "required": true,
989
921
  "hasDynamicHelp": false,
990
922
  "multiple": false,
991
923
  "type": "option"
@@ -1001,149 +933,134 @@
1001
933
  },
1002
934
  "hasDynamicHelp": false,
1003
935
  "hiddenAliases": [],
1004
- "id": "apps:lock",
936
+ "id": "addons:open",
1005
937
  "pluginAlias": "heroku",
1006
938
  "pluginName": "heroku",
1007
939
  "pluginType": "core",
1008
940
  "strict": true,
1009
- "topic": "apps",
941
+ "topic": "addons",
1010
942
  "isESM": false,
1011
943
  "relativePath": [
1012
944
  "lib",
1013
945
  "commands",
1014
- "apps",
1015
- "lock.js"
946
+ "addons",
947
+ "open.js"
1016
948
  ]
1017
949
  },
1018
- "apps:open": {
950
+ "addons:plans": {
1019
951
  "aliases": [],
1020
952
  "args": {
1021
- "path": {
1022
- "name": "path",
1023
- "required": false
953
+ "service": {
954
+ "description": "unique identifier or globally unique name of the add-on",
955
+ "name": "service",
956
+ "required": true
1024
957
  }
1025
958
  },
1026
- "description": "open the app in a web browser",
1027
- "examples": [
1028
- "$ heroku open -a myapp",
1029
- "$ heroku open -a myapp /foo"
1030
- ],
959
+ "description": "list all available plans for an add-on service",
1031
960
  "flags": {
1032
- "app": {
1033
- "char": "a",
1034
- "description": "app to run command against",
1035
- "name": "app",
1036
- "required": true,
1037
- "hasDynamicHelp": false,
1038
- "multiple": false,
1039
- "type": "option"
1040
- },
1041
- "remote": {
1042
- "char": "r",
1043
- "description": "git remote of app to use",
1044
- "name": "remote",
1045
- "hasDynamicHelp": false,
1046
- "multiple": false,
1047
- "type": "option"
961
+ "json": {
962
+ "description": "output in json format",
963
+ "name": "json",
964
+ "allowNo": false,
965
+ "type": "boolean"
1048
966
  }
1049
967
  },
1050
968
  "hasDynamicHelp": false,
1051
- "hiddenAliases": [
1052
- "open"
1053
- ],
1054
- "id": "apps:open",
969
+ "hiddenAliases": [],
970
+ "id": "addons:plans",
1055
971
  "pluginAlias": "heroku",
1056
972
  "pluginName": "heroku",
1057
973
  "pluginType": "core",
1058
974
  "strict": true,
1059
- "topic": "apps",
975
+ "topic": "addons",
1060
976
  "isESM": false,
1061
977
  "relativePath": [
1062
978
  "lib",
1063
979
  "commands",
1064
- "apps",
1065
- "open.js"
980
+ "addons",
981
+ "plans.js"
1066
982
  ]
1067
983
  },
1068
- "apps:rename": {
984
+ "addons:rename": {
1069
985
  "aliases": [],
1070
986
  "args": {
1071
- "newname": {
1072
- "name": "newname",
987
+ "addon_name": {
988
+ "description": "unique identifier or globally unique name of the add-on",
989
+ "name": "addon_name",
1073
990
  "required": true
1074
- }
1075
- },
1076
- "description": "rename an app",
1077
- "examples": [
1078
- "$ heroku apps:rename --app oldname newname"
1079
- ],
1080
- "flags": {
1081
- "app": {
1082
- "char": "a",
1083
- "description": "app to run command against",
1084
- "name": "app",
1085
- "required": true,
1086
- "hasDynamicHelp": false,
1087
- "multiple": false,
1088
- "type": "option"
1089
991
  },
1090
- "remote": {
1091
- "char": "r",
1092
- "description": "git remote of app to use",
1093
- "name": "remote",
1094
- "hasDynamicHelp": false,
1095
- "multiple": false,
1096
- "type": "option"
992
+ "new_name": {
993
+ "description": "new globally unique name of the add-on",
994
+ "name": "new_name",
995
+ "required": true
1097
996
  }
1098
997
  },
998
+ "description": "rename an add-on",
999
+ "flags": {},
1099
1000
  "hasDynamicHelp": false,
1100
- "hiddenAliases": [
1101
- "rename"
1102
- ],
1103
- "id": "apps:rename",
1001
+ "hiddenAliases": [],
1002
+ "id": "addons:rename",
1104
1003
  "pluginAlias": "heroku",
1105
1004
  "pluginName": "heroku",
1106
1005
  "pluginType": "core",
1107
1006
  "strict": true,
1108
- "help": "This will locally update the git remote if it is set to the old app.",
1109
- "topic": "apps",
1007
+ "topic": "addons",
1110
1008
  "isESM": false,
1111
1009
  "relativePath": [
1112
1010
  "lib",
1113
1011
  "commands",
1114
- "apps",
1012
+ "addons",
1115
1013
  "rename.js"
1116
1014
  ]
1117
1015
  },
1118
- "apps:transfer": {
1016
+ "addons:services": {
1119
1017
  "aliases": [],
1018
+ "args": {},
1019
+ "description": "list all available add-on services",
1020
+ "flags": {
1021
+ "json": {
1022
+ "description": "output in json format",
1023
+ "name": "json",
1024
+ "allowNo": false,
1025
+ "type": "boolean"
1026
+ }
1027
+ },
1028
+ "hasDynamicHelp": false,
1029
+ "hiddenAliases": [],
1030
+ "id": "addons:services",
1031
+ "pluginAlias": "heroku",
1032
+ "pluginName": "heroku",
1033
+ "pluginType": "core",
1034
+ "strict": true,
1035
+ "topic": "addons",
1036
+ "isESM": false,
1037
+ "relativePath": [
1038
+ "lib",
1039
+ "commands",
1040
+ "addons",
1041
+ "services.js"
1042
+ ]
1043
+ },
1044
+ "addons:upgrade": {
1045
+ "aliases": [
1046
+ "addons:downgrade"
1047
+ ],
1120
1048
  "args": {
1121
- "recipient": {
1122
- "description": "user or team to transfer applications to",
1123
- "name": "recipient",
1049
+ "addon": {
1050
+ "description": "unique identifier or globally unique name of the add-on",
1051
+ "name": "addon",
1124
1052
  "required": true
1053
+ },
1054
+ "plan": {
1055
+ "description": "unique identifier or name of the plan",
1056
+ "name": "plan"
1125
1057
  }
1126
1058
  },
1127
- "description": "transfer applications to another user or team",
1059
+ "description": "change add-on plan.\n See available plans with `heroku addons:plans SERVICE`.\n\n Note that `heroku addons:upgrade` and `heroku addons:downgrade` are the same. Either one can be used to change an add-on plan up or down.\n\n https://devcenter.heroku.com/articles/managing-add-ons\n ",
1128
1060
  "examples": [
1129
- "$ heroku apps:transfer collaborator@example.com\nTransferring example to collaborator@example.com... done\n\n$ heroku apps:transfer acme-widgets\nTransferring example to acme-widgets... done\n\n$ heroku apps:transfer --bulk acme-widgets\n..."
1061
+ "Upgrade an add-on by service name:\n$ heroku addons:upgrade heroku-redis:premium-2\n\nUpgrade a specific add-on:\n$ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2"
1130
1062
  ],
1131
1063
  "flags": {
1132
- "locked": {
1133
- "char": "l",
1134
- "description": "lock the app upon transfer",
1135
- "name": "locked",
1136
- "required": false,
1137
- "allowNo": false,
1138
- "type": "boolean"
1139
- },
1140
- "bulk": {
1141
- "description": "transfer applications in bulk",
1142
- "name": "bulk",
1143
- "required": false,
1144
- "allowNo": false,
1145
- "type": "boolean"
1146
- },
1147
1064
  "app": {
1148
1065
  "char": "a",
1149
1066
  "description": "app to run command against",
@@ -1159,44 +1076,45 @@
1159
1076
  "hasDynamicHelp": false,
1160
1077
  "multiple": false,
1161
1078
  "type": "option"
1162
- },
1163
- "confirm": {
1164
- "char": "c",
1165
- "hidden": true,
1166
- "name": "confirm",
1167
- "hasDynamicHelp": false,
1168
- "multiple": false,
1169
- "type": "option"
1170
1079
  }
1171
1080
  },
1172
1081
  "hasDynamicHelp": false,
1173
1082
  "hiddenAliases": [],
1174
- "id": "apps:transfer",
1083
+ "id": "addons:upgrade",
1175
1084
  "pluginAlias": "heroku",
1176
1085
  "pluginName": "heroku",
1177
1086
  "pluginType": "core",
1178
1087
  "strict": true,
1179
- "topic": "apps",
1088
+ "topic": "addons",
1180
1089
  "isESM": false,
1181
1090
  "relativePath": [
1182
1091
  "lib",
1183
1092
  "commands",
1184
- "apps",
1185
- "transfer.js"
1093
+ "addons",
1094
+ "upgrade.js"
1186
1095
  ]
1187
1096
  },
1188
- "apps:unlock": {
1189
- "aliases": [
1190
- "unlock"
1191
- ],
1192
- "args": {},
1193
- "description": "unlock an app so any team member can join",
1097
+ "addons:wait": {
1098
+ "aliases": [],
1099
+ "args": {
1100
+ "addon": {
1101
+ "description": "unique identifier or globally unique name of the add-on",
1102
+ "name": "addon"
1103
+ }
1104
+ },
1105
+ "description": "show provisioning status of the add-ons on the app",
1194
1106
  "flags": {
1107
+ "wait-interval": {
1108
+ "description": "how frequently to poll in seconds",
1109
+ "name": "wait-interval",
1110
+ "hasDynamicHelp": false,
1111
+ "multiple": false,
1112
+ "type": "option"
1113
+ },
1195
1114
  "app": {
1196
1115
  "char": "a",
1197
1116
  "description": "app to run command against",
1198
1117
  "name": "app",
1199
- "required": true,
1200
1118
  "hasDynamicHelp": false,
1201
1119
  "multiple": false,
1202
1120
  "type": "option"
@@ -1212,123 +1130,219 @@
1212
1130
  },
1213
1131
  "hasDynamicHelp": false,
1214
1132
  "hiddenAliases": [],
1215
- "id": "apps:unlock",
1133
+ "id": "addons:wait",
1216
1134
  "pluginAlias": "heroku",
1217
1135
  "pluginName": "heroku",
1218
1136
  "pluginType": "core",
1219
1137
  "strict": true,
1220
- "topic": "apps",
1138
+ "topic": "addons",
1221
1139
  "isESM": false,
1222
1140
  "relativePath": [
1223
1141
  "lib",
1224
1142
  "commands",
1225
- "apps",
1226
- "unlock.js"
1143
+ "addons",
1144
+ "wait.js"
1227
1145
  ]
1228
1146
  },
1229
- "addons:attach": {
1147
+ "apps:create": {
1230
1148
  "aliases": [],
1231
1149
  "args": {
1232
- "addon_name": {
1233
- "name": "addon_name",
1234
- "required": true
1150
+ "app": {
1151
+ "description": "name of app to create",
1152
+ "name": "app",
1153
+ "required": false
1235
1154
  }
1236
1155
  },
1237
- "description": "attach an existing add-on resource to an app",
1156
+ "description": "creates a new app",
1157
+ "examples": [
1158
+ "$ heroku apps:create\nCreating app... done, stack is heroku-24\nhttps://floating-dragon-42.heroku.com/ | https://git.heroku.com/floating-dragon-42.git\n\n# or just\n$ heroku create\n\n# use a heroku.yml manifest file\n$ heroku apps:create --manifest\n\n# specify a buildpack\n$ heroku apps:create --buildpack https://github.com/some/buildpack.git\n\n# specify a name\n$ heroku apps:create example\n\n# create a staging app\n$ heroku apps:create example-staging --remote staging\n\n# create an app in the eu region\n$ heroku apps:create --region eu"
1159
+ ],
1238
1160
  "flags": {
1239
- "as": {
1240
- "description": "name for add-on attachment",
1241
- "name": "as",
1161
+ "app": {
1162
+ "hidden": true,
1163
+ "name": "app",
1242
1164
  "hasDynamicHelp": false,
1243
1165
  "multiple": false,
1244
1166
  "type": "option"
1245
1167
  },
1246
- "credential": {
1247
- "description": "credential name for scoped access to Heroku Postgres",
1248
- "name": "credential",
1168
+ "addons": {
1169
+ "description": "comma-delimited list of addons to install",
1170
+ "name": "addons",
1249
1171
  "hasDynamicHelp": false,
1250
1172
  "multiple": false,
1251
1173
  "type": "option"
1252
1174
  },
1253
- "confirm": {
1254
- "description": "overwrite existing add-on attachment with same name",
1255
- "name": "confirm",
1175
+ "buildpack": {
1176
+ "char": "b",
1177
+ "description": "buildpack url to use for this app",
1178
+ "name": "buildpack",
1256
1179
  "hasDynamicHelp": false,
1257
1180
  "multiple": false,
1258
1181
  "type": "option"
1259
1182
  },
1260
- "app": {
1261
- "char": "a",
1262
- "description": "app to run command against",
1263
- "name": "app",
1264
- "required": true,
1265
- "hasDynamicHelp": false,
1266
- "multiple": false,
1267
- "type": "option"
1183
+ "manifest": {
1184
+ "char": "m",
1185
+ "description": "use heroku.yml settings for this app",
1186
+ "hidden": true,
1187
+ "name": "manifest",
1188
+ "allowNo": false,
1189
+ "type": "boolean"
1190
+ },
1191
+ "no-remote": {
1192
+ "char": "n",
1193
+ "description": "do not create a git remote",
1194
+ "name": "no-remote",
1195
+ "allowNo": false,
1196
+ "type": "boolean"
1268
1197
  },
1269
1198
  "remote": {
1270
1199
  "char": "r",
1271
- "description": "git remote of app to use",
1200
+ "description": "the git remote to create, default \"heroku\"",
1272
1201
  "name": "remote",
1202
+ "default": "heroku",
1203
+ "hasDynamicHelp": false,
1204
+ "multiple": false,
1205
+ "type": "option"
1206
+ },
1207
+ "stack": {
1208
+ "char": "s",
1209
+ "description": "the stack to create the app on",
1210
+ "name": "stack",
1211
+ "hasDynamicHelp": false,
1212
+ "multiple": false,
1213
+ "type": "option"
1214
+ },
1215
+ "space": {
1216
+ "description": "the private space to create the app in",
1217
+ "name": "space",
1218
+ "hasDynamicHelp": false,
1219
+ "multiple": false,
1220
+ "type": "option"
1221
+ },
1222
+ "region": {
1223
+ "description": "specify region for the app to run in",
1224
+ "name": "region",
1225
+ "hasDynamicHelp": false,
1226
+ "multiple": false,
1227
+ "type": "option"
1228
+ },
1229
+ "internal-routing": {
1230
+ "description": "private space-only. create as an Internal Web App that is only routable in the local network.",
1231
+ "hidden": true,
1232
+ "name": "internal-routing",
1233
+ "allowNo": false,
1234
+ "type": "boolean"
1235
+ },
1236
+ "features": {
1237
+ "hidden": true,
1238
+ "name": "features",
1239
+ "hasDynamicHelp": false,
1240
+ "multiple": false,
1241
+ "type": "option"
1242
+ },
1243
+ "kernel": {
1244
+ "hidden": true,
1245
+ "name": "kernel",
1246
+ "hasDynamicHelp": false,
1247
+ "multiple": false,
1248
+ "type": "option"
1249
+ },
1250
+ "locked": {
1251
+ "hidden": true,
1252
+ "name": "locked",
1253
+ "allowNo": false,
1254
+ "type": "boolean"
1255
+ },
1256
+ "json": {
1257
+ "description": "output in json format",
1258
+ "name": "json",
1259
+ "allowNo": false,
1260
+ "type": "boolean"
1261
+ },
1262
+ "team": {
1263
+ "char": "t",
1264
+ "description": "team to use",
1265
+ "name": "team",
1273
1266
  "hasDynamicHelp": false,
1274
1267
  "multiple": false,
1275
1268
  "type": "option"
1276
1269
  }
1277
1270
  },
1278
1271
  "hasDynamicHelp": false,
1279
- "hiddenAliases": [],
1280
- "id": "addons:attach",
1272
+ "hiddenAliases": [
1273
+ "create"
1274
+ ],
1275
+ "id": "apps:create",
1281
1276
  "pluginAlias": "heroku",
1282
1277
  "pluginName": "heroku",
1283
1278
  "pluginType": "core",
1284
1279
  "strict": true,
1285
- "topic": "addons",
1286
1280
  "isESM": false,
1287
1281
  "relativePath": [
1288
1282
  "lib",
1289
1283
  "commands",
1290
- "addons",
1291
- "attach.js"
1284
+ "apps",
1285
+ "create.js"
1292
1286
  ]
1293
1287
  },
1294
- "addons:create": {
1288
+ "apps:destroy": {
1295
1289
  "aliases": [],
1296
1290
  "args": {
1297
- "service:plan": {
1298
- "name": "service:plan",
1299
- "required": true
1291
+ "app": {
1292
+ "hidden": true,
1293
+ "name": "app"
1300
1294
  }
1301
1295
  },
1302
- "description": "Create a new add-on resource.\n\nIn order to add additional config items, please place them at the end of the command after a double-dash (--).\n",
1303
- "examples": "Create an add-on resource:\n$heroku addons:create heroku-redis --app my-app\n\nCreate an add-on resource with additional config items:\n$heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE\n",
1296
+ "description": "permanently destroy an app",
1304
1297
  "flags": {
1305
- "name": {
1306
- "description": "name for the add-on resource",
1307
- "name": "name",
1298
+ "app": {
1299
+ "char": "a",
1300
+ "description": "app to run command against",
1301
+ "name": "app",
1308
1302
  "hasDynamicHelp": false,
1309
1303
  "multiple": false,
1310
1304
  "type": "option"
1311
1305
  },
1312
- "as": {
1313
- "description": "name for the initial add-on attachment",
1314
- "name": "as",
1306
+ "remote": {
1307
+ "char": "r",
1308
+ "description": "git remote of app to use",
1309
+ "name": "remote",
1315
1310
  "hasDynamicHelp": false,
1316
1311
  "multiple": false,
1317
1312
  "type": "option"
1318
1313
  },
1319
1314
  "confirm": {
1320
- "description": "overwrite existing config vars or existing add-on attachments",
1315
+ "char": "c",
1321
1316
  "name": "confirm",
1322
1317
  "hasDynamicHelp": false,
1323
1318
  "multiple": false,
1324
1319
  "type": "option"
1325
- },
1326
- "wait": {
1327
- "description": "watch add-on creation status and exit when complete",
1328
- "name": "wait",
1329
- "allowNo": false,
1330
- "type": "boolean"
1331
- },
1320
+ }
1321
+ },
1322
+ "hasDynamicHelp": false,
1323
+ "hiddenAliases": [
1324
+ "destroy",
1325
+ "apps:delete"
1326
+ ],
1327
+ "id": "apps:destroy",
1328
+ "pluginAlias": "heroku",
1329
+ "pluginName": "heroku",
1330
+ "pluginType": "core",
1331
+ "strict": true,
1332
+ "help": "This will also destroy all add-ons on the app.",
1333
+ "isESM": false,
1334
+ "relativePath": [
1335
+ "lib",
1336
+ "commands",
1337
+ "apps",
1338
+ "destroy.js"
1339
+ ]
1340
+ },
1341
+ "apps:errors": {
1342
+ "aliases": [],
1343
+ "args": {},
1344
+ "description": "view app errors",
1345
+ "flags": {
1332
1346
  "app": {
1333
1347
  "char": "a",
1334
1348
  "description": "app to run command against",
@@ -1345,72 +1359,98 @@
1345
1359
  "hasDynamicHelp": false,
1346
1360
  "multiple": false,
1347
1361
  "type": "option"
1362
+ },
1363
+ "json": {
1364
+ "description": "output in json format",
1365
+ "name": "json",
1366
+ "allowNo": false,
1367
+ "type": "boolean"
1368
+ },
1369
+ "hours": {
1370
+ "description": "number of hours to look back (default 24)",
1371
+ "name": "hours",
1372
+ "default": "24",
1373
+ "hasDynamicHelp": false,
1374
+ "multiple": false,
1375
+ "type": "option"
1376
+ },
1377
+ "router": {
1378
+ "description": "show only router errors",
1379
+ "name": "router",
1380
+ "allowNo": false,
1381
+ "type": "boolean"
1382
+ },
1383
+ "dyno": {
1384
+ "description": "show only dyno errors",
1385
+ "name": "dyno",
1386
+ "allowNo": false,
1387
+ "type": "boolean"
1348
1388
  }
1349
1389
  },
1350
1390
  "hasDynamicHelp": false,
1351
- "hiddenAliases": [
1352
- "addons:add"
1353
- ],
1354
- "id": "addons:create",
1391
+ "hiddenAliases": [],
1392
+ "id": "apps:errors",
1355
1393
  "pluginAlias": "heroku",
1356
1394
  "pluginName": "heroku",
1357
1395
  "pluginType": "core",
1358
- "strict": false,
1359
- "topic": "addons",
1360
- "example": "Create an add-on resource:\n$heroku addons:create heroku-redis --app my-app\n\nCreate an add-on resource with additional config items:\n$heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE\n",
1396
+ "strict": true,
1361
1397
  "isESM": false,
1362
1398
  "relativePath": [
1363
1399
  "lib",
1364
1400
  "commands",
1365
- "addons",
1366
- "create.js"
1401
+ "apps",
1402
+ "errors.js"
1367
1403
  ]
1368
1404
  },
1369
- "addons:destroy": {
1405
+ "apps": {
1370
1406
  "aliases": [],
1371
- "args": {
1372
- "addonName": {
1373
- "name": "addonName",
1374
- "required": true
1375
- }
1376
- },
1377
- "description": "permanently destroy an add-on resource",
1407
+ "args": {},
1408
+ "description": "list your apps",
1378
1409
  "examples": [
1379
- "addons:destroy [ADDON]... [flags]"
1410
+ "$ heroku apps"
1380
1411
  ],
1381
1412
  "flags": {
1382
- "force": {
1383
- "char": "f",
1384
- "description": "allow destruction even if connected to other apps",
1385
- "name": "force",
1413
+ "all": {
1414
+ "char": "A",
1415
+ "description": "include apps in all teams",
1416
+ "name": "all",
1386
1417
  "allowNo": false,
1387
1418
  "type": "boolean"
1388
1419
  },
1389
- "confirm": {
1390
- "char": "c",
1391
- "name": "confirm",
1420
+ "json": {
1421
+ "char": "j",
1422
+ "description": "output in json format",
1423
+ "name": "json",
1424
+ "allowNo": false,
1425
+ "type": "boolean"
1426
+ },
1427
+ "space": {
1428
+ "char": "s",
1429
+ "description": "filter by space",
1430
+ "name": "space",
1392
1431
  "hasDynamicHelp": false,
1393
1432
  "multiple": false,
1394
1433
  "type": "option"
1395
1434
  },
1396
- "wait": {
1397
- "description": "watch add-on destruction status and exit when complete",
1398
- "name": "wait",
1435
+ "personal": {
1436
+ "char": "p",
1437
+ "description": "list apps in personal account when a default team is set",
1438
+ "name": "personal",
1399
1439
  "allowNo": false,
1400
1440
  "type": "boolean"
1401
1441
  },
1402
- "app": {
1403
- "char": "a",
1404
- "description": "app to run command against",
1405
- "name": "app",
1406
- "hasDynamicHelp": false,
1407
- "multiple": false,
1408
- "type": "option"
1442
+ "internal-routing": {
1443
+ "char": "i",
1444
+ "description": "filter to Internal Web Apps",
1445
+ "hidden": true,
1446
+ "name": "internal-routing",
1447
+ "allowNo": false,
1448
+ "type": "boolean"
1409
1449
  },
1410
- "remote": {
1411
- "char": "r",
1412
- "description": "git remote of app to use",
1413
- "name": "remote",
1450
+ "team": {
1451
+ "char": "t",
1452
+ "description": "team to use",
1453
+ "name": "team",
1414
1454
  "hasDynamicHelp": false,
1415
1455
  "multiple": false,
1416
1456
  "type": "option"
@@ -1418,37 +1458,41 @@
1418
1458
  },
1419
1459
  "hasDynamicHelp": false,
1420
1460
  "hiddenAliases": [
1421
- "addons:remove"
1461
+ "list",
1462
+ "apps:list"
1422
1463
  ],
1423
- "id": "addons:destroy",
1464
+ "id": "apps",
1424
1465
  "pluginAlias": "heroku",
1425
1466
  "pluginName": "heroku",
1426
1467
  "pluginType": "core",
1427
- "strict": false,
1428
- "topic": "addons",
1468
+ "strict": true,
1469
+ "topic": "apps",
1429
1470
  "isESM": false,
1430
1471
  "relativePath": [
1431
1472
  "lib",
1432
1473
  "commands",
1433
- "addons",
1434
- "destroy.js"
1474
+ "apps",
1475
+ "index.js"
1435
1476
  ]
1436
1477
  },
1437
- "addons:detach": {
1478
+ "apps:info": {
1438
1479
  "aliases": [],
1439
1480
  "args": {
1440
- "attachment_name": {
1441
- "name": "attachment_name",
1442
- "required": true
1481
+ "app": {
1482
+ "hidden": true,
1483
+ "name": "app"
1443
1484
  }
1444
1485
  },
1445
- "description": "detach an existing add-on resource from an app",
1486
+ "description": "show detailed app information",
1487
+ "examples": [
1488
+ "$ heroku apps:info",
1489
+ "$ heroku apps:info --shell"
1490
+ ],
1446
1491
  "flags": {
1447
1492
  "app": {
1448
1493
  "char": "a",
1449
1494
  "description": "app to run command against",
1450
1495
  "name": "app",
1451
- "required": true,
1452
1496
  "hasDynamicHelp": false,
1453
1497
  "multiple": false,
1454
1498
  "type": "option"
@@ -1460,44 +1504,60 @@
1460
1504
  "hasDynamicHelp": false,
1461
1505
  "multiple": false,
1462
1506
  "type": "option"
1507
+ },
1508
+ "shell": {
1509
+ "char": "s",
1510
+ "description": "output more shell friendly key/value pairs",
1511
+ "name": "shell",
1512
+ "allowNo": false,
1513
+ "type": "boolean"
1514
+ },
1515
+ "extended": {
1516
+ "char": "x",
1517
+ "hidden": true,
1518
+ "name": "extended",
1519
+ "allowNo": false,
1520
+ "type": "boolean"
1521
+ },
1522
+ "json": {
1523
+ "char": "j",
1524
+ "description": "output in json format",
1525
+ "name": "json",
1526
+ "allowNo": false,
1527
+ "type": "boolean"
1463
1528
  }
1464
1529
  },
1465
1530
  "hasDynamicHelp": false,
1466
- "hiddenAliases": [],
1467
- "id": "addons:detach",
1531
+ "hiddenAliases": [
1532
+ "info"
1533
+ ],
1534
+ "id": "apps:info",
1468
1535
  "pluginAlias": "heroku",
1469
1536
  "pluginName": "heroku",
1470
1537
  "pluginType": "core",
1471
1538
  "strict": true,
1472
- "topic": "addons",
1539
+ "topic": "apps",
1540
+ "help": "$ heroku apps:info\n=== example\nGit URL: https://git.heroku.com/example.git\nRepo Size: 5M\n...\n\n$ heroku apps:info --shell\ngit_url=https://git.heroku.com/example.git\nrepo_size=5000000\n...",
1473
1541
  "isESM": false,
1474
1542
  "relativePath": [
1475
1543
  "lib",
1476
1544
  "commands",
1477
- "addons",
1478
- "detach.js"
1545
+ "apps",
1546
+ "info.js"
1479
1547
  ]
1480
1548
  },
1481
- "addons:docs": {
1482
- "aliases": [],
1483
- "args": {
1484
- "addon": {
1485
- "name": "addon",
1486
- "required": true
1487
- }
1488
- },
1489
- "description": "open an add-on's Dev Center documentation in your browser",
1549
+ "apps:join": {
1550
+ "aliases": [
1551
+ "join"
1552
+ ],
1553
+ "args": {},
1554
+ "description": "add yourself to a team app",
1490
1555
  "flags": {
1491
- "show-url": {
1492
- "description": "show URL, do not open browser",
1493
- "name": "show-url",
1494
- "allowNo": false,
1495
- "type": "boolean"
1496
- },
1497
1556
  "app": {
1498
1557
  "char": "a",
1499
1558
  "description": "app to run command against",
1500
1559
  "name": "app",
1560
+ "required": true,
1501
1561
  "hasDynamicHelp": false,
1502
1562
  "multiple": false,
1503
1563
  "type": "option"
@@ -1513,46 +1573,33 @@
1513
1573
  },
1514
1574
  "hasDynamicHelp": false,
1515
1575
  "hiddenAliases": [],
1516
- "id": "addons:docs",
1576
+ "id": "apps:join",
1517
1577
  "pluginAlias": "heroku",
1518
1578
  "pluginName": "heroku",
1519
1579
  "pluginType": "core",
1520
1580
  "strict": true,
1521
- "topic": "addons",
1581
+ "topic": "apps",
1522
1582
  "isESM": false,
1523
1583
  "relativePath": [
1524
1584
  "lib",
1525
1585
  "commands",
1526
- "addons",
1527
- "docs.js"
1528
- ]
1529
- },
1530
- "addons": {
1531
- "aliases": [],
1532
- "args": {},
1533
- "description": "Lists your add-ons and attachments.\n\n The default filter applied depends on whether you are in a Heroku app\n directory. If so, the --app flag is implied. If not, the default of --all\n is implied. Explicitly providing either flag overrides the default\n behavior.\n ",
1534
- "examples": [
1535
- "$ heroku addons --all",
1536
- "$ heroku addons --app acme-inc-www"
1537
- ],
1538
- "flags": {
1539
- "all": {
1540
- "char": "A",
1541
- "description": "show add-ons and attachments for all accessible apps",
1542
- "name": "all",
1543
- "allowNo": false,
1544
- "type": "boolean"
1545
- },
1546
- "json": {
1547
- "description": "return add-ons in json format",
1548
- "name": "json",
1549
- "allowNo": false,
1550
- "type": "boolean"
1551
- },
1586
+ "apps",
1587
+ "join.js"
1588
+ ]
1589
+ },
1590
+ "apps:leave": {
1591
+ "aliases": [
1592
+ "leave"
1593
+ ],
1594
+ "args": {},
1595
+ "description": "remove yourself from a team app",
1596
+ "examples": "heroku apps:leave -a APP",
1597
+ "flags": {
1552
1598
  "app": {
1553
1599
  "char": "a",
1554
1600
  "description": "app to run command against",
1555
1601
  "name": "app",
1602
+ "required": true,
1556
1603
  "hasDynamicHelp": false,
1557
1604
  "multiple": false,
1558
1605
  "type": "option"
@@ -1568,35 +1615,33 @@
1568
1615
  },
1569
1616
  "hasDynamicHelp": false,
1570
1617
  "hiddenAliases": [],
1571
- "id": "addons",
1618
+ "id": "apps:leave",
1572
1619
  "pluginAlias": "heroku",
1573
1620
  "pluginName": "heroku",
1574
1621
  "pluginType": "core",
1575
1622
  "strict": true,
1576
- "usage": "addons [--all|--app APP]",
1577
- "topic": "addons",
1623
+ "topic": "apps",
1624
+ "example": "heroku apps:leave -a APP",
1578
1625
  "isESM": false,
1579
1626
  "relativePath": [
1580
1627
  "lib",
1581
1628
  "commands",
1582
- "addons",
1583
- "index.js"
1629
+ "apps",
1630
+ "leave.js"
1584
1631
  ]
1585
1632
  },
1586
- "addons:info": {
1587
- "aliases": [],
1588
- "args": {
1589
- "addon": {
1590
- "name": "addon",
1591
- "required": true
1592
- }
1593
- },
1594
- "description": "show detailed add-on resource and attachment information",
1633
+ "apps:lock": {
1634
+ "aliases": [
1635
+ "lock"
1636
+ ],
1637
+ "args": {},
1638
+ "description": "prevent team members from joining an app",
1595
1639
  "flags": {
1596
1640
  "app": {
1597
1641
  "char": "a",
1598
1642
  "description": "app to run command against",
1599
1643
  "name": "app",
1644
+ "required": true,
1600
1645
  "hasDynamicHelp": false,
1601
1646
  "multiple": false,
1602
1647
  "type": "option"
@@ -1612,41 +1657,40 @@
1612
1657
  },
1613
1658
  "hasDynamicHelp": false,
1614
1659
  "hiddenAliases": [],
1615
- "id": "addons:info",
1660
+ "id": "apps:lock",
1616
1661
  "pluginAlias": "heroku",
1617
1662
  "pluginName": "heroku",
1618
1663
  "pluginType": "core",
1619
1664
  "strict": true,
1620
- "usage": "addons:info ADDON",
1621
- "topic": "addons",
1665
+ "topic": "apps",
1622
1666
  "isESM": false,
1623
1667
  "relativePath": [
1624
1668
  "lib",
1625
1669
  "commands",
1626
- "addons",
1627
- "info.js"
1670
+ "apps",
1671
+ "lock.js"
1628
1672
  ]
1629
1673
  },
1630
- "addons:open": {
1674
+ "apps:open": {
1631
1675
  "aliases": [],
1632
1676
  "args": {
1633
- "addon": {
1634
- "name": "addon",
1635
- "required": true
1677
+ "path": {
1678
+ "description": "base URL path of app",
1679
+ "name": "path",
1680
+ "required": false
1636
1681
  }
1637
1682
  },
1638
- "description": "open an add-on's dashboard in your browser",
1683
+ "description": "open the app in a web browser",
1684
+ "examples": [
1685
+ "$ heroku open -a myapp",
1686
+ "$ heroku open -a myapp /foo"
1687
+ ],
1639
1688
  "flags": {
1640
- "show-url": {
1641
- "description": "show URL, do not open browser",
1642
- "name": "show-url",
1643
- "allowNo": false,
1644
- "type": "boolean"
1645
- },
1646
1689
  "app": {
1647
1690
  "char": "a",
1648
1691
  "description": "app to run command against",
1649
1692
  "name": "app",
1693
+ "required": true,
1650
1694
  "hasDynamicHelp": false,
1651
1695
  "multiple": false,
1652
1696
  "type": "option"
@@ -1661,130 +1705,103 @@
1661
1705
  }
1662
1706
  },
1663
1707
  "hasDynamicHelp": false,
1664
- "hiddenAliases": [],
1665
- "id": "addons:open",
1708
+ "hiddenAliases": [
1709
+ "open"
1710
+ ],
1711
+ "id": "apps:open",
1666
1712
  "pluginAlias": "heroku",
1667
1713
  "pluginName": "heroku",
1668
1714
  "pluginType": "core",
1669
1715
  "strict": true,
1670
- "topic": "addons",
1716
+ "topic": "apps",
1671
1717
  "isESM": false,
1672
1718
  "relativePath": [
1673
1719
  "lib",
1674
1720
  "commands",
1675
- "addons",
1721
+ "apps",
1676
1722
  "open.js"
1677
1723
  ]
1678
1724
  },
1679
- "addons:plans": {
1725
+ "apps:rename": {
1680
1726
  "aliases": [],
1681
1727
  "args": {
1682
- "service": {
1683
- "name": "service",
1728
+ "newname": {
1729
+ "description": "new unique name of the app",
1730
+ "name": "newname",
1684
1731
  "required": true
1685
1732
  }
1686
1733
  },
1687
- "description": "list all available plans for an add-on service",
1734
+ "description": "rename an app",
1735
+ "examples": [
1736
+ "$ heroku apps:rename --app oldname newname"
1737
+ ],
1688
1738
  "flags": {
1689
- "json": {
1690
- "description": "output in json format",
1691
- "name": "json",
1692
- "allowNo": false,
1693
- "type": "boolean"
1694
- }
1695
- },
1696
- "hasDynamicHelp": false,
1697
- "hiddenAliases": [],
1698
- "id": "addons:plans",
1699
- "pluginAlias": "heroku",
1700
- "pluginName": "heroku",
1701
- "pluginType": "core",
1702
- "strict": true,
1703
- "topic": "addons",
1704
- "isESM": false,
1705
- "relativePath": [
1706
- "lib",
1707
- "commands",
1708
- "addons",
1709
- "plans.js"
1710
- ]
1711
- },
1712
- "addons:rename": {
1713
- "aliases": [],
1714
- "args": {
1715
- "addon_name": {
1716
- "name": "addon_name",
1717
- "required": true
1739
+ "app": {
1740
+ "char": "a",
1741
+ "description": "app to run command against",
1742
+ "name": "app",
1743
+ "required": true,
1744
+ "hasDynamicHelp": false,
1745
+ "multiple": false,
1746
+ "type": "option"
1718
1747
  },
1719
- "new_name": {
1720
- "name": "new_name",
1721
- "required": true
1748
+ "remote": {
1749
+ "char": "r",
1750
+ "description": "git remote of app to use",
1751
+ "name": "remote",
1752
+ "hasDynamicHelp": false,
1753
+ "multiple": false,
1754
+ "type": "option"
1722
1755
  }
1723
1756
  },
1724
- "description": "rename an add-on",
1725
- "flags": {},
1726
1757
  "hasDynamicHelp": false,
1727
- "hiddenAliases": [],
1728
- "id": "addons:rename",
1758
+ "hiddenAliases": [
1759
+ "rename"
1760
+ ],
1761
+ "id": "apps:rename",
1729
1762
  "pluginAlias": "heroku",
1730
1763
  "pluginName": "heroku",
1731
1764
  "pluginType": "core",
1732
1765
  "strict": true,
1733
- "topic": "addons",
1766
+ "help": "This will locally update the git remote if it is set to the old app.",
1767
+ "topic": "apps",
1734
1768
  "isESM": false,
1735
1769
  "relativePath": [
1736
1770
  "lib",
1737
1771
  "commands",
1738
- "addons",
1772
+ "apps",
1739
1773
  "rename.js"
1740
1774
  ]
1741
1775
  },
1742
- "addons:services": {
1776
+ "apps:transfer": {
1743
1777
  "aliases": [],
1744
- "args": {},
1745
- "description": "list all available add-on services",
1746
- "flags": {
1747
- "json": {
1748
- "description": "output in json format",
1749
- "name": "json",
1750
- "allowNo": false,
1751
- "type": "boolean"
1752
- }
1753
- },
1754
- "hasDynamicHelp": false,
1755
- "hiddenAliases": [],
1756
- "id": "addons:services",
1757
- "pluginAlias": "heroku",
1758
- "pluginName": "heroku",
1759
- "pluginType": "core",
1760
- "strict": true,
1761
- "topic": "addons",
1762
- "isESM": false,
1763
- "relativePath": [
1764
- "lib",
1765
- "commands",
1766
- "addons",
1767
- "services.js"
1768
- ]
1769
- },
1770
- "addons:upgrade": {
1771
- "aliases": [
1772
- "addons:downgrade"
1773
- ],
1774
1778
  "args": {
1775
- "addon": {
1776
- "name": "addon",
1779
+ "recipient": {
1780
+ "description": "user or team to transfer applications to",
1781
+ "name": "recipient",
1777
1782
  "required": true
1778
- },
1779
- "plan": {
1780
- "name": "plan"
1781
1783
  }
1782
1784
  },
1783
- "description": "change add-on plan.\n See available plans with `heroku addons:plans SERVICE`.\n\n Note that `heroku addons:upgrade` and `heroku addons:downgrade` are the same. Either one can be used to change an add-on plan up or down.\n\n https://devcenter.heroku.com/articles/managing-add-ons\n ",
1785
+ "description": "transfer applications to another user or team",
1784
1786
  "examples": [
1785
- "Upgrade an add-on by service name:\n$ heroku addons:upgrade heroku-redis:premium-2\n\nUpgrade a specific add-on:\n$ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2"
1787
+ "$ heroku apps:transfer collaborator@example.com\nTransferring example to collaborator@example.com... done\n\n$ heroku apps:transfer acme-widgets\nTransferring example to acme-widgets... done\n\n$ heroku apps:transfer --bulk acme-widgets\n..."
1786
1788
  ],
1787
1789
  "flags": {
1790
+ "locked": {
1791
+ "char": "l",
1792
+ "description": "lock the app upon transfer",
1793
+ "name": "locked",
1794
+ "required": false,
1795
+ "allowNo": false,
1796
+ "type": "boolean"
1797
+ },
1798
+ "bulk": {
1799
+ "description": "transfer applications in bulk",
1800
+ "name": "bulk",
1801
+ "required": false,
1802
+ "allowNo": false,
1803
+ "type": "boolean"
1804
+ },
1788
1805
  "app": {
1789
1806
  "char": "a",
1790
1807
  "description": "app to run command against",
@@ -1800,44 +1817,44 @@
1800
1817
  "hasDynamicHelp": false,
1801
1818
  "multiple": false,
1802
1819
  "type": "option"
1820
+ },
1821
+ "confirm": {
1822
+ "char": "c",
1823
+ "hidden": true,
1824
+ "name": "confirm",
1825
+ "hasDynamicHelp": false,
1826
+ "multiple": false,
1827
+ "type": "option"
1803
1828
  }
1804
1829
  },
1805
1830
  "hasDynamicHelp": false,
1806
1831
  "hiddenAliases": [],
1807
- "id": "addons:upgrade",
1832
+ "id": "apps:transfer",
1808
1833
  "pluginAlias": "heroku",
1809
1834
  "pluginName": "heroku",
1810
1835
  "pluginType": "core",
1811
1836
  "strict": true,
1812
- "topic": "addons",
1837
+ "topic": "apps",
1813
1838
  "isESM": false,
1814
1839
  "relativePath": [
1815
1840
  "lib",
1816
1841
  "commands",
1817
- "addons",
1818
- "upgrade.js"
1842
+ "apps",
1843
+ "transfer.js"
1819
1844
  ]
1820
1845
  },
1821
- "addons:wait": {
1822
- "aliases": [],
1823
- "args": {
1824
- "addon": {
1825
- "name": "addon"
1826
- }
1827
- },
1828
- "description": "show provisioning status of the add-ons on the app",
1846
+ "apps:unlock": {
1847
+ "aliases": [
1848
+ "unlock"
1849
+ ],
1850
+ "args": {},
1851
+ "description": "unlock an app so any team member can join",
1829
1852
  "flags": {
1830
- "wait-interval": {
1831
- "description": "how frequently to poll in seconds",
1832
- "name": "wait-interval",
1833
- "hasDynamicHelp": false,
1834
- "multiple": false,
1835
- "type": "option"
1836
- },
1837
1853
  "app": {
1838
1854
  "char": "a",
1839
1855
  "description": "app to run command against",
1840
1856
  "name": "app",
1857
+ "required": true,
1841
1858
  "hasDynamicHelp": false,
1842
1859
  "multiple": false,
1843
1860
  "type": "option"
@@ -1853,18 +1870,18 @@
1853
1870
  },
1854
1871
  "hasDynamicHelp": false,
1855
1872
  "hiddenAliases": [],
1856
- "id": "addons:wait",
1873
+ "id": "apps:unlock",
1857
1874
  "pluginAlias": "heroku",
1858
1875
  "pluginName": "heroku",
1859
1876
  "pluginType": "core",
1860
1877
  "strict": true,
1861
- "topic": "addons",
1878
+ "topic": "apps",
1862
1879
  "isESM": false,
1863
1880
  "relativePath": [
1864
1881
  "lib",
1865
1882
  "commands",
1866
- "addons",
1867
- "wait.js"
1883
+ "apps",
1884
+ "unlock.js"
1868
1885
  ]
1869
1886
  },
1870
1887
  "auth:login": {
@@ -2089,6 +2106,7 @@
2089
2106
  "aliases": [],
2090
2107
  "args": {
2091
2108
  "id": {
2109
+ "description": "ID of the authorization",
2092
2110
  "name": "id",
2093
2111
  "required": true
2094
2112
  }
@@ -2125,6 +2143,7 @@
2125
2143
  ],
2126
2144
  "args": {
2127
2145
  "id": {
2146
+ "description": "ID of the authorization",
2128
2147
  "name": "id",
2129
2148
  "required": true
2130
2149
  }
@@ -2153,6 +2172,7 @@
2153
2172
  "aliases": [],
2154
2173
  "args": {
2155
2174
  "id": {
2175
+ "description": "ID of the authorization",
2156
2176
  "name": "id",
2157
2177
  "required": true
2158
2178
  }
@@ -2178,6 +2198,7 @@
2178
2198
  "aliases": [],
2179
2199
  "args": {
2180
2200
  "id": {
2201
+ "description": "ID of the authorization",
2181
2202
  "name": "id",
2182
2203
  "required": true
2183
2204
  }
@@ -2719,10 +2740,12 @@
2719
2740
  "aliases": [],
2720
2741
  "args": {
2721
2742
  "CRT": {
2743
+ "description": "absolute path of the certificate file on disk",
2722
2744
  "name": "CRT",
2723
2745
  "required": true
2724
2746
  },
2725
2747
  "KEY": {
2748
+ "description": "absolute path of the key file on disk",
2726
2749
  "name": "KEY",
2727
2750
  "required": true
2728
2751
  }
@@ -2770,6 +2793,7 @@
2770
2793
  "aliases": [],
2771
2794
  "args": {
2772
2795
  "domain": {
2796
+ "description": "domain name to generate",
2773
2797
  "name": "domain",
2774
2798
  "required": true
2775
2799
  }
@@ -3029,10 +3053,12 @@
3029
3053
  "aliases": [],
3030
3054
  "args": {
3031
3055
  "CRT": {
3056
+ "description": "absolute path of the certificate file on disk",
3032
3057
  "name": "CRT",
3033
3058
  "required": true
3034
3059
  },
3035
3060
  "KEY": {
3061
+ "description": "absolute path of the key file on disk",
3036
3062
  "name": "KEY",
3037
3063
  "required": true
3038
3064
  }
@@ -3215,6 +3241,7 @@
3215
3241
  "aliases": [],
3216
3242
  "args": {
3217
3243
  "test-run": {
3244
+ "description": "auto-incremented test run number",
3218
3245
  "name": "test-run",
3219
3246
  "required": true
3220
3247
  }
@@ -3416,6 +3443,7 @@
3416
3443
  "aliases": [],
3417
3444
  "args": {
3418
3445
  "number": {
3446
+ "description": "auto-incremented test run number",
3419
3447
  "name": "number",
3420
3448
  "required": false
3421
3449
  }
@@ -3519,10 +3547,12 @@
3519
3547
  "aliases": [],
3520
3548
  "args": {
3521
3549
  "name": {
3550
+ "description": "name of the OAuth client",
3522
3551
  "name": "name",
3523
3552
  "required": true
3524
3553
  },
3525
3554
  "redirect_uri": {
3555
+ "description": "redirect URL of the OAuth client",
3526
3556
  "name": "redirect_uri",
3527
3557
  "required": true
3528
3558
  }
@@ -3566,6 +3596,7 @@
3566
3596
  "aliases": [],
3567
3597
  "args": {
3568
3598
  "id": {
3599
+ "description": "ID of the OAuth client",
3569
3600
  "name": "id",
3570
3601
  "required": true
3571
3602
  }
@@ -3619,6 +3650,7 @@
3619
3650
  "aliases": [],
3620
3651
  "args": {
3621
3652
  "id": {
3653
+ "description": "ID of the OAuth client",
3622
3654
  "name": "id",
3623
3655
  "required": true
3624
3656
  }
@@ -3662,6 +3694,7 @@
3662
3694
  "aliases": [],
3663
3695
  "args": {
3664
3696
  "id": {
3697
+ "description": "ID of the OAuth client",
3665
3698
  "name": "id",
3666
3699
  "required": true
3667
3700
  }
@@ -3702,6 +3735,7 @@
3702
3735
  "aliases": [],
3703
3736
  "args": {
3704
3737
  "id": {
3738
+ "description": "ID of the OAuth client",
3705
3739
  "name": "id",
3706
3740
  "required": true
3707
3741
  }
@@ -3795,6 +3829,7 @@
3795
3829
  "aliases": [],
3796
3830
  "args": {
3797
3831
  "KEY": {
3832
+ "description": "key name of the config var value",
3798
3833
  "name": "KEY",
3799
3834
  "required": true
3800
3835
  }
@@ -4333,6 +4368,7 @@
4333
4368
  "aliases": [],
4334
4369
  "args": {
4335
4370
  "hostname": {
4371
+ "description": "unique identifier of the domain or full hostname",
4336
4372
  "name": "hostname",
4337
4373
  "required": true
4338
4374
  }
@@ -4578,6 +4614,7 @@
4578
4614
  "aliases": [],
4579
4615
  "args": {
4580
4616
  "hostname": {
4617
+ "description": "unique identifier of the domain or full hostname",
4581
4618
  "name": "hostname",
4582
4619
  "required": true
4583
4620
  }
@@ -4631,6 +4668,7 @@
4631
4668
  "aliases": [],
4632
4669
  "args": {
4633
4670
  "hostname": {
4671
+ "description": "unique identifier of the domain or full hostname",
4634
4672
  "name": "hostname",
4635
4673
  "required": true
4636
4674
  }
@@ -4684,6 +4722,7 @@
4684
4722
  "aliases": [],
4685
4723
  "args": {
4686
4724
  "hostname": {
4725
+ "description": "unique identifier of the domain or full hostname",
4687
4726
  "name": "hostname",
4688
4727
  "required": true
4689
4728
  }
@@ -4745,6 +4784,7 @@
4745
4784
  "aliases": [],
4746
4785
  "args": {
4747
4786
  "hostname": {
4787
+ "description": "unique identifier of the domain or full hostname",
4748
4788
  "name": "hostname"
4749
4789
  }
4750
4790
  },
@@ -4794,6 +4834,7 @@
4794
4834
  "aliases": [],
4795
4835
  "args": {
4796
4836
  "url": {
4837
+ "description": "URL of the log drain",
4797
4838
  "name": "url",
4798
4839
  "required": true
4799
4840
  }
@@ -4888,6 +4929,7 @@
4888
4929
  "aliases": [],
4889
4930
  "args": {
4890
4931
  "url": {
4932
+ "description": "URL of the log drain",
4891
4933
  "name": "url",
4892
4934
  "required": true
4893
4935
  }
@@ -4933,6 +4975,7 @@
4933
4975
  "aliases": [],
4934
4976
  "args": {
4935
4977
  "feature": {
4978
+ "description": "unique identifier or name of the app feature",
4936
4979
  "name": "feature",
4937
4980
  "required": true
4938
4981
  }
@@ -4976,6 +5019,7 @@
4976
5019
  "aliases": [],
4977
5020
  "args": {
4978
5021
  "feature": {
5022
+ "description": "unique identifier or name of the app feature",
4979
5023
  "name": "feature",
4980
5024
  "required": true
4981
5025
  }
@@ -5063,6 +5107,7 @@
5063
5107
  "aliases": [],
5064
5108
  "args": {
5065
5109
  "feature": {
5110
+ "description": "unique identifier or name of the app feature",
5066
5111
  "name": "feature",
5067
5112
  "required": true
5068
5113
  }
@@ -5158,6 +5203,7 @@
5158
5203
  "aliases": [],
5159
5204
  "args": {
5160
5205
  "command": {
5206
+ "description": "command name of the git credentials",
5161
5207
  "name": "command",
5162
5208
  "required": true
5163
5209
  }
@@ -5223,6 +5269,7 @@
5223
5269
  "aliases": [],
5224
5270
  "args": {
5225
5271
  "key": {
5272
+ "description": "absolute path to the key located on disk. If omitted, we use the default rsa key.",
5226
5273
  "name": "key"
5227
5274
  }
5228
5275
  },
@@ -5318,6 +5365,7 @@
5318
5365
  "aliases": [],
5319
5366
  "args": {
5320
5367
  "key": {
5368
+ "description": "email address of the user",
5321
5369
  "name": "key",
5322
5370
  "required": true
5323
5371
  }
@@ -5345,6 +5393,7 @@
5345
5393
  "aliases": [],
5346
5394
  "args": {
5347
5395
  "feature": {
5396
+ "description": "unique identifier or name of the account feature",
5348
5397
  "name": "feature",
5349
5398
  "required": true
5350
5399
  }
@@ -5394,6 +5443,7 @@
5394
5443
  "aliases": [],
5395
5444
  "args": {
5396
5445
  "feature": {
5446
+ "description": "unique identifier or name of the account feature",
5397
5447
  "name": "feature",
5398
5448
  "required": true
5399
5449
  }
@@ -5484,6 +5534,7 @@
5484
5534
  "aliases": [],
5485
5535
  "args": {
5486
5536
  "feature": {
5537
+ "description": "unique identifier or name of the account feature",
5487
5538
  "name": "feature",
5488
5539
  "required": true
5489
5540
  }
@@ -5537,6 +5588,7 @@
5537
5588
  ],
5538
5589
  "args": {
5539
5590
  "processname": {
5591
+ "description": "name of the process",
5540
5592
  "name": "processname",
5541
5593
  "required": false
5542
5594
  }
@@ -5782,6 +5834,7 @@
5782
5834
  "aliases": [],
5783
5835
  "args": {
5784
5836
  "email": {
5837
+ "description": "email address of the team member",
5785
5838
  "name": "email",
5786
5839
  "required": true
5787
5840
  }
@@ -6078,6 +6131,7 @@
6078
6131
  "aliases": [],
6079
6132
  "args": {
6080
6133
  "database": {
6134
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6081
6135
  "name": "database"
6082
6136
  }
6083
6137
  },
@@ -6121,6 +6175,7 @@
6121
6175
  "aliases": [],
6122
6176
  "args": {
6123
6177
  "database": {
6178
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6124
6179
  "name": "database"
6125
6180
  }
6126
6181
  },
@@ -6164,10 +6219,12 @@
6164
6219
  "aliases": [],
6165
6220
  "args": {
6166
6221
  "source": {
6222
+ "description": "config var exposed to the owning app containing the source database URL",
6167
6223
  "name": "source",
6168
6224
  "required": true
6169
6225
  },
6170
6226
  "target": {
6227
+ "description": "config var exposed to the owning app containing the target database URL",
6171
6228
  "name": "target",
6172
6229
  "required": true
6173
6230
  }
@@ -6230,6 +6287,7 @@
6230
6287
  "aliases": [],
6231
6288
  "args": {
6232
6289
  "database": {
6290
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6233
6291
  "name": "database"
6234
6292
  }
6235
6293
  },
@@ -6273,6 +6331,7 @@
6273
6331
  "aliases": [],
6274
6332
  "args": {
6275
6333
  "DATABASE|REPORT_ID": {
6334
+ "description": "config var exposed to the owning app containing the database URL or the report ID",
6276
6335
  "name": "DATABASE|REPORT_ID"
6277
6336
  }
6278
6337
  },
@@ -6324,6 +6383,7 @@
6324
6383
  ],
6325
6384
  "args": {
6326
6385
  "database": {
6386
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use all databases.",
6327
6387
  "name": "database"
6328
6388
  }
6329
6389
  },
@@ -6367,10 +6427,12 @@
6367
6427
  "aliases": [],
6368
6428
  "args": {
6369
6429
  "pid": {
6430
+ "description": "ID of the process",
6370
6431
  "name": "pid",
6371
6432
  "required": true
6372
6433
  },
6373
6434
  "database": {
6435
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6374
6436
  "name": "database"
6375
6437
  }
6376
6438
  },
@@ -6420,6 +6482,7 @@
6420
6482
  "aliases": [],
6421
6483
  "args": {
6422
6484
  "database": {
6485
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6423
6486
  "name": "database"
6424
6487
  }
6425
6488
  },
@@ -6463,6 +6526,7 @@
6463
6526
  "aliases": [],
6464
6527
  "args": {
6465
6528
  "database": {
6529
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6466
6530
  "name": "database"
6467
6531
  }
6468
6532
  },
@@ -6513,6 +6577,7 @@
6513
6577
  "aliases": [],
6514
6578
  "args": {
6515
6579
  "database": {
6580
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6516
6581
  "name": "database"
6517
6582
  }
6518
6583
  },
@@ -6577,6 +6642,7 @@
6577
6642
  "aliases": [],
6578
6643
  "args": {
6579
6644
  "database": {
6645
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::`",
6580
6646
  "name": "database",
6581
6647
  "required": true
6582
6648
  }
@@ -6627,6 +6693,7 @@
6627
6693
  "aliases": [],
6628
6694
  "args": {
6629
6695
  "database": {
6696
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6630
6697
  "name": "database"
6631
6698
  }
6632
6699
  },
@@ -6678,6 +6745,7 @@
6678
6745
  ],
6679
6746
  "args": {
6680
6747
  "database": {
6748
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6681
6749
  "name": "database"
6682
6750
  }
6683
6751
  },
@@ -6743,10 +6811,12 @@
6743
6811
  "aliases": [],
6744
6812
  "args": {
6745
6813
  "source": {
6814
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6746
6815
  "name": "source",
6747
6816
  "required": true
6748
6817
  },
6749
6818
  "target": {
6819
+ "description": "PostgreSQL connection string for the target database",
6750
6820
  "name": "target",
6751
6821
  "required": true
6752
6822
  }
@@ -6802,10 +6872,12 @@
6802
6872
  "aliases": [],
6803
6873
  "args": {
6804
6874
  "source": {
6875
+ "description": "PostgreSQL connection string for the source database",
6805
6876
  "name": "source",
6806
6877
  "required": true
6807
6878
  },
6808
6879
  "target": {
6880
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6809
6881
  "name": "target",
6810
6882
  "required": true
6811
6883
  }
@@ -6861,6 +6933,7 @@
6861
6933
  "aliases": [],
6862
6934
  "args": {
6863
6935
  "database": {
6936
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6864
6937
  "name": "database"
6865
6938
  }
6866
6939
  },
@@ -6919,6 +6992,7 @@
6919
6992
  "aliases": [],
6920
6993
  "args": {
6921
6994
  "database": {
6995
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::`",
6922
6996
  "name": "database",
6923
6997
  "required": true
6924
6998
  }
@@ -6970,6 +7044,7 @@
6970
7044
  "aliases": [],
6971
7045
  "args": {
6972
7046
  "database": {
7047
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
6973
7048
  "name": "database"
6974
7049
  }
6975
7050
  },
@@ -7028,6 +7103,7 @@
7028
7103
  "aliases": [],
7029
7104
  "args": {
7030
7105
  "database": {
7106
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
7031
7107
  "name": "database"
7032
7108
  }
7033
7109
  },
@@ -7071,6 +7147,7 @@
7071
7147
  "aliases": [],
7072
7148
  "args": {
7073
7149
  "database": {
7150
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use all databases.",
7074
7151
  "name": "database"
7075
7152
  }
7076
7153
  },
@@ -7787,6 +7864,7 @@
7787
7864
  ],
7788
7865
  "args": {
7789
7866
  "dyno": {
7867
+ "description": "ID of the dyno",
7790
7868
  "name": "dyno",
7791
7869
  "required": false
7792
7870
  }
@@ -7889,6 +7967,7 @@
7889
7967
  ],
7890
7968
  "args": {
7891
7969
  "dyno": {
7970
+ "description": "ID of the dyno",
7892
7971
  "name": "dyno",
7893
7972
  "required": true
7894
7973
  }
@@ -8050,6 +8129,7 @@
8050
8129
  "aliases": [],
8051
8130
  "args": {
8052
8131
  "database": {
8132
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8053
8133
  "name": "database"
8054
8134
  }
8055
8135
  },
@@ -8104,6 +8184,7 @@
8104
8184
  "aliases": [],
8105
8185
  "args": {
8106
8186
  "database": {
8187
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8107
8188
  "name": "database",
8108
8189
  "required": false
8109
8190
  }
@@ -8156,6 +8237,7 @@
8156
8237
  ],
8157
8238
  "args": {
8158
8239
  "database": {
8240
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8159
8241
  "name": "database"
8160
8242
  }
8161
8243
  },
@@ -8206,6 +8288,7 @@
8206
8288
  "aliases": [],
8207
8289
  "args": {
8208
8290
  "database": {
8291
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8209
8292
  "name": "database"
8210
8293
  }
8211
8294
  },
@@ -8258,6 +8341,7 @@
8258
8341
  "aliases": [],
8259
8342
  "args": {
8260
8343
  "database": {
8344
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8261
8345
  "name": "database",
8262
8346
  "required": false
8263
8347
  }
@@ -8326,6 +8410,7 @@
8326
8410
  "aliases": [],
8327
8411
  "args": {
8328
8412
  "database": {
8413
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8329
8414
  "name": "database"
8330
8415
  }
8331
8416
  },
@@ -8378,6 +8463,7 @@
8378
8463
  "aliases": [],
8379
8464
  "args": {
8380
8465
  "database": {
8466
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8381
8467
  "name": "database",
8382
8468
  "required": false
8383
8469
  }
@@ -8422,6 +8508,7 @@
8422
8508
  "aliases": [],
8423
8509
  "args": {
8424
8510
  "database": {
8511
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8425
8512
  "name": "database"
8426
8513
  }
8427
8514
  },
@@ -8472,6 +8559,7 @@
8472
8559
  "aliases": [],
8473
8560
  "args": {
8474
8561
  "database": {
8562
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8475
8563
  "name": "database"
8476
8564
  }
8477
8565
  },
@@ -8524,6 +8612,7 @@
8524
8612
  "aliases": [],
8525
8613
  "args": {
8526
8614
  "database": {
8615
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8527
8616
  "name": "database"
8528
8617
  }
8529
8618
  },
@@ -8582,6 +8671,7 @@
8582
8671
  "aliases": [],
8583
8672
  "args": {
8584
8673
  "database": {
8674
+ "description": "name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the app.",
8585
8675
  "name": "database",
8586
8676
  "required": false
8587
8677
  }
@@ -8698,6 +8788,7 @@
8698
8788
  "aliases": [],
8699
8789
  "args": {
8700
8790
  "release": {
8791
+ "description": "ID of the release. If omitted, we use the last release ID.",
8701
8792
  "name": "release"
8702
8793
  }
8703
8794
  },
@@ -8754,6 +8845,7 @@
8754
8845
  "aliases": [],
8755
8846
  "args": {
8756
8847
  "release": {
8848
+ "description": "ID of the release. If omitted, we use the last release ID.",
8757
8849
  "name": "release"
8758
8850
  }
8759
8851
  },
@@ -8797,6 +8889,7 @@
8797
8889
  "aliases": [],
8798
8890
  "args": {
8799
8891
  "release": {
8892
+ "description": "ID of the release. If omitted, we use the last release ID.",
8800
8893
  "name": "release"
8801
8894
  }
8802
8895
  },
@@ -9215,6 +9308,7 @@
9215
9308
  "aliases": [],
9216
9309
  "args": {
9217
9310
  "id": {
9311
+ "description": "ID of the OAuth session",
9218
9312
  "name": "id",
9219
9313
  "required": true
9220
9314
  }
@@ -9933,6 +10027,7 @@
9933
10027
  "aliases": [],
9934
10028
  "args": {
9935
10029
  "id": {
10030
+ "description": "ID of the webhook",
9936
10031
  "name": "id",
9937
10032
  "required": true
9938
10033
  }
@@ -10045,6 +10140,7 @@
10045
10140
  "aliases": [],
10046
10141
  "args": {
10047
10142
  "id": {
10143
+ "description": "ID of the webhook",
10048
10144
  "name": "id",
10049
10145
  "required": true
10050
10146
  }
@@ -10294,6 +10390,7 @@
10294
10390
  "aliases": [],
10295
10391
  "args": {
10296
10392
  "stack": {
10393
+ "description": "unique name or identifier of the stack",
10297
10394
  "name": "stack",
10298
10395
  "required": true
10299
10396
  }
@@ -10602,6 +10699,7 @@
10602
10699
  "aliases": [],
10603
10700
  "args": {
10604
10701
  "key": {
10702
+ "description": "name of the config var key",
10605
10703
  "name": "key",
10606
10704
  "required": true
10607
10705
  }
@@ -10833,6 +10931,7 @@
10833
10931
  "aliases": [],
10834
10932
  "args": {
10835
10933
  "backup_id": {
10934
+ "description": "ID of the backup. If omitted, we use the last unfinished backup ID.",
10836
10935
  "name": "backup_id"
10837
10936
  }
10838
10937
  },
@@ -10877,6 +10976,7 @@
10877
10976
  "aliases": [],
10878
10977
  "args": {
10879
10978
  "database": {
10979
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
10880
10980
  "name": "database"
10881
10981
  }
10882
10982
  },
@@ -10933,6 +11033,7 @@
10933
11033
  "aliases": [],
10934
11034
  "args": {
10935
11035
  "backup_id": {
11036
+ "description": "ID of the backup",
10936
11037
  "name": "backup_id",
10937
11038
  "required": true
10938
11039
  }
@@ -10988,6 +11089,7 @@
10988
11089
  "aliases": [],
10989
11090
  "args": {
10990
11091
  "backup_id": {
11092
+ "description": "ID of the backup. If omitted, we use the last backup ID.",
10991
11093
  "name": "backup_id"
10992
11094
  }
10993
11095
  },
@@ -11124,6 +11226,7 @@
11124
11226
  "aliases": [],
11125
11227
  "args": {
11126
11228
  "backup_id": {
11229
+ "description": "ID of the backup. If omitted, we use the last backup ID.",
11127
11230
  "name": "backup_id"
11128
11231
  }
11129
11232
  },
@@ -11168,13 +11271,23 @@
11168
11271
  "aliases": [],
11169
11272
  "args": {
11170
11273
  "backup": {
11274
+ "description": "URL or backup ID from another app",
11171
11275
  "name": "backup"
11172
11276
  },
11173
11277
  "database": {
11278
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11174
11279
  "name": "database"
11175
11280
  }
11176
11281
  },
11177
11282
  "description": "restore a backup (default latest) to a database",
11283
+ "examples": [
11284
+ "# Basic Restore from Backup ID\n$ heroku pg:backups:restore b101 DATABASE_URL --app my-heroku-app\n",
11285
+ "# Restore from Another App\n$ heroku pg:backups:restore example-app::b101 DATABASE_URL --app my-heroku-app\n",
11286
+ "# Restore from a Public URL\n$ heroku pg:backups:restore 'https://s3.amazonaws.com/my-bucket/mydb.dump' DATABASE_URL --app my-heroku-app\n",
11287
+ "# Verbose Output\n$ heroku pg:backups:restore b101 DATABASE_URL --app my-heroku-app --verbose\n",
11288
+ "# Restore with Confirmation Prompt\n$ heroku pg:backups:restore b101 DATABASE_URL --app my-heroku-app --confirm my-heroku-app\n",
11289
+ "# Restore with a Specific Database Name\n$ heroku pg:backups:restore b101 HEROKU_POSTGRESQL_PINK --app my-heroku-app\n"
11290
+ ],
11178
11291
  "flags": {
11179
11292
  "wait-interval": {
11180
11293
  "name": "wait-interval",
@@ -11243,6 +11356,7 @@
11243
11356
  "aliases": [],
11244
11357
  "args": {
11245
11358
  "database": {
11359
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11246
11360
  "name": "database"
11247
11361
  }
11248
11362
  },
@@ -11335,6 +11449,7 @@
11335
11449
  "aliases": [],
11336
11450
  "args": {
11337
11451
  "database": {
11452
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use a random database attached to the app.",
11338
11453
  "name": "database"
11339
11454
  }
11340
11455
  },
@@ -11379,6 +11494,7 @@
11379
11494
  "aliases": [],
11380
11495
  "args": {
11381
11496
  "backup_id": {
11497
+ "description": "ID of the backup. If omitted, we use the last backup ID.",
11382
11498
  "name": "backup_id"
11383
11499
  }
11384
11500
  },
@@ -11423,6 +11539,7 @@
11423
11539
  "aliases": [],
11424
11540
  "args": {
11425
11541
  "database": {
11542
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11426
11543
  "name": "database"
11427
11544
  }
11428
11545
  },
@@ -11477,6 +11594,7 @@
11477
11594
  "aliases": [],
11478
11595
  "args": {
11479
11596
  "database": {
11597
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11480
11598
  "name": "database"
11481
11599
  }
11482
11600
  },
@@ -11530,6 +11648,7 @@
11530
11648
  "aliases": [],
11531
11649
  "args": {
11532
11650
  "database": {
11651
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11533
11652
  "name": "database"
11534
11653
  }
11535
11654
  },
@@ -11592,6 +11711,7 @@
11592
11711
  "aliases": [],
11593
11712
  "args": {
11594
11713
  "database": {
11714
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11595
11715
  "name": "database"
11596
11716
  }
11597
11717
  },
@@ -11645,6 +11765,7 @@
11645
11765
  "aliases": [],
11646
11766
  "args": {
11647
11767
  "database": {
11768
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11648
11769
  "name": "database"
11649
11770
  }
11650
11771
  },
@@ -11719,6 +11840,7 @@
11719
11840
  "aliases": [],
11720
11841
  "args": {
11721
11842
  "database": {
11843
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11722
11844
  "name": "database"
11723
11845
  }
11724
11846
  },
@@ -11772,10 +11894,12 @@
11772
11894
  "aliases": [],
11773
11895
  "args": {
11774
11896
  "remote": {
11897
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::`",
11775
11898
  "name": "remote",
11776
11899
  "required": true
11777
11900
  },
11778
11901
  "database": {
11902
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::`",
11779
11903
  "name": "database",
11780
11904
  "required": true
11781
11905
  }
@@ -11828,10 +11952,12 @@
11828
11952
  "aliases": [],
11829
11953
  "args": {
11830
11954
  "database": {
11955
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::`",
11831
11956
  "name": "database",
11832
11957
  "required": true
11833
11958
  },
11834
11959
  "link": {
11960
+ "description": "name of the linked data store",
11835
11961
  "name": "link",
11836
11962
  "required": true
11837
11963
  }
@@ -11886,6 +12012,7 @@
11886
12012
  "aliases": [],
11887
12013
  "args": {
11888
12014
  "database": {
12015
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11889
12016
  "name": "database"
11890
12017
  }
11891
12018
  },
@@ -11930,6 +12057,7 @@
11930
12057
  "aliases": [],
11931
12058
  "args": {
11932
12059
  "database": {
12060
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11933
12061
  "name": "database"
11934
12062
  }
11935
12063
  },
@@ -11974,6 +12102,7 @@
11974
12102
  "aliases": [],
11975
12103
  "args": {
11976
12104
  "database": {
12105
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
11977
12106
  "name": "database"
11978
12107
  }
11979
12108
  },
@@ -12024,10 +12153,12 @@
12024
12153
  "aliases": [],
12025
12154
  "args": {
12026
12155
  "window": {
12156
+ "description": "timestamp of the maintenance window",
12027
12157
  "name": "window",
12028
12158
  "required": true
12029
12159
  },
12030
12160
  "database": {
12161
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12031
12162
  "name": "database"
12032
12163
  }
12033
12164
  },
@@ -12074,9 +12205,11 @@
12074
12205
  "aliases": [],
12075
12206
  "args": {
12076
12207
  "database": {
12208
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12077
12209
  "name": "database"
12078
12210
  },
12079
12211
  "value": {
12212
+ "description": "boolean indicating if execution plans of queries will be logged for future connections",
12080
12213
  "name": "value"
12081
12214
  }
12082
12215
  },
@@ -12121,9 +12254,11 @@
12121
12254
  "aliases": [],
12122
12255
  "args": {
12123
12256
  "database": {
12257
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12124
12258
  "name": "database"
12125
12259
  },
12126
12260
  "value": {
12261
+ "description": "boolean indicating if data replication slot details get logged",
12127
12262
  "name": "value"
12128
12263
  }
12129
12264
  },
@@ -12167,6 +12302,7 @@
12167
12302
  "aliases": [],
12168
12303
  "args": {
12169
12304
  "database": {
12305
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12170
12306
  "name": "database"
12171
12307
  }
12172
12308
  },
@@ -12211,9 +12347,11 @@
12211
12347
  "aliases": [],
12212
12348
  "args": {
12213
12349
  "database": {
12350
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12214
12351
  "name": "database"
12215
12352
  },
12216
12353
  "value": {
12354
+ "description": "boolean indicating if database login attempts get logged",
12217
12355
  "name": "value"
12218
12356
  }
12219
12357
  },
@@ -12257,9 +12395,11 @@
12257
12395
  "aliases": [],
12258
12396
  "args": {
12259
12397
  "database": {
12398
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12260
12399
  "name": "database"
12261
12400
  },
12262
12401
  "value": {
12402
+ "description": "boolean indicating if a message gets logged when a session waits longer than the deadlock_timeout to acquire a lock",
12263
12403
  "name": "value"
12264
12404
  }
12265
12405
  },
@@ -12303,9 +12443,11 @@
12303
12443
  "aliases": [],
12304
12444
  "args": {
12305
12445
  "database": {
12446
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12306
12447
  "name": "database"
12307
12448
  },
12308
12449
  "value": {
12450
+ "description": "milliseconds to wait for a statement to complete before logging it",
12309
12451
  "name": "value"
12310
12452
  }
12311
12453
  },
@@ -12349,6 +12491,7 @@
12349
12491
  "aliases": [],
12350
12492
  "args": {
12351
12493
  "database": {
12494
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12352
12495
  "name": "database"
12353
12496
  },
12354
12497
  "value": {
@@ -12401,9 +12544,11 @@
12401
12544
  "aliases": [],
12402
12545
  "args": {
12403
12546
  "database": {
12547
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12404
12548
  "name": "database"
12405
12549
  },
12406
12550
  "value": {
12551
+ "description": "type of SQL statements to log\n<options: none|ddl|mod|all>",
12407
12552
  "name": "value",
12408
12553
  "options": [
12409
12554
  "none",
@@ -12453,9 +12598,11 @@
12453
12598
  "aliases": [],
12454
12599
  "args": {
12455
12600
  "database": {
12601
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
12456
12602
  "name": "database"
12457
12603
  },
12458
12604
  "value": {
12605
+ "description": "function type to track\n<options: none|pl|all>",
12459
12606
  "name": "value",
12460
12607
  "options": [
12461
12608
  "none",
@@ -12654,6 +12801,7 @@
12654
12801
  ],
12655
12802
  "args": {
12656
12803
  "url": {
12804
+ "description": "URL to replace the log drain with",
12657
12805
  "name": "url",
12658
12806
  "required": true
12659
12807
  }
@@ -12886,6 +13034,7 @@
12886
13034
  "aliases": [],
12887
13035
  "args": {
12888
13036
  "source": {
13037
+ "description": "IP address in CIDR notation",
12889
13038
  "name": "source",
12890
13039
  "required": true
12891
13040
  }
@@ -12979,6 +13128,7 @@
12979
13128
  "aliases": [],
12980
13129
  "args": {
12981
13130
  "source": {
13131
+ "description": "IP address in CIDR notation",
12982
13132
  "name": "source",
12983
13133
  "required": true
12984
13134
  }
@@ -13438,6 +13588,7 @@
13438
13588
  "aliases": [],
13439
13589
  "args": {
13440
13590
  "id": {
13591
+ "description": "ID of the webhook event",
13441
13592
  "name": "id",
13442
13593
  "required": true
13443
13594
  }
@@ -13543,6 +13694,7 @@
13543
13694
  "aliases": [],
13544
13695
  "args": {
13545
13696
  "id": {
13697
+ "description": "ID of the webhook event",
13546
13698
  "name": "id",
13547
13699
  "required": true
13548
13700
  }
@@ -13598,9 +13750,11 @@
13598
13750
  "aliases": [],
13599
13751
  "args": {
13600
13752
  "database": {
13753
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
13601
13754
  "name": "database"
13602
13755
  },
13603
13756
  "value": {
13757
+ "description": "boolean indicating if execution plans get logged",
13604
13758
  "name": "value"
13605
13759
  }
13606
13760
  },
@@ -13645,9 +13799,11 @@
13645
13799
  "aliases": [],
13646
13800
  "args": {
13647
13801
  "database": {
13802
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
13648
13803
  "name": "database"
13649
13804
  },
13650
13805
  "value": {
13806
+ "description": "boolean indicating if the database has buffer statistics enabled",
13651
13807
  "name": "value"
13652
13808
  }
13653
13809
  },
@@ -13692,9 +13848,11 @@
13692
13848
  "aliases": [],
13693
13849
  "args": {
13694
13850
  "database": {
13851
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
13695
13852
  "name": "database"
13696
13853
  },
13697
13854
  "value": {
13855
+ "description": "format of the log output\n<options: text|json|yaml|xml>",
13698
13856
  "name": "value",
13699
13857
  "options": [
13700
13858
  "text",
@@ -13745,9 +13903,11 @@
13745
13903
  "aliases": [],
13746
13904
  "args": {
13747
13905
  "database": {
13906
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
13748
13907
  "name": "database"
13749
13908
  },
13750
13909
  "value": {
13910
+ "description": "minimum duration in milliseconds for queries before logging execution plans. A value of -1 disables it. A value of 0 logs all query execution plans.",
13751
13911
  "name": "value"
13752
13912
  }
13753
13913
  },
@@ -13792,9 +13952,11 @@
13792
13952
  "aliases": [],
13793
13953
  "args": {
13794
13954
  "database": {
13955
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
13795
13956
  "name": "database"
13796
13957
  },
13797
13958
  "value": {
13959
+ "description": "boolean indicating if execution plan logs include nested statements",
13798
13960
  "name": "value"
13799
13961
  }
13800
13962
  },
@@ -13839,9 +14001,11 @@
13839
14001
  "aliases": [],
13840
14002
  "args": {
13841
14003
  "database": {
14004
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
13842
14005
  "name": "database"
13843
14006
  },
13844
14007
  "value": {
14008
+ "description": "boolean indicating if the database has trigger execution statistics enabled",
13845
14009
  "name": "value"
13846
14010
  }
13847
14011
  },
@@ -13886,9 +14050,11 @@
13886
14050
  "aliases": [],
13887
14051
  "args": {
13888
14052
  "database": {
14053
+ "description": "config var containing the connection string, unique name, ID, or alias of the database. To access another app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use DATABASE_URL.",
13889
14054
  "name": "database"
13890
14055
  },
13891
14056
  "value": {
14057
+ "description": "boolean indicating if the database has verbose execution plan logging enabled",
13892
14058
  "name": "value"
13893
14059
  }
13894
14060
  },
@@ -13930,5 +14096,5 @@
13930
14096
  ]
13931
14097
  }
13932
14098
  },
13933
- "version": "9.3.2"
14099
+ "version": "9.4.0-beta.0"
13934
14100
  }