@heroku-cli/plugin-addons-v5
Advanced tools
heroku addons [--all|--app APP]heroku addons:attach ADDON_NAMEheroku addons:create SERVICE:PLANheroku addons:destroy [ADDON]... [flags]heroku addons:detach ATTACHMENT_NAMEheroku addons:docs ADDONheroku addons:downgrade ADDON [PLAN]heroku addons:info ADDONheroku addons:open ADDONheroku addons:plans SERVICEheroku addons:rename ADDON NEW_NAMEheroku addons:servicesheroku addons:upgrade ADDON [PLAN]heroku addons:wait ADDONheroku 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_NAMEattach 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:PLANcreate 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_NAMEdetach 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 ADDONopen 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 ADDONshow 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 ADDONopen 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 SERVICElist 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_NAMErename 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:serviceslist 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 ADDONshow 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
8.11.2 (2024-04-10)
Note: Version bump only for package heroku
FAQs
`heroku addons:*` commands
The npm package @heroku-cli/plugin-addons-v5 receives a total of 4,134 weekly downloads. As such, @heroku-cli/plugin-addons-v5 popularity was classified as popular.
We found that @heroku-cli/plugin-addons-v5 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 51 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.