Skip to content

Latest commit

 

History

History
419 lines (288 loc) · 11.7 KB

addons.md

File metadata and controls

419 lines (288 loc) · 11.7 KB

heroku addons

tools and services for developing, extending, and operating your app

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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

See code: src/commands/addons/index.ts

heroku addons:attach ADDON_NAME

attach an existing add-on resource to an app

USAGE
  $ heroku addons:attach ADDON_NAME -a <value> [--prompt] [--as <value>] [--confirm <value>] [--credential <value>]
    [-r <value>]

ARGUMENTS
  ADDON_NAME  unique identifier or globally unique name of the add-on

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  attach an existing add-on resource to an app

See code: src/commands/addons/attach.ts

heroku addons:create SERVICE:PLAN

Create a new add-on resource.

USAGE
  $ heroku addons:create SERVICE:PLAN... -a <value> [--prompt] [--as <value>] [--confirm <value>] [--name <value>]
    [-r <value>] [--wait]

ARGUMENTS
  SERVICE:PLAN...  unique identifier or unique name of the add-on service plan

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  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 (--).


EXAMPLES
  # Create an add-on resource:
   $ heroku addons:create heroku-redis --app my-app 

  # Create an add-on resource with additional config items:
   $ heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE

See code: src/commands/addons/create.ts

heroku addons:destroy ADDONNAME

permanently destroy an add-on resource

USAGE
  $ heroku addons:destroy ADDONNAME... [--prompt] [-a <value>] [-c <value>] [-f] [-r <value>] [--wait]

ARGUMENTS
  ADDONNAME...  unique identifier or globally unique name of the add-on

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  permanently destroy an add-on resource

EXAMPLES
   $ addons:destroy [ADDON]... [flags]

See code: src/commands/addons/destroy.ts

heroku addons:detach ATTACHMENT_NAME

detach an existing add-on resource from an app

USAGE
  $ heroku addons:detach ATTACHMENT_NAME -a <value> [--prompt] [-r <value>]

ARGUMENTS
  ATTACHMENT_NAME  unique identifier of the add-on attachment

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  detach an existing add-on resource from an app

See code: src/commands/addons/detach.ts

heroku addons:docs ADDON

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

USAGE
  $ heroku addons:docs ADDON [--prompt] [-a <value>] [-r <value>] [--show-url]

ARGUMENTS
  ADDON  unique identifier or globally unique name of the add-on

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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

See code: src/commands/addons/docs.ts

heroku addons:downgrade ADDON [PLAN]

change add-on plan.

USAGE
  $ heroku addons:downgrade ADDON [PLAN] [--prompt] [-a <value>] [-r <value>]

ARGUMENTS
  ADDON   unique identifier or globally unique name of the add-on
  [PLAN]  unique identifier or name of the plan

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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


ALIASES
  $ heroku addons:downgrade

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

ARGUMENTS
  ADDON  unique identifier or globally unique name of the add-on

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  show detailed add-on resource and attachment information

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

heroku addons:open ADDON

open an add-on's dashboard in your browser

USAGE
  $ heroku addons:open ADDON [--prompt] [-a <value>] [-r <value>] [--show-url]

ARGUMENTS
  ADDON  unique identifier or globally unique name of the add-on

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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

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

heroku addons:plans SERVICE

list all available plans for an add-on service

USAGE
  $ heroku addons:plans SERVICE [--prompt] [--json]

ARGUMENTS
  SERVICE  unique identifier or globally unique name of the add-on

FLAGS
  --json  output in json format

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  list all available plans for an add-on service

See code: src/commands/addons/plans.ts

heroku addons:rename ADDON_NAME NEW_NAME

rename an add-on

USAGE
  $ heroku addons:rename ADDON_NAME NEW_NAME [--prompt]

ARGUMENTS
  ADDON_NAME  unique identifier or globally unique name of the add-on
  NEW_NAME    new globally unique name of the add-on

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  rename an add-on

See code: src/commands/addons/rename.ts

heroku addons:services

list all available add-on services

USAGE
  $ heroku addons:services [--prompt] [--json]

FLAGS
  --json  output in json format

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  list all available add-on services

See code: src/commands/addons/services.ts

heroku addons:upgrade ADDON [PLAN]

change add-on plan.

USAGE
  $ heroku addons:upgrade ADDON [PLAN] [--prompt] [-a <value>] [-r <value>]

ARGUMENTS
  ADDON   unique identifier or globally unique name of the add-on
  [PLAN]  unique identifier or name of the plan

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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


ALIASES
  $ heroku addons:downgrade

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

See code: src/commands/addons/upgrade.ts

heroku addons:wait [ADDON]

show provisioning status of the add-ons on the app

USAGE
  $ heroku addons:wait [ADDON] [--prompt] [-a <value>] [-r <value>] [--wait-interval <value>]

ARGUMENTS
  [ADDON]  unique identifier or globally unique name of the add-on

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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

See code: src/commands/addons/wait.ts