Repository files navigation

The Heroku CLI is used to manage Heroku apps from the command line. It is built usingoclif.

For more about Heroku seehttps://www.heroku.com/home

To get started seehttps://devcenter.heroku.com/start

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, readDeveloping CLI Plugins

For problems directly related to the CLI,add an issue on GitHub.

For other issues,submit a support ticket.

Contributors

• heroku access - manage user access to apps
• heroku addons - tools and services for developing, extending, and operating your app
• heroku apps - manage apps on Heroku
• heroku auth - manage authentication for your Heroku account
• heroku authorizations - OAuth authorizations
• heroku autocomplete - display autocomplete installation instructions
• heroku buildpacks - scripts used to compile apps
• heroku certs - SSL certificates
• heroku ci - test runner for Heroku Pipelines
• heroku clients - OAuth clients on the platform
• heroku config - environment variables of apps
• heroku container - deploy your Docker-based app to Heroku
• heroku domains - custom domains for apps
• heroku drains - forward logs to syslog or HTTPS
• heroku features - add/remove app features
• heroku git - set git remote and clone Heroku repository
• heroku help - Display help for heroku.
• heroku keys - add/remove account ssh keys
• heroku labs - add/remove experimental features
• heroku local - run Heroku app locally
• heroku logs - display recent log output
• heroku maintenance - enable/disable access to app
• heroku members - manage organization members
• heroku notifications - display notifications
• heroku orgs - manage organizations
• heroku pg - manage postgresql databases
• heroku pipelines - manage pipelines
• heroku plugins - List installed plugins.
• heroku ps - Client tools for Heroku Exec
• heroku redis - manage heroku redis instances
• heroku regions - list available regions for deployment
• heroku releases - display the releases for an app
• heroku reviewapps - manage reviewapps in pipelines
• heroku run - run a one-off process inside a Heroku dyno
• heroku sessions - OAuth sessions
• heroku spaces - list available spaces
• heroku status - display current status of the Heroku platform
• heroku teams - manage teams
• heroku telemetry - list telemetry drains
• heroku update - update the Heroku CLI
• heroku version
• heroku webhooks - list webhooks on an app

This project is built withlerna. The core plugins are located in./packages.

After cloning the repo

1. Runyarn to install dependencies
2. Runyarn build to build the CLI. This will need to be re-run any time you make changes and want to test them locally.

To execute Heroku CLI commands locally, use./bin/run <command>. For example, to run theheroku apps command with your local code, run./bin/run apps from the root directory.

Run all tests withyarn test.

Using WebStorm (from JetBrains / IntelliJ), you can run/debug an individual test case.

• Create a new run/debug configuration
• Select the 'Mocha' type

See theHeroku CLI Release Steps.

Review ourPR guidelines.