README.md

Heroku CLI Addons Admin Plugin

Heroku CLI plugin to help Heroku add-on providers integrate their services with Heroku.

• Heroku CLI Addons Admin Plugin
• Installation
• Usage
• Development
• Commands

Installation

$ heroku plugins:install @heroku-cli/plugin-addons-admin

Usage

$ npm install -g @heroku-cli/plugin-addons-admin
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-addons-admin/2.4.0 darwin-x64 node-v16.20.2
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Development

Follow the Developing CLI Plugins guide.

Commands

• heroku addons:admin:manifest:diff
• heroku addons:admin:manifest:generate
• heroku addons:admin:manifest:pull [SLUG]
• heroku addons:admin:manifest:push
• heroku addons:admin:manifests [SLUG]
• heroku addons:admin:manifests:info [SLUG]
• heroku addons:admin:open [SLUG]

heroku addons:admin:manifest:diff

compares remote manifest to local manifest and finds differences

USAGE
  $ heroku addons:admin:manifest:diff

See code: src/commands/addons/admin/manifest/diff.ts

heroku addons:admin:manifest:generate

generate a manifest template

USAGE
  $ heroku addons:admin:manifest:generate

OPTIONS
  -a, --addon=addon  add-on name (name displayed on addon dashboard)
  -s, --slug=slug    slugname/manifest id

EXAMPLE
  $ heroku addons:admin:generate
  The file has been saved!

See code: src/commands/addons/admin/manifest/generate.ts

heroku addons:admin:manifest:pull [SLUG]

pull a manifest for a given slug

USAGE
  $ heroku addons:admin:manifest:pull [SLUG]

ARGUMENTS
  SLUG  slug name of add-on

EXAMPLE
  $ heroku addons:admin:manifest:pull testing-123
   ...
   Fetching add-on manifest for testing-123... done
   Updating addon-manifest.json... done

See code: src/commands/addons/admin/manifest/pull.ts

heroku addons:admin:manifest:push

update remote manifest

USAGE
  $ heroku addons:admin:manifest:push

EXAMPLE
  $ heroku addons:admin:manifest:push
   ...
   Pushing manifest... done
   Updating addon-manifest.json... done

See code: src/commands/addons/admin/manifest/push.ts

heroku addons:admin:manifests [SLUG]

list manifest history

USAGE
  $ heroku addons:admin:manifests [SLUG]

See code: src/commands/addons/admin/manifests.ts

heroku addons:admin:manifests:info [SLUG]

show an individual history manifest

USAGE
  $ heroku addons:admin:manifests:info [SLUG]

OPTIONS
  -m, --manifest=manifest  (required) manifest history id

See code: src/commands/addons/admin/manifests/info.ts

heroku addons:admin:open [SLUG]

open add-on dashboard

USAGE
  $ heroku addons:admin:open [SLUG]

ARGUMENTS
  SLUG  slug name of add-on

EXAMPLE
  $ heroku addons:admin:open
  Checking addon-manifest.json... done
  Opening https://addons-next.heroku.com/addons/testing-123... done

See code: src/commands/addons/admin/open.ts