Skip to content

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

License

Notifications You must be signed in to change notification settings

heroku/heroku-cli-addons-admin

Repository files navigation

Heroku CLI Addons Admin Plugin

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

Version Downloads/week License

Installation

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

Usage

$ npm install -g @heroku-cli/plugin-addons-admin
$ heroku COMMAND
running command...
$ heroku (--version)
@heroku-cli/plugin-addons-admin/3.0.0 darwin-x64 node-v20.18.2
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Development

Follow the Developing CLI Plugins guide.

Commands

heroku addons:admin:manifest:diff

compares remote manifest to local manifest and finds differences

USAGE
  $ heroku addons:admin:manifest:diff

DESCRIPTION
  compares remote manifest to local manifest and finds differences

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

heroku addons:admin:manifest:generate

generate a manifest template

USAGE
  $ heroku addons:admin:manifest:generate [-a <value>] [-s <value>]

FLAGS
  -a, --addon=<value>  add-on name (name displayed on addon dashboard)
  -s, --slug=<value>   slugname/manifest id

DESCRIPTION
  generate a manifest template

EXAMPLES
  $ 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

DESCRIPTION
  pull a manifest for a given slug

EXAMPLES
  $ 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

DESCRIPTION
  update remote manifest

EXAMPLES
  $ 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]

ARGUMENTS
  SLUG  slug name of add-on

DESCRIPTION
  list manifest history

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] -m <value>

ARGUMENTS
  SLUG  slug name of add-on

FLAGS
  -m, --manifest=<value>  (required) manifest history id

DESCRIPTION
  show an individual history manifest

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

DESCRIPTION
  open add-on dashboard

EXAMPLES
  $ 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

About

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

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages