Heroku CLI
The Heroku CLI is used to manage Heroku apps from the command line. It is built using oclif.
For more about Heroku see https://www.heroku.com/home
To get started see https://devcenter.heroku.com/start
Overview
This is the next generation Node-based Heroku CLI. The goals of this project were to make plugins more flexible, remove Ruby as a runtime dependency, and make the CLI faster.
It has identical functionality to the old Ruby CLI. Under the hood, it is a modular CLI made up of node.js plugins.
For more on developing plugins, read Developing CLI Plugins
Issues
For problems directly related to the CLI, add an issue on GitHub.
For other issues, submit a support ticket.
Command Topics
heroku access
- manage user access to appsheroku addons
- tools and services for developing, extending, and operating your appheroku apps
- manage apps on Herokuheroku auth
- check 2fa statusheroku authorizations
- OAuth authorizationsheroku autocomplete
- display autocomplete installation instructionsheroku base
heroku buildpacks
- scripts used to compile appsheroku certs
- a topic for the ssl pluginheroku ci
- run an application test suite on Herokuheroku clients
- OAuth clients on the platformheroku config
- environment variables of appsheroku container
- Use containers to build and deploy Heroku appsheroku domains
- custom domains for appsheroku drains
- forward logs to syslog or HTTPSheroku features
- add/remove app featuresheroku git
- manage local git repository for appheroku help
- display help for herokuheroku keys
- add/remove account ssh keysheroku labs
- add/remove experimental featuresheroku local
- run Heroku app locallyheroku logs
- display recent log outputheroku maintenance
- enable/disable access to appheroku members
- manage organization membersheroku notifications
- display notificationsheroku orgs
- manage organizationsheroku pg
- manage postgresql databasesheroku pipelines
- manage pipelinesheroku plugins
- list installed pluginsheroku ps
- Client tools for Heroku Execheroku psql
- open a psql shell to the databaseheroku redis
- manage heroku redis instancesheroku regions
- list available regions for deploymentheroku releases
- display the releases for an appheroku reviewapps
- manage reviewapps in pipelinesheroku run
- run a one-off process inside a Heroku dynoheroku sessions
- OAuth sessionsheroku spaces
- manage heroku private spacesheroku status
- status of the Heroku platformheroku teams
- manage teamsheroku update
- update the Heroku CLIheroku webhooks
- list webhooks on an app
Developing
This project is built with lerna. The core plugins are located in ./packages. Run lerna bootstrap
after cloning the repository to set it up.
Releasing
- Checkout the master branch and double-check you're on latest commit that you would like to release from.
- Ensure your current working directory is clean.
- Run
lerna bootstrap
to ensure that all dependencies and are installed and linked. - Make sure you are logged in with the correct user by running:
npm whoami
. - Run
lerna publish
. It will create a CHANGELOG from the pending commits using Conventional Commits, and also take care of bumping packages, tagging and pushing the commit. Upon the git tag being pushed a series of CI release jobs will start. - Monitor CircleCI, Appveyor and Snapcraft jobs to ensure that all the builds are successful.
Review our PR guidelines.