heroku 11.0.0-alpha.11 → 11.0.0-alpha.13

package/README.md

@@ -15,9 +15,19 @@ To get started see <https://devcenter.heroku.com/start>
 Overview
 ========
 
-This is the next generation Node-based Heroku CLI.  The goals of this project were to make plugins more flexible, remove Ruby as a runtime dependency, and make the CLI faster.
+The Heroku CLI is a command-line interface for managing Heroku applications and services. Built with Node.js and [oclif](https://oclif.io), it provides an extensible architecture for interacting with the Heroku platform.
 
-It has identical functionality to the old Ruby CLI. Under the hood, it is a modular CLI made up of node.js plugins.
+Key features include:
+
+- **App management** - Deploy, scale, and monitor your applications
+- **Heroku Postgres database management** - Backup, restore, and manage Heroku Postgres databases
+- **Heroku CI/CD pipelines** - Run automated tests and manage review apps for streamlined deployment workflows
+- **Add-ons marketplace** - Provision and manage tools and services to extend your application
+- **SSL certificates and domains** - Configure custom domains and automatically manage SSL/TLS certificates
+- **Team collaboration** - Manage organization and team access with granular permissions
+- **Private Spaces** - Deploy applications in network-isolated environments with VPN support
+- **Logs and monitoring** - Stream application logs and forward them to external services
+- **Plugin ecosystem** - Extend functionality with community and custom plugins
 
 For more on developing plugins, read [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)
 
@@ -40,6 +50,7 @@ For other issues, [submit a support ticket](https://help.heroku.com/).
 * [`heroku apps`](docs/apps.md) - manage apps on Heroku
 * [`heroku auth`](docs/auth.md) - manage authentication for your Heroku account
 * [`heroku authorizations`](docs/authorizations.md) - OAuth authorizations
+* [`heroku autocomplete`](docs/autocomplete.md) - display autocomplete installation instructions
 * [`heroku buildpacks`](docs/buildpacks.md) - scripts used to compile apps
 * [`heroku certs`](docs/certs.md) - SSL certificates
 * [`heroku ci`](docs/ci.md) - test runner for Heroku Pipelines
@@ -59,12 +70,16 @@ For other issues, [submit a support ticket](https://help.heroku.com/).
 * [`heroku members`](docs/members.md) - manage organization members
 * [`heroku notifications`](docs/notifications.md) - display notifications
 * [`heroku orgs`](docs/orgs.md) - manage organizations
+* [`heroku pg`](docs/pg.md) - manage postgresql databases
 * [`heroku pipelines`](docs/pipelines.md) - manage pipelines
 * [`heroku plugins`](docs/plugins.md) - List installed plugins.
 * [`heroku ps`](docs/ps.md) - Client tools for Heroku Exec
 * [`heroku regions`](docs/regions.md) - list available regions for deployment
+* [`heroku releases`](docs/releases.md) - display the releases for an app
 * [`heroku reviewapps`](docs/reviewapps.md) - manage reviewapps in pipelines
+* [`heroku run`](docs/run.md) - run a one-off process inside a Heroku dyno
 * [`heroku sessions`](docs/sessions.md) - OAuth sessions
+* [`heroku spaces`](docs/spaces.md) - list available spaces
 * [`heroku status`](docs/status.md) - display current status of the Heroku platform
 * [`heroku teams`](docs/teams.md) - manage teams
 * [`heroku telemetry`](docs/telemetry.md) - list telemetry drains

package/lib/commands/access/add.d.ts

@@ -1,14 +1,14 @@
 import { Command } from '@heroku-cli/command';
 export default class AccessAdd extends Command {
+    static args: {
+        email: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
+    static examples: string[];
     static flags: {
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         permissions: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    static examples: string[];
-    static args: {
-        email: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/lib/commands/access/add.js

@@ -1,27 +1,27 @@
-import { color } from '@heroku-cli/color';
+import { color } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
-import { isTeamApp, getOwner } from '../../lib/teamUtils.js';
+import { getOwner, isTeamApp } from '../../lib/teamUtils.js';
 export default class AccessAdd extends Command {
+    static args = {
+        email: Args.string({ description: 'email address of the team member', required: true }),
+    };
     static description = 'add new users to your app';
+    static examples = [
+        `${color.command('heroku access:add user@email.com --app APP')} # add a collaborator to your app`,
+        `${color.command('heroku access:add user@email.com --app APP --permissions deploy,manage,operate')} # permissions must be comma separated`,
+    ];
     static flags = {
         app: flags.app({ required: true }),
-        remote: flags.remote({ char: 'r' }),
         permissions: flags.string({ char: 'p', description: 'list of permissions comma separated' }),
-    };
-    static examples = [
-        '$ heroku access:add user@email.com --app APP # add a collaborator to your app',
-        '$ heroku access:add user@email.com --app APP --permissions deploy,manage,operate # permissions must be comma separated',
-    ];
-    static args = {
-        email: Args.string({ required: true, description: 'email address of the team member' }),
+        remote: flags.remote({ char: 'r' }),
     };
     async run() {
-        const { flags, args } = await this.parse(AccessAdd);
+        const { args, flags } = await this.parse(AccessAdd);
         const { email } = args;
         const { app: appName, permissions } = flags;
         const { body: appInfo } = await this.heroku.get(`/apps/${appName}`);
-        let output = `Adding ${color.cyan(email)} access to the app ${color.magenta(appName)}`;
+        let output = `Adding ${color.user(email)} access to the app ${color.app(appName)}`;
         let teamFeatures = [];
         if (isTeamApp(appInfo?.owner?.email)) {
             const teamName = getOwner(appInfo?.owner?.email);
@@ -37,7 +37,7 @@ export default class AccessAdd extends Command {
             output += ` with ${color.green(permissionsArraySorted.join(', '))} permissions`;
             ux.action.start(output);
             await this.heroku.post(`/teams/apps/${appName}/collaborators`, {
-                body: { user: email, permissions: permissionsArraySorted },
+                body: { permissions: permissionsArraySorted, user: email },
             });
             ux.action.stop();
         }

package/lib/commands/access/index.d.ts

@@ -1,11 +1,11 @@
 import { Command } from '@heroku-cli/command';
 export default class AccessIndex extends Command {
     static description: string;
-    static topic: string;
     static flags: {
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
+    static topic: string;
     run(): Promise<void>;
 }

package/lib/commands/access/index.js

@@ -1,20 +1,19 @@
-import { color } from '@heroku-cli/color';
+import { color, hux } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { HerokuAPIError } from '@heroku-cli/command/lib/api-client.js';
 import { ux } from '@oclif/core';
-import { hux } from '@heroku/heroku-cli-util';
 import _ from 'lodash';
-import { isTeamApp, getOwner } from '../../lib/teamUtils.js';
+import { getOwner, isTeamApp } from '../../lib/teamUtils.js';
 function printJSON(collaborators) {
     ux.stdout(JSON.stringify(collaborators, null, 2));
 }
 function buildTableColumns(showPermissions) {
     const baseColumns = {
         email: {
-            get: ({ email }) => color.cyan(email),
+            get: ({ email }) => color.user(email),
         },
         role: {
-            get: ({ role }) => color.green(role),
+            get: ({ role }) => color.info(role),
         },
     };
     if (showPermissions) {
@@ -32,7 +31,7 @@ function printAccess(app, collaborators) {
         .reject(c => /herokumanager\.com$/.test(c.user.email))
         .map(collab => {
         const { email } = collab.user;
-        const { role, permissions } = collab;
+        const { permissions, role } = collab;
         const data = { email, role: role || 'collaborator' };
         if (showPermissions) {
             data.permissions = _.map(_.sortBy(permissions, 'name'), 'name').join(', ');
@@ -49,12 +48,12 @@ function buildCollaboratorsArray(collaboratorsRaw, admins) {
 }
 export default class AccessIndex extends Command {
     static description = 'list who has access to an app';
-    static topic = 'access';
     static flags = {
         app: flags.app({ required: true }),
-        remote: flags.remote({ char: 'r' }),
         json: flags.boolean({ description: 'output in json format' }),
+        remote: flags.remote({ char: 'r' }),
     };
+    static topic = 'access';
     async run() {
         const { flags } = await this.parse(AccessIndex);
         const { app: appName, json } = flags;

package/lib/commands/access/remove.d.ts

@@ -2,11 +2,11 @@ import { Command } from '@heroku-cli/command';
 export default class AccessRemove extends Command {
     static description: string;
     static example: string;
-    static topic: string;
     static flags: {
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     static strict: boolean;
+    static topic: string;
     run(): Promise<void>;
 }

package/lib/commands/access/remove.js

@@ -1,21 +1,21 @@
-import { color } from '@heroku-cli/color';
+import { color } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { ux } from '@oclif/core';
 export default class AccessRemove extends Command {
     static description = 'remove users from a team app';
-    static example = '$ heroku access:remove user@email.com --app APP';
-    static topic = 'access';
+    static example = `${color.command('heroku access:remove user@email.com --app APP')}`;
     static flags = {
         app: flags.app({ required: true }),
         remote: flags.remote({ char: 'r' }),
     };
     static strict = false;
+    static topic = 'access';
     async run() {
-        const { flags, argv } = await this.parse(AccessRemove);
+        const { argv, flags } = await this.parse(AccessRemove);
         const { app } = flags;
         const email = argv[0];
         const appName = app;
-        ux.action.start(`Removing ${color.cyan(email)} access from the app ${color.magenta(appName)}`);
+        ux.action.start(`Removing ${color.user(email)} access from the app ${color.app(appName)}`);
         await this.heroku.delete(`/apps/${appName}/collaborators/${email}`);
         ux.action.stop();
     }

package/lib/commands/access/update.d.ts

@@ -1,14 +1,14 @@
 import { Command } from '@heroku-cli/command';
 export default class Update extends Command {
-    static topic: string;
+    static args: {
+        email: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
     static flags: {
-        permissions: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        permissions: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    static args: {
-        email: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
+    static topic: string;
     run(): Promise<void>;
 }

package/lib/commands/access/update.js

@@ -1,32 +1,32 @@
-import { color } from '@heroku-cli/color';
+import { color } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
 import { isTeamApp } from '../../lib/teamUtils.js';
 export default class Update extends Command {
-    static topic = 'access';
+    static args = {
+        email: Args.string({ description: 'email address of the team member', required: true }),
+    };
     static description = 'update existing collaborators on an team app';
     static flags = {
+        app: flags.app({ required: true }),
         permissions: flags.string({
             char: 'p',
             description: 'comma-delimited list of permissions to update (deploy,manage,operate)',
             required: true,
         }),
-        app: flags.app({ required: true }),
         remote: flags.remote(),
     };
-    static args = {
-        email: Args.string({ required: true, description: 'email address of the team member' }),
-    };
+    static topic = 'access';
     async run() {
-        const { flags, args } = await this.parse(Update);
+        const { args, flags } = await this.parse(Update);
         const appName = flags.app;
         let permissions = flags.permissions.split(',');
         const { body: appInfo } = await this.heroku.get(`/apps/${appName}`);
         if (!isTeamApp(appInfo?.owner?.email))
-            this.error(`Error: cannot update permissions. The app ${color.cyan(appName)} is not owned by a team`);
+            this.error(`Error: cannot update permissions. The app ${color.app(appName)} is not owned by a team`);
         permissions.push('view');
         permissions = Array.from(new Set(permissions.sort()));
-        ux.action.start(`Updating ${args.email} in application ${color.cyan(appName)} with ${permissions} permissions`);
+        ux.action.start(`Updating ${color.user(args.email)} in application ${color.app(appName)} with ${permissions} permissions`);
         await this.heroku.patch(`/teams/apps/${appName}/collaborators/${args.email}`, {
             body: { permissions },
         });

package/lib/commands/accounts/add.d.ts

@@ -1,9 +1,9 @@
 import { Command } from '@heroku-cli/command';
 export default class Add extends Command {
-    static description: string;
     static args: {
         name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
+    static description: string;
     static example: string;
     run(): Promise<void>;
 }

package/lib/commands/accounts/add.js

@@ -1,12 +1,13 @@
+import { color } from '@heroku/heroku-cli-util';
 import { Command } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
 import AccountsModule from '../../lib/accounts/accounts.js';
 export default class Add extends Command {
-    static description = 'add a Heroku account to your cache';
     static args = {
         name: Args.string({ description: 'name of Heroku account to add', required: true }),
     };
-    static example = 'heroku accounts:add my-account';
+    static description = 'add a Heroku account to your cache';
+    static example = `${color.command('heroku accounts:add my-account')}`;
     async run() {
         const { args } = await this.parse(Add);
         const { name } = args;

package/lib/commands/accounts/current.js

@@ -1,18 +1,17 @@
+import { color, hux } from '@heroku/heroku-cli-util';
 import { Command } from '@heroku-cli/command';
 import { ux } from '@oclif/core';
-import { hux } from '@heroku/heroku-cli-util';
 import AccountsModule from '../../lib/accounts/accounts.js';
-import { color } from '@heroku-cli/color';
 export default class Current extends Command {
     static description = 'display the current Heroku account';
-    static example = 'heroku accounts:current';
+    static example = `${color.command('heroku accounts:current')}`;
     async run() {
         const accountName = await AccountsModule.current();
         if (accountName) {
-            hux.styledHeader(`Current account is ${accountName}`);
+            hux.styledHeader(`Current account is ${color.user(accountName)}`);
         }
         else {
-            ux.error(`You haven't set an account. Run ${color.cmd('heroku accounts:add <account-name>')} to add an account to your cache or ${color.cmd('heroku accounts:set <account-name>')} to set the current account.`);
+            ux.error(`You haven't set an account. Run ${color.code('heroku accounts:add <account-name>')} to add an account to your cache or ${color.code('heroku accounts:set <account-name>')} to set the current account.`);
         }
     }
 }

package/lib/commands/accounts/index.js

@@ -1,9 +1,10 @@
+import { color } from '@heroku/heroku-cli-util';
 import { Command } from '@heroku-cli/command';
 import { ux } from '@oclif/core';
 import accountsModule from '../../lib/accounts/accounts.js';
 export default class AccountsIndex extends Command {
     static description = 'list the Heroku accounts in your cache';
-    static example = 'heroku accounts';
+    static example = `${color.command('heroku accounts')}`;
     async run() {
         const accounts = accountsModule.list();
         if (accounts.length === 0) {

package/lib/commands/accounts/remove.d.ts

@@ -1,9 +1,9 @@
 import { Command } from '@heroku-cli/command';
 export default class Remove extends Command {
-    static description: string;
     static args: {
         name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
+    static description: string;
     static example: string;
     run(): Promise<void>;
 }

package/lib/commands/accounts/remove.js

@@ -1,12 +1,13 @@
+import { color } from '@heroku/heroku-cli-util';
 import { Command } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
 import AccountsModule from '../../lib/accounts/accounts.js';
 export default class Remove extends Command {
-    static description = 'remove a Heroku account from your cache';
     static args = {
         name: Args.string({ description: 'name of Heroku account to remove', required: true }),
     };
-    static example = 'heroku accounts:remove my-account';
+    static description = 'remove a Heroku account from your cache';
+    static example = `${color.command('heroku accounts:remove my-account')}`;
     async run() {
         const { args } = await this.parse(Remove);
         const { name } = args;

package/lib/commands/accounts/set.d.ts

@@ -1,9 +1,9 @@
 import { Command } from '@heroku-cli/command';
 export default class Set extends Command {
-    static description: string;
     static args: {
         name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
+    static description: string;
     static example: string;
     run(): Promise<void>;
 }

package/lib/commands/accounts/set.js

@@ -1,12 +1,13 @@
+import { color } from '@heroku/heroku-cli-util';
 import { Command } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
 import AccountsModule from '../../lib/accounts/accounts.js';
 export default class Set extends Command {
-    static description = 'set the current Heroku account from your cache';
     static args = {
         name: Args.string({ description: 'name of account to set', required: true }),
     };
-    static example = 'heroku accounts:set my-account';
+    static description = 'set the current Heroku account from your cache';
+    static example = `${color.command('heroku accounts:set my-account')}`;
     async run() {
         const { args } = await this.parse(Set);
         const { name } = args;

package/lib/commands/addons/attach.d.ts

@@ -1,16 +1,16 @@
 import { Command } from '@heroku-cli/command';
 export default class Attach extends Command {
-    static topic: string;
+    static args: {
+        addon_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
     static flags: {
+        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         as: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        credential: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         confirm: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        credential: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    static args: {
-        addon_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
+    static topic: string;
     run(): Promise<void>;
 }

package/lib/commands/addons/attach.js

@@ -1,23 +1,23 @@
-import { color } from '@heroku-cli/color';
+import { color } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
 import { trapConfirmationRequired } from '../../lib/addons/util.js';
 export default class Attach extends Command {
-    static topic = 'addons';
+    static args = {
+        addon_name: Args.string({ description: 'unique identifier or globally unique name of the add-on', required: true }),
+    };
     static description = 'attach an existing add-on resource to an app';
     static flags = {
+        app: flags.app({ required: true }),
         as: flags.string({ description: 'name for add-on attachment' }),
-        credential: flags.string({ description: 'credential name for scoped access to Heroku Postgres' }),
         confirm: flags.string({ description: 'overwrite existing add-on attachment with same name' }),
-        app: flags.app({ required: true }),
+        credential: flags.string({ description: 'credential name for scoped access to Heroku Postgres' }),
         remote: flags.remote(),
     };
-    static args = {
-        addon_name: Args.string({ required: true, description: 'unique identifier or globally unique name of the add-on' }),
-    };
+    static topic = 'addons';
     async run() {
-        const { flags, args } = await this.parse(Attach);
-        const { app, credential, as, confirm } = flags;
+        const { args, flags } = await this.parse(Attach);
+        const { app, as, confirm, credential } = flags;
         const { body: addon } = await this.heroku.get(`/addons/${encodeURIComponent(args.addon_name)}`);
         const createAttachment = async (confirmed) => {
             let namespace;
@@ -25,9 +25,9 @@ export default class Attach extends Command {
                 namespace = 'credential:' + credential;
             }
             const body = {
-                name: as, app: { name: app }, addon: { name: addon.name }, confirm: confirmed, namespace,
+                addon: { name: addon.name }, app: { name: app }, confirm: confirmed, name: as, namespace,
             };
-            ux.action.start(`Attaching ${credential ? color.yellow(credential) + ' of ' : ''}${color.yellow(addon.name || '')}${as ? ' as ' + color.cyan(as) : ''} to ${color.magenta(app)}`);
+            ux.action.start(`Attaching ${credential ? color.name(credential) + ' of ' : ''}${color.datastore(addon.name || '')}${as ? ' as ' + color.attachment(as) : ''} to ${color.app(app)}`);
             const { body: attachments } = await this.heroku.post('/addon-attachments', { body });
             ux.action.stop();
             return attachments;
@@ -35,13 +35,13 @@ export default class Attach extends Command {
         if (credential && credential !== 'default') {
             const { body: credentialConfig } = await this.heroku.get(`/addons/${addon.name}/config/credential:${encodeURIComponent(credential)}`);
             if (credentialConfig.length === 0) {
-                throw new Error(`Could not find credential ${credential} for database ${addon.name}`);
+                throw new Error(`Could not find credential ${color.name(credential)} for database ${color.datastore(addon.name || '')}`);
             }
         }
         const attachment = await trapConfirmationRequired(app, confirm, (confirmed) => createAttachment(confirmed));
-        ux.action.start(`Setting ${color.cyan(attachment.name || '')} config vars and restarting ${color.magenta(app)}`);
+        ux.action.start(`Setting ${color.attachment(attachment.name || '')} config vars and restarting ${color.app(app)}`);
         const { body: releases } = await this.heroku.get(`/apps/${app}/releases`, {
-            partial: true, headers: { Range: 'version ..; max=1, order=desc' },
+            headers: { Range: 'version ..; max=1, order=desc' }, partial: true,
         });
         ux.action.stop(`done, v${releases[0].version}`);
     }

package/lib/commands/addons/create.d.ts

@@ -1,21 +1,20 @@
 import { Command } from '@heroku-cli/command';
 export default class Create extends Command {
-    static topic: string;
+    static args: {
+        'service:plan': import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
-    static example: string;
-    static strict: boolean;
-    static hiddenAliases: string[];
+    static examples: string[];
     static flags: {
-        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         as: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         confirm: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        wait: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        wait: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    static args: {
-        'service:plan': import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
+    static hiddenAliases: string[];
     static notifier: (subtitle: string, message: string, success?: boolean) => void;
+    static strict: boolean;
     run(): Promise<void>;
 }

package/lib/commands/addons/create.js

@@ -1,9 +1,9 @@
-import { color } from '@heroku-cli/color';
+import { color } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
-import notify from '../../lib/notify.js';
-import createAddon from '../../lib/addons/create_addon.js';
 import tsheredoc from 'tsheredoc';
+import createAddon from '../../lib/addons/create_addon.js';
+import notify from '../../lib/notify.js';
 const heredoc = tsheredoc.default;
 function parseConfig(args) {
     const config = {};
@@ -38,49 +38,51 @@ function parseConfig(args) {
     return config;
 }
 export default class Create extends Command {
-    static topic = 'addons';
+    static args = {
+        'service:plan': Args.string({ description: 'unique identifier or unique name of the add-on service plan', required: true }),
+    };
     static description = heredoc `
-  Create a new add-on resource.
-
-  In order to add additional config items, please place them at the end of the command after a double-dash (--).
-  `;
-    static example = heredoc `
-  Create an add-on resource:
-  $heroku addons:create heroku-redis --app my-app
+    Create a new add-on resource.
 
-  Create an add-on resource with additional config items:
-  $heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE
+    In order to add additional config items, please place them at the end of the command after a double-dash (--).
   `;
-    static strict = false;
-    static hiddenAliases = ['addons:add'];
+    static examples = [
+        heredoc(`
+      # Create an add-on resource:
+      ${color.command('heroku addons:create heroku-redis --app my-app')}
+    `),
+        heredoc(`
+      # Create an add-on resource with additional config items:
+      ${color.command('heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE')}
+    `),
+    ];
     static flags = {
-        name: flags.string({ description: 'name for the add-on resource' }),
+        app: flags.app({ required: true }),
         as: flags.string({ description: 'name for the initial add-on attachment' }),
         confirm: flags.string({ description: 'overwrite existing config vars or existing add-on attachments' }),
-        wait: flags.boolean({ description: 'watch add-on creation status and exit when complete' }),
-        app: flags.app({ required: true }),
+        name: flags.string({ description: 'name for the add-on resource' }),
         remote: flags.remote(),
+        wait: flags.boolean({ description: 'watch add-on creation status and exit when complete' }),
     };
-    static args = {
-        'service:plan': Args.string({ required: true, description: 'unique identifier or unique name of the add-on service plan' }),
-    };
+    static hiddenAliases = ['addons:add'];
     static notifier = notify;
+    static strict = false;
     async run() {
         this.allowArbitraryFlags = true;
-        const { flags, args, ...restParse } = await this.parse(Create);
-        const { app, name, as, wait, confirm } = flags;
+        const { args, flags, ...restParse } = await this.parse(Create);
+        const { app, as, confirm, name, wait } = flags;
         const servicePlan = args['service:plan'];
+        // oclif duplicates specified args in argv
         const argv = restParse.argv
-            // oclif duplicates specified args in argv
             .filter(arg => arg !== servicePlan);
         if (restParse.nonExistentFlags && restParse.nonExistentFlags.length > 0) {
-            process.stderr.write(` ${color.yellow('›')}   For example: ${color.cyan(`heroku addons:create -a ${app} ${restParse.raw[0].input} -- ${restParse.nonExistentFlags.join(' ')}`)}`);
-            process.stderr.write(` ${color.yellow('›')}   See https://devcenter.heroku.com/changelog-items/2925 for more info.\n`);
+            ux.warn(`For example: ${color.code(`heroku addons:create -a ${app} ${restParse.raw[0].input} -- ${restParse.nonExistentFlags.join(' ')}`)}`);
+            ux.warn(`See ${color.info('https://devcenter.heroku.com/changelog-items/2925')} for more info.\n`);
         }
         const config = parseConfig(argv);
         let addon;
         try {
-            addon = await createAddon(this.heroku, app, servicePlan, confirm, wait, { config, name, as });
+            addon = await createAddon(this.heroku, app, servicePlan, confirm, wait, { as, config, name });
             if (wait) {
                 Create.notifier(`heroku addons:create ${addon.name}`, 'Add-on successfully provisioned');
             }
@@ -91,8 +93,8 @@ export default class Create extends Command {
             }
             throw error;
         }
-        await this.config.runHook('recache', { type: 'addon', app, addon });
+        await this.config.runHook('recache', { addon, app, type: 'addon' });
         // eslint-disable-next-line no-unsafe-optional-chaining
-        ux.stdout(`Use ${color.cyan.bold('heroku addons:docs ' + addon?.addon_service?.name || '')} to view documentation`);
+        ux.stdout(`Run ${color.code('heroku addons:docs ' + addon?.addon_service?.name || '')} to view documentation.`);
     }
 }