heroku
TypeScript icon, indicating that this package has built-in type declarations

8.11.5 • Public • Published

Heroku CLI

Heroku logo Node CI Suite npm ISC License

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.

Contributors

Command Topics

Developing

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

After cloning the repo

  1. Run yarn to install dependencies
  2. Run yarn 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 the heroku apps command with your local code, run ./bin/run apps from the root directory.

Testing

Run all tests with yarn test.

Run one test, in this case plugin-certs-v5, with yarn lerna run --scope @heroku-cli/plugin-certs-v5 test.

Debugging

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

  • Create a new run/debug configuration
  • Select the 'Mocha' type
  • Set the working directory to the directory of the package you are using. (i.e. ~/Heroku/Repos/cli/packages/certs-v5)

Releasing

See the Heroku CLI Release Steps.

Review our PR guidelines.

Package Sidebar

Install

npm i heroku

Weekly Downloads

9,528

Version

8.11.5

License

ISC

Unpacked Size

530 kB

Total Files

326

Last publish

Collaborators

  • grismar17
  • erika-wallace
  • sbosio_sf
  • hillzbot2000
  • kdreyeroren
  • beanieboi
  • beckychen
  • xx-sfdc-npm
  • kpremkumar
  • abhinavkoul
  • daniel.bright
  • justinwilaby-sf
  • cv88
  • jlopezdan
  • jmonreal
  • jondaniel-sfdc
  • dhagberg-sf
  • jmorrell-sfdc
  • elzoona
  • cmarcojos
  • gkommineni
  • vlazuka
  • nlanatta
  • lucaszhou
  • mars
  • mimen
  • wchrisjohnson
  • cbaxtersf
  • heroku-front-end
  • bsperlingsf
  • zli-sf
  • 7ftz
  • joanneyeung
  • montes_heroku
  • jwadsworthsf
  • jheikes
  • lmckenzie
  • sarassassin
  • pfuente
  • reidmix
  • mbuschheroku
  • k.plenty
  • eblack
  • sheax0r
  • k80bowman
  • rdagg-hero
  • grundy.g
  • robinson.m
  • tcareysmith-sfdc
  • ptemporini
  • paulaprado18
  • harish.457
  • ntonollier
  • dickeyxxx
  • rasphilco