@heroku-cli/plugin-apps-v5
Advanced tools
This core plugin comes preinstalled to the Heroku CLI.
$ npm install -g @heroku-cli/plugin-apps-v5
$ heroku COMMAND
running command...
$ heroku (--version)
@heroku-cli/plugin-apps-v5/8.11.2 darwin-arm64 node-v16.19.0
$ heroku --help [COMMAND]
USAGE
$ heroku COMMAND
...
heroku appsheroku apps:create [APP]heroku apps:destroyheroku apps:errorsheroku apps:favoritesheroku apps:favorites:addheroku apps:favorites:removeheroku apps:infoheroku apps:open [PATH]heroku apps:rename NEWNAMEheroku apps:stacksheroku apps:stacks:set STACKheroku config:setheroku drainsheroku drains:add URLheroku drains:remove [URL|TOKEN]heroku dyno:kill DYNOheroku dyno:resizeheroku dyno:restart [DYNO]heroku dyno:scaleheroku dyno:stop DYNOheroku featuresheroku features:disable FEATUREheroku features:enable FEATUREheroku features:info FEATUREheroku keysheroku keys:add [KEY]heroku keys:clearheroku keys:remove KEYheroku labsheroku labs:enable FEATUREheroku labs:info FEATUREheroku maintenanceheroku maintenance:offheroku maintenance:onheroku notificationsheroku ps [TYPE [TYPE ...]]heroku ps:kill DYNOheroku ps:resizeheroku ps:restart [DYNO]heroku ps:scaleheroku ps:stop DYNOheroku ps:typeheroku releasesheroku releases:info [RELEASE]heroku releases:output [RELEASE]heroku releases:rollback [RELEASE]heroku appslist your apps
USAGE
$ heroku apps [-A] [--json] [-s <value>] [-p] [-t <value>]
FLAGS
-A, --all include apps in all teams
-p, --personal list apps in personal account when a default team is set
-s, --space=<value> filter by space
-t, --team=<value> team to use
--json output in json format
DESCRIPTION
list your apps
EXAMPLES
$ heroku apps
=== My Apps
example
example2
=== Collaborated Apps
theirapp other@owner.name
heroku apps:create [APP]creates a new app
USAGE
$ heroku apps:create [APP] [--addons <value>] [-b <value>] [-n] [-r <value>] [-s <value>] [--space <value>]
[--region <value>] [--json] [-t <value>]
ARGUMENTS
APP name of app to create
FLAGS
-b, --buildpack=<value> buildpack url to use for this app
-n, --no-remote do not create a git remote
-r, --remote=<value> the git remote to create, default "heroku"
-s, --stack=<value> the stack to create the app on
-t, --team=<value> team to use
--addons=<value> comma-delimited list of addons to install
--json output in json format
--region=<value> specify region for the app to run in
--space=<value> the private space to create the app in
DESCRIPTION
creates a new app
EXAMPLES
$ heroku apps:create
Creating app... done, stack is heroku-22
https://floating-dragon-42.heroku.com/ | https://git.heroku.com/floating-dragon-42.git
# or just
$ heroku create
# use a heroku.yml manifest file
$ heroku apps:create --manifest
# specify a buildpack
$ heroku apps:create --buildpack https://github.com/some/buildpack.git
# specify a name
$ heroku apps:create example
# create a staging app
$ heroku apps:create example-staging --remote staging
# create an app in the eu region
$ heroku apps:create --region eu
heroku apps:destroypermanently destroy an app
USAGE
$ heroku apps:destroy [APP] [-c <value>] [-a <value>] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-c, --confirm=<value>
-r, --remote=<value> git remote of app to use
DESCRIPTION
permanently destroy an app
This will also destroy all add-ons on the app.
heroku apps:errorsview app errors
USAGE
$ heroku apps:errors -a <value> [--json] [--hours <value>] [--router] [--dyno] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--dyno show only dyno errors
--hours=<value> number of hours to look back (default 24)
--json output in json format
--router show only router errors
DESCRIPTION
view app errors
heroku apps:favoriteslist favorited apps
USAGE
$ heroku apps:favorites [--json]
FLAGS
--json output in json format
DESCRIPTION
list favorited apps
heroku apps:favorites:addfavorites an app
USAGE
$ heroku apps:favorites:add -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
favorites an app
heroku apps:favorites:removeunfavorites an app
USAGE
$ heroku apps:favorites:remove -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
unfavorites an app
heroku apps:infoshow detailed app information
USAGE
$ heroku apps:info [APP] [-s] [-j] [-a <value>] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-j, --json
-r, --remote=<value> git remote of app to use
-s, --shell output more shell friendly key/value pairs
DESCRIPTION
show detailed app information
$ heroku apps:info
=== example
Git URL: https://git.heroku.com/example.git
Repo Size: 5M
...
$ heroku apps:info --shell
git_url=https://git.heroku.com/example.git
repo_size=5000000
...
heroku apps:open [PATH]open the app in a web browser
USAGE
$ heroku apps:open [PATH] -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
open the app in a web browser
EXAMPLES
$ heroku open -a myapp
# opens https://myapp.herokuapp.com
$ heroku open -a myapp /foo
# opens https://myapp.herokuapp.com/foo
heroku apps:rename NEWNAMErename an app
USAGE
$ heroku apps:rename NEWNAME -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
rename an app
This will locally update the git remote if it is set to the old app.
EXAMPLES
$ heroku apps:rename --app oldname newname
https://newname-xxxxxxxxxxxx.herokuapp.com/ | https://git.heroku.com/newname.git
Git remote heroku updated
heroku apps:stacksshow the list of available stacks
USAGE
$ heroku apps:stacks -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
show the list of available stacks
heroku apps:stacks:set STACKset the stack of an app
USAGE
$ heroku apps:stacks:set STACK -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
set the stack of an app
EXAMPLES
$ heroku stack:set heroku-22 -a myapp
Setting stack to heroku-22... done
You will need to redeploy myapp for the change to take effect.
Run git push heroku main to trigger a new build on myapp.
heroku config:setset one or more config vars
USAGE
$ heroku config:set -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
set one or more config vars
EXAMPLES
$ heroku config:set RAILS_ENV=staging
Setting config vars and restarting example... done, v10
RAILS_ENV: staging
$ heroku config:set RAILS_ENV=staging RACK_ENV=staging
Setting config vars and restarting example... done, v11
RAILS_ENV: staging
RACK_ENV: staging
heroku drainsdisplay the log drains of an app
USAGE
$ heroku drains -a <value> [--json] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--json output in json format
DESCRIPTION
display the log drains of an app
heroku drains:add URLadds a log drain to an app
USAGE
$ heroku drains:add URL -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
adds a log drain to an app
heroku drains:remove [URL|TOKEN]removes a log drain from an app
USAGE
$ heroku drains:remove [URL|TOKEN]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
removes a log drain from an app
heroku dyno:kill DYNOstop app dyno
USAGE
$ heroku dyno:kill DYNO -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
stop app dyno
stop app dyno or dyno type
EXAMPLES
$ heroku ps:stop run.1828
Stopping run.1828 dyno... done
$ heroku ps:stop run
Stopping run dynos... done
heroku dyno:resizemanage dyno sizes
USAGE
$ heroku dyno:resize -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
manage dyno sizes
Called with no arguments shows the current dyno size.
Called with one argument sets the size.
Where SIZE is one of eco|basic|standard-1x|standard-2x|performance
Called with 1..n TYPE=SIZE arguments sets the quantity per type.
heroku dyno:restart [DYNO]restart app dynos
USAGE
$ heroku dyno:restart [DYNO] -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
restart app dynos
if DYNO is not specified, restarts all dynos on app
EXAMPLES
$ heroku ps:restart web.1
Restarting web.1 dyno... done
$ heroku ps:restart web
Restarting web dynos... done
$ heroku ps:restart
Restarting dynos... done
heroku dyno:scalescale dyno quantity up or down
USAGE
$ heroku dyno:scale -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
scale dyno quantity up or down
Appending a size (eg. web=2:Standard-2X) allows simultaneous scaling and resizing.
Omitting any arguments will display the app's current dyno formation, in a
format suitable for passing back into ps:scale.
EXAMPLES
$ heroku ps:scale web=3:Standard-2X worker+1
Scaling dynos... done, now running web at 3:Standard-2X, worker at 1:Standard-1X.
$ heroku ps:scale
web=3:Standard-2X worker=1:Standard-1X
heroku dyno:stop DYNOstop app dyno
USAGE
$ heroku dyno:stop DYNO -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
stop app dyno
stop app dyno or dyno type
EXAMPLES
$ heroku ps:stop run.1828
Stopping run.1828 dyno... done
$ heroku ps:stop run
Stopping run dynos... done
heroku featureslist available app features
USAGE
$ heroku features -a <value> [--json] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--json output in json format
DESCRIPTION
list available app features
heroku features:disable FEATUREdisables an app feature
USAGE
$ heroku features:disable FEATURE -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
disables an app feature
heroku features:enable FEATUREenables an app feature
USAGE
$ heroku features:enable FEATURE -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
enables an app feature
heroku features:info FEATUREdisplay information about a feature
USAGE
$ heroku features:info FEATURE -a <value> [--json] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--json output in json format
DESCRIPTION
display information about a feature
heroku keysdisplay your SSH keys
USAGE
$ heroku keys [-l] [--json]
FLAGS
-l, --long display full SSH keys
--json output in json format
DESCRIPTION
display your SSH keys
heroku keys:add [KEY]add an SSH key for a user
USAGE
$ heroku keys:add [KEY] [-y]
FLAGS
-y, --yes automatically answer yes for all prompts
DESCRIPTION
add an SSH key for a user
if no KEY is specified, will try to find ~/.ssh/id_rsa.pub
EXAMPLES
$ heroku keys:add
Could not find an existing public key.
Would you like to generate one? [Yn] y
Generating new SSH public key.
Uploading SSH public key /.ssh/id_rsa.pub... done
$ heroku keys:add /my/key.pub
Uploading SSH public key /my/key.pub... done
heroku keys:clearremove all SSH keys for current user
USAGE
$ heroku keys:clear
DESCRIPTION
remove all SSH keys for current user
heroku keys:remove KEYremove an SSH key from the user
USAGE
$ heroku keys:remove KEY
DESCRIPTION
remove an SSH key from the user
EXAMPLES
$ heroku keys:remove email@example.com
Removing email@example.com SSH key... done
heroku labslist experimental features
USAGE
$ heroku labs [--json] [-a <value>] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-r, --remote=<value> git remote of app to use
--json display as json
DESCRIPTION
list experimental features
heroku labs:enable FEATUREenables an experimental feature
USAGE
$ heroku labs:enable FEATURE [-a <value>] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
enables an experimental feature
heroku labs:info FEATUREshow feature info
USAGE
$ heroku labs:info FEATURE [--json] [-a <value>] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-r, --remote=<value> git remote of app to use
--json display as json
DESCRIPTION
show feature info
heroku maintenancedisplay the current maintenance status of app
USAGE
$ heroku maintenance -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
display the current maintenance status of app
heroku maintenance:offtake the app out of maintenance mode
USAGE
$ heroku maintenance:off -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
take the app out of maintenance mode
heroku maintenance:onput the app into maintenance mode
USAGE
$ heroku maintenance:on -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
put the app into maintenance mode
heroku notificationsdisplay notifications
USAGE
$ heroku notifications [--all] [--json] [--read] [-a <value>] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-r, --remote=<value> git remote of app to use
--all view all notifications (not just the ones for the current app)
--json output in json format
--read show notifications already read
DESCRIPTION
display notifications
heroku ps [TYPE [TYPE ...]]list dynos for an app
USAGE
$ heroku ps [TYPE [TYPE ...]]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--json display as json
DESCRIPTION
list dynos for an app
EXAMPLES
$ heroku ps
=== run: one-off dyno
run.1: up for 5m: bash
=== web: bundle exec thin start -p $PORT
web.1: created for 30s
$ heroku ps run # specifying types
=== run: one-off dyno
run.1: up for 5m: bash
heroku ps:kill DYNOstop app dyno
USAGE
$ heroku ps:kill DYNO -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
stop app dyno
stop app dyno or dyno type
EXAMPLES
$ heroku ps:stop run.1828
Stopping run.1828 dyno... done
$ heroku ps:stop run
Stopping run dynos... done
heroku ps:resizemanage dyno sizes
USAGE
$ heroku ps:resize -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
manage dyno sizes
Called with no arguments shows the current dyno size.
Called with one argument sets the size.
Where SIZE is one of eco|basic|standard-1x|standard-2x|performance
Called with 1..n TYPE=SIZE arguments sets the quantity per type.
heroku ps:restart [DYNO]restart app dynos
USAGE
$ heroku ps:restart [DYNO] -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
restart app dynos
if DYNO is not specified, restarts all dynos on app
EXAMPLES
$ heroku ps:restart web.1
Restarting web.1 dyno... done
$ heroku ps:restart web
Restarting web dynos... done
$ heroku ps:restart
Restarting dynos... done
heroku ps:scalescale dyno quantity up or down
USAGE
$ heroku ps:scale -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
scale dyno quantity up or down
Appending a size (eg. web=2:Standard-2X) allows simultaneous scaling and resizing.
Omitting any arguments will display the app's current dyno formation, in a
format suitable for passing back into ps:scale.
EXAMPLES
$ heroku ps:scale web=3:Standard-2X worker+1
Scaling dynos... done, now running web at 3:Standard-2X, worker at 1:Standard-1X.
$ heroku ps:scale
web=3:Standard-2X worker=1:Standard-1X
heroku ps:stop DYNOstop app dyno
USAGE
$ heroku ps:stop DYNO -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
stop app dyno
stop app dyno or dyno type
EXAMPLES
$ heroku ps:stop run.1828
Stopping run.1828 dyno... done
$ heroku ps:stop run
Stopping run dynos... done
heroku ps:typemanage dyno sizes
USAGE
$ heroku ps:type -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
manage dyno sizes
Called with no arguments shows the current dyno size.
Called with one argument sets the size.
Where SIZE is one of eco|basic|standard-1x|standard-2x|performance
Called with 1..n TYPE=SIZE arguments sets the quantity per type.
heroku releasesdisplay the releases for an app
USAGE
$ heroku releases -a <value> [-n <value>] [--json] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-n, --num=<value> number of releases to show
-r, --remote=<value> git remote of app to use
--json output releases in json format
DESCRIPTION
display the releases for an app
EXAMPLES
$ heroku releases
=== example Releases
v1 Config add FOO_BAR email@example.com 2015/11/17 17:37:41 (~ 1h ago)
v2 Config add BAR_BAZ email@example.com 2015/11/17 17:37:41 (~ 1h ago)
v3 Config add BAZ_QUX email@example.com 2015/11/17 17:37:41 (~ 1h ago)
heroku releases:info [RELEASE]view detailed information for a release
USAGE
$ heroku releases:info [RELEASE] -a <value> [--json] [-s] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
-s, --shell output in shell format
--json output in json format
DESCRIPTION
view detailed information for a release
heroku releases:output [RELEASE]View the release command output
USAGE
$ heroku releases:output [RELEASE] -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
View the release command output
heroku releases:rollback [RELEASE]rollback to a previous release
USAGE
$ heroku releases:rollback [RELEASE] -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
rollback to a previous release
If RELEASE is not specified, it will rollback one release
8.11.2 (2024-04-10)
Note: Version bump only for package heroku
FAQs
Heroku CLI plugin to manage apps.
The npm package @heroku-cli/plugin-apps-v5 receives a total of 3,723 weekly downloads. As such, @heroku-cli/plugin-apps-v5 popularity was classified as popular.
We found that @heroku-cli/plugin-apps-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.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.