@heroku-cli/plugin-addons-v5

`heroku addons:*` commands

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@heroku-cli/plugin-addons-v5
8512018.11.13 days ago6 years agoMinified + gzip package size for @heroku-cli/plugin-addons-v5 in KB

Readme

heroku-cli-addons Circle CI
Code Climate npm version License
js-standard-style

heroku addons [--all|--app APP]

lists your add-ons and attachments
USAGE
  $ heroku addons [--all|--app APP]

FLAGS
  -A, --all             show add-ons and attachments for all accessible apps
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use
  --json                return add-ons in json format

DESCRIPTION
  lists your add-ons and attachments
  The default filter applied depends on whether you are in a Heroku app
  directory. If so, the --app flag is implied. If not, the default of --all
  is implied. Explicitly providing either flag overrides the default
  behavior.

EXAMPLES
  $ heroku addons --all

  $ heroku addons --app acme-inc-www

heroku addons:attach ADDON_NAME

attach an existing add-on resource to an app
USAGE
  $ heroku addons:attach ADDON_NAME -a <value> [--as <value>] [--credential <value>] [--confirm <value>] [-r
    <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
  --as=<value>          name for add-on attachment
  --confirm=<value>     overwrite existing add-on attachment with same name
  --credential=<value>  credential name for scoped access to Heroku Postgres

DESCRIPTION
  attach an existing add-on resource to an app

heroku addons:create SERVICE:PLAN

create a new add-on resource
USAGE
  $ heroku addons:create SERVICE:PLAN -a <value> [--name <value>] [--as <value>] [--confirm <value>] [--wait] [-r
    <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
  --as=<value>          name for the initial add-on attachment
  --confirm=<value>     overwrite existing config vars or existing add-on attachments
  --name=<value>        name for the add-on resource
  --wait                watch add-on creation status and exit when complete

DESCRIPTION
  create a new add-on resource

heroku addons:destroy [ADDON]... [flags]

permanently destroy an add-on resource
USAGE
  $ heroku addons:destroy [ADDON]... [flags]

FLAGS
  -a, --app=<value>      app to run command against
  -c, --confirm=<value>
  -f, --force            allow destruction even if connected to other apps
  -r, --remote=<value>   git remote of app to use
  --wait                 watch add-on destruction status and exit when complete

DESCRIPTION
  permanently destroy an add-on resource

heroku addons:detach ATTACHMENT_NAME

detach an existing add-on resource from an app
USAGE
  $ heroku addons:detach ATTACHMENT_NAME -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  detach an existing add-on resource from an app

heroku addons:docs ADDON

open an add-on's Dev Center documentation in your browser
USAGE
  $ heroku addons:docs ADDON [--show-url] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use
  --show-url            show URL, do not open browser

DESCRIPTION
  open an add-on's Dev Center documentation in your browser

heroku addons:downgrade ADDON [PLAN]

change add-on plan
USAGE
  $ heroku addons:downgrade ADDON [PLAN] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  change add-on plan
  See available plans with `heroku addons:plans SERVICE`.

  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.

  https://devcenter.heroku.com/articles/managing-add-ons

EXAMPLES
  Upgrade an add-on by service name:
  $ heroku addons:upgrade heroku-redis:premium-2
  Upgrade a specific add-on:
  $ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2

heroku addons:info ADDON

show detailed add-on resource and attachment information
USAGE
  $ heroku addons:info ADDON

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  show detailed add-on resource and attachment information

heroku addons:open ADDON

open an add-on's dashboard in your browser
USAGE
  $ heroku addons:open ADDON [--show-url] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use
  --show-url            show URL, do not open browser

DESCRIPTION
  open an add-on's dashboard in your browser

heroku addons:plans SERVICE

list all available plans for an add-on services
USAGE
  $ heroku addons:plans SERVICE [--json]

FLAGS
  --json  output in json format

DESCRIPTION
  list all available plans for an add-on services

heroku addons:rename ADDON NEW_NAME

rename an add-on
USAGE
  $ heroku addons:rename ADDON NEW_NAME

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  rename an add-on

heroku addons:services

list all available add-on services
USAGE
  $ heroku addons:services [--json]

FLAGS
  --json  output in json format

DESCRIPTION
  list all available add-on services

heroku addons:upgrade ADDON [PLAN]

change add-on plan
USAGE
  $ heroku addons:upgrade ADDON [PLAN] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  change add-on plan
  See available plans with `heroku addons:plans SERVICE`.

  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.

  https://devcenter.heroku.com/articles/managing-add-ons

EXAMPLES
  Upgrade an add-on by service name:
  $ heroku addons:upgrade heroku-redis:premium-2
  Upgrade a specific add-on:
  $ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2

heroku addons:wait ADDON

show provisioning status of the add-ons on the app
USAGE
  $ heroku addons:wait ADDON

FLAGS
  -a, --app=<value>        app to run command against
  -r, --remote=<value>     git remote of app to use
  --wait-interval=<value>  how frequently to poll in seconds

DESCRIPTION
  show provisioning status of the add-ons on the app