heroku
Makes it easy to create and manage your Heroku apps directly from the terminal
Subcommands
Name | Description |
---|---|
auth:2fa, 2fa, twofactor | Check 2fa status |
auth:2fa:disable, twofactor:disable, 2fa:disable | Disables 2fa on account |
auth:login, login | Login with your Heroku credentials |
auth:logout, logout | Clears local login credentials and invalidates API session |
auth:token | Outputs current CLI authentication token |
auth:whoami, whoami | Display the current logged in user |
labs:disable | Disables an experimental feature |
buildpacks | Display the buildpacks for an app |
buildpacks:add | Add new app buildpack, inserting into list of buildpacks if necessary |
buildpacks:clear | Clear all buildpacks set on the app |
buildpacks:info | Fetch info about a buildpack |
buildpacks:remove | Remove a buildpack set on the app |
buildpacks:search | Search for buildpacks |
buildpacks:set | |
buildpacks:versions | List versions of a buildpack |
ci:config | Display CI config vars |
ci:config:get | Get a CI config var |
ci:config:set | Set CI config vars |
ci:config:unset | Unset CI config vars |
ci:debug | Opens an interactive test debugging session with the contents of the current directory |
ci:migrate-manifest | App-ci.json is deprecated. Run this command to migrate to app.json with an environments key |
ci:open | Open the Dashboard version of Heroku CI |
domains | List domains for an app |
domains:add | Add a domain to an app |
domains:clear | Remove all domains from an app |
domains:info | Show detailed information for a domain on an app |
domains:remove | Remove a domain from an app |
domains:update | Update a domain to use a different SSL certificate on an app |
domains:wait | Wait for domain to be active for an app |
apps | List your apps |
apps:create | Creates a new app |
apps:destroy | Permanently destroy an app |
apps:errors | View app errors |
apps:favorites | List favorited apps |
apps:favorites:add | Favorites an app |
apps:favorites:remove | Unfavorites an app |
apps:info | Show detailed app information |
apps:open | Open the app in a web browser |
apps:rename | Rename an app |
apps:stacks | Show the list of available stacks |
apps:stacks:set | Set the stack of an app |
config:set | Set one or more config vars |
drains | Display the log drains of an app |
drains:get | Display the log drain for a space |
drains:set | Replaces the log drain for a space |
drains:add | Adds a log drain to an app |
drains:remove | Removes a log drain from an app |
dyno:kill | Stop app dyno |
dyno:resize | Manage dyno sizes |
dyno:restart | Restart app dynos |
dyno:scale | Scale dyno quantity up or down |
dyno:stop | Stop app dyno |
features | List available app features |
features:disable | Disables an app feature |
features:enable | Enables an app feature |
features:info | Display information about a feature |
keys | Display your SSH keys |
keys:add | Add an SSH key for a user |
keys:clear | Remove all SSH keys for current user |
keys:remove | Remove an SSH key from the user |
labs | List experimental features |
labs:enable | Enables an experimental feature |
labs:info | Show feature info |
maintenance | Display the current maintenance status of app |
maintenance:off | Take the app out of maintenance mode |
maintenance:on | Put the app into maintenance mode |
notifications | Display notifications |
ps | List dynos for an app |
ps:kill | Stop app dyno |
ps:resize | Manage dyno sizes |
ps:restart | Restart app dynos |
ps:scale | Scale dyno quantity up or down |
ps:stop | Stop app dyno |
ps:type | Manage dyno sizes |
releases | Display the releases for an app |
releases:info | View detailed information for a release |
releases:output | View the release command output |
releases:rollback | Rollback to a previous release |
autocomplete | Display autocomplete installation instructions |
config | Display the config vars for an app |
config:edit | Interactively edit config vars |
config:get | Display a single config value for an app |
config:unset, config:remove | Unset one or more config vars |
local, local:start | Run heroku app locally |
local:run | Run a one-off command |
local:version | Display node-foreman version |
ci | Display the most recent CI runs for the given pipeline |
ci:info | Show the status of a specific test run |
ci:last | Looks for the most recent run and returns the output of that run |
ci:rerun | Rerun tests against current directory |
ci:run | Run tests against current directory |
certs | List SSL certificates for an app |
certs:add | Add an SSL certificate to an app |
certs:auto | Show ACM status for an app |
certs:auto:disable | Disable ACM for an app |
certs:auto:enable | Enable ACM status for an app |
certs:auto:refresh | Refresh ACM for an app |
certs:chain | Print an ordered & complete chain for a certificate |
certs:generate | Generate a key and a CSR or self-signed certificate |
certs:info | Show certificate information for an SSL certificate |
certs:key | Print the correct key for the given certificate |
certs:remove | Remove an SSL certificate from an app |
certs:update | Update an SSL certificate on an app |
git:clone | Clones a heroku app to your local machine at DIRECTORY (defaults to app name) |
git:remote | Adds a git remote to an app repo |
addons | Lists your add-ons and attachments |
addons:attach | Attach an existing add-on resource to an app |
addons:create | Create a new add-on resource |
addons:destroy | Permanently destroy an add-on resource |
addons:detach | Detach an existing add-on resource from an app |
addons:docs | Open an add-on's Dev Center documentation in your browser |
addons:downgrade | Change add-on plan |
addons:info | Show detailed add-on resource and attachment information |
addons:open | Open an add-on's dashboard in your browser |
addons:plans | List all available plans for an add-on services |
addons:rename | Rename an add-on |
addons:services | List all available add-on services |
addons:upgrade | Change add-on plan |
addons:wait | Show provisioning status of the add-ons on the app |
authorizations | List OAuth authorizations |
authorizations:create | Create a new OAuth authorization |
authorizations:info | Show an existing OAuth authorization |
authorizations:revoke, authorizations:destroy | Revoke OAuth authorization |
authorizations:rotate | Updates an OAuth authorization token |
authorizations:update | Updates an OAuth authorization |
clients | List your OAuth clients |
clients:create | Create a new OAuth client |
clients:destroy | Delete client by ID |
clients:info | Show details of an oauth client |
clients:rotate | Rotate OAuth client secret |
clients:update | Update OAuth client |
sessions | List your OAuth sessions |
sessions:destroy | Delete (logout) OAuth session by ID |
redis | Gets information about redis |
redis:cli | Opens a redis prompt |
redis:credentials | Display credentials information |
redis:info | Gets information about redis |
redis:keyspace-notifications | Set the keyspace notifications configuration |
redis:maintenance | Manage maintenance windows |
redis:maxmemory | Set the key eviction policy |
redis:promote | Sets DATABASE as your REDIS_URL |
redis:stats-reset | Reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat) |
redis:timeout | Set the number of seconds to wait before killing idle connections |
redis:wait | Wait for Redis instance to be available |
container | Use containers to build and deploy Heroku apps |
container:login | Log in to Heroku Container Registry |
container:logout | Log out from Heroku Container Registry |
container:pull | Pulls an image from an app's process type |
container:push | Builds, then pushes Docker images to deploy your Heroku app |
container:release | Releases previously pushed Docker images to your Heroku app |
container:rm | Remove the process type from your app |
container:run | Builds, then runs the docker image locally |
logs | Display recent log output |
run | Run a one-off process inside a heroku dyno |
run:detached | Run a detached dyno, where output is sent to your logs |
outbound-rules:add | Add outbound rules to a Private Space |
outbound-rules | List Outbound Rules for a space |
outbound-rules:remove | Remove a Rules from the list of Outbound Rules |
status | Display current status of the Heroku platform |
pipelines | List pipelines you have access to |
pipelines:add | Add this app to a pipeline |
pipelines:connect | Connect a github repo to an existing pipeline |
pipelines:create | Create a new pipeline |
pipelines:destroy | Destroy a pipeline |
pipelines:diff | Compares the latest release of this app to its downstream app(s) |
pipelines:info | Show list of apps in a pipeline |
pipelines:open | Open a pipeline in dashboard |
pipelines:promote | Promote the latest release of this app to its downstream app(s) |
pipelines:remove | Remove this app from its pipeline |
pipelines:rename | Rename a pipeline |
pipelines:setup | Bootstrap a new pipeline with common settings and create a production and staging app (requires a fully formed app.json in the repo) |
pipelines:transfer | Transfer ownership of a pipeline |
pipelines:update | Update the app's stage in a pipeline |
reviewapps:disable | Disable review apps and/or settings on an existing pipeline |
reviewapps:enable | Enable review apps and/or settings on an existing pipeline |
spaces | List available spaces |
spaces:create | Create a new space |
spaces:destroy | Destroy a space |
spaces:info | Show info about a space |
spaces:peering:info | Display the information necessary to initiate a peering connection |
spaces:peerings | List peering connections for a space |
spaces:peerings:accept | Accepts a pending peering request for a private space |
spaces:peerings:destroy | Destroys an active peering connection in a private space |
spaces:ps | List dynos for a space |
spaces:rename | Renames a space |
spaces:topology | Show space topology |
spaces:transfer | Transfer a space to another team |
spaces:vpn:config | Display the configuration information for VPN |
spaces:vpn:connect | Create VPN |
spaces:vpn:connections | List the VPN Connections for a space |
spaces:vpn:destroy | Destroys VPN in a private space |
spaces:vpn:info | Display the information for VPN |
spaces:vpn:update | Update VPN |
spaces:vpn:wait | Wait for VPN Connection to be created |
spaces:wait | Wait for a space to be created |
trusted-ips | List trusted IP ranges for a space |
trusted-ips:add | Add one range to the list of trusted IP ranges |
trusted-ips:remove | Remove a range from the list of trusted IP ranges |
ps:copy | Copy a file from a dyno to the local filesystem |
ps:exec | Create an SSH session to a dyno |
ps:forward | Forward traffic on a local port to a dyno |
ps:socks | Launch a SOCKS proxy into a dyno |
access | List who has access to an app |
access:add | Add new users to your app |
access:remove | Remove users from a team app |
access:update | Update existing collaborators on an team app |
apps:join | Add yourself to a team app |
apps:leave | Remove yourself from a team app |
apps:lock | Prevent team members from joining an app |
apps:transfer | Transfer applications to another user or team |
apps:unlock | Unlock an app so any team member can join |
join | Add yourself to a team app |
leave | Remove yourself from a team app |
lock | Prevent team members from joining an app |
members | List members of a team |
members:add | Adds a user to a team |
members:remove | Removes a user from a team |
members:set | Sets a members role in a team |
orgs | List the teams that you are a member of |
orgs:open | Open the team interface in a browser window |
teams | List the teams that you are a member of |
unlock | Unlock an app so any team member can join |
ps:autoscale:disable | Disable web dyno autoscaling |
ps:autoscale:enable | Enable web dyno autoscaling |
ps:wait | Wait for all dynos to be running latest version after a release |
regions | List available regions for deployment |
webhooks | List webhooks on an app |
webhooks:add | Add a webhook to an app |
webhooks:deliveries | List webhook deliveries on an app |
webhooks:deliveries:info | Info for a webhook event on an app |
webhooks:events | List webhook events on an app |
webhooks:events:info | Info for a webhook event on an app |
webhooks:info | Info for a webhook on an app |
webhooks:remove | Removes a webhook from an app |
webhooks:update | Updates a webhook in an app |
commands | List all the commands |
help | Display help for <%= config.bin %> |
which | Show which plugin a command is in |
update | Update the <%= config.bin %> CLI |
plugins | List installed plugins |
plugins:install, plugins:add | Installs a plugin into the CLI |
plugins:link | Links a plugin into the CLI for development |
plugins:uninstall, plugins:unlink, plugins:remove | Removes a plugin from the CLI |
plugins:update | Update installed plugins |
pg | Show database information |
pg:backups | List database backups |
pg:backups:cancel | Cancel an in-progress backup or restore (default newest) |
pg:backups:capture | Capture a new backup |
pg:backups:delete | Delete a backup |
pg:backups:download | Downloads database backup |
pg:backups:info | Get information about a specific backup |
pg:backups:restore | Restore a backup (default latest) to a database |
pg:backups:schedule | Schedule daily backups for given database |
pg:backups:schedules | List backup schedule |
pg:backups:unschedule | Stop daily backups |
pg:backups:url | Get secret but publicly accessible URL of a backup |
pg:bloat | Show table and index bloat in your database ordered by most wasteful |
pg:blocking | Display queries holding locks other queries are waiting to be released |
pg:connection-pooling:attach | Add an attachment to a database using connection pooling |
pg:copy | Copy all data from source db to target |
pg:credentials | Show information on credentials in the database |
pg:credentials:create | Create credential within database |
pg:credentials:destroy | Destroy credential within database |
pg:credentials:repair-default | Repair the permissions of the default credential within database |
pg:credentials:rotate | Rotate the database credentials |
pg:credentials:url | Show information on a database credential |
pg:diagnose | Run or view diagnostics report |
pg:info | Show database information |
pg:kill | Kill a query |
pg:killall | Terminates all connections for all credentials |
pg:links | Lists all databases and information on link |
pg:links:create | Create a link between data stores |
pg:links:destroy | Destroys a link between data stores |
pg:locks | Display queries with active locks |
pg:maintenance | Show current maintenance information |
pg:maintenance:run | Start maintenance |
pg:maintenance:window | Set weekly maintenance window |
pg:outliers | Show 10 queries that have longest execution time in aggregate |
pg:promote | Sets DATABASE as your DATABASE_URL |
pg:ps | View active queries with execution time |
pg:psql | Open a psql shell to the database |
pg:pull | Pull Heroku database into local or remote database |
pg:push | Push local or remote into Heroku database |
pg:reset | Delete all data in DATABASE |
pg:settings | Show your current database settings |
pg:settings:log-lock-waits | Controls whether a log message is produced when a session waits longer than the deadlock_timeout to acquire a lock. deadlock_timeout is set to 1 second |
pg:settings:log-min-duration-statement | The duration of each completed statement will be logged if the statement completes after the time specified by VALUE |
pg:settings:log-statement | Log_statement controls which SQL statements are logged |
pg:unfollow | Stop a replica from following and make it a writeable database |
pg:upgrade | Unfollow a database and upgrade it to the latest stable PostgreSQL version |
pg:vacuum-stats | Show dead rows and whether an automatic vacuum is expected to be triggered |
pg:wait | Blocks until database is available |
psql | Open a psql shell to the database |
rake | |
addons:add | Create a new add-on resource |
addons:remove | Permanently destroy an add-on resource |
create | Creates a new app |
destroy | Permanently destroy an app |
apps:delete | Permanently destroy an app |
list | List your apps |
apps:list | List your apps |
info | Show detailed app information |
open | Open the app in a web browser |
rename | Rename an app |
stack | Show the list of available stacks |
stack:set | Set the stack of an app |
config:add | Set one or more config vars |
dashboard | Display information about favorite apps |
restart | Restart app dynos |
scale | Scale dyno quantity up or down |
stop | Stop app dyno |
kill | Stop app dyno |
resize | Manage dyno sizes |
dyno:type | Manage dyno sizes |
rollback | Rollback to a previous release |
auth:disable | Disables an experimental feature |
certs:wait | Waits for the certificate to be activated |
git:credentials | Internal command for git-credentials |
sharing:add | |
sharing:access | |
sharing:remove | |
join:null | Add yourself to a team app |
leave:null | Remove yourself from a team app |
sharing:transfer | |
unlock:null | Unlock an app so any team member can join |
orgs:default | |
pg:backups:public-url | Get secret but publicly accessible URL of a backup |
pg:backups:publicurl | Get secret but publicly accessible URL of a backup |
pg:repoint | Changes which leader a follower is following |
pg:settings:log-connections | Controls whether a log message is produced when a login attempt is made. Default is true |
pg:vacuum_stats | Show dead rows and whether an automatic vacuum is expected to be triggered |
pipelines:disable | Disable review apps and/or settings on an existing pipeline |
pipelines:enable | Enable review apps and/or settings on an existing pipeline |
ps:disable | Disable web dyno autoscaling |
ps:enable | Enable web dyno autoscaling |
ps:regions | List available regions for deployment |
run:console | |
run:logs | |
run:rake | |
run:inside | Run a one-off process inside an existing heroku dyno |
console | |
spaces:hosts | List dedicated hosts for a space |