| 1 | Heroku CLI
|
| 2 | ==========
|
| 3 |
|
| 4 | 
|
| 5 |
|
| 6 | [](https://circleci.com/gh/heroku/cli/tree/master)
|
| 7 | [](https://ci.appveyor.com/project/Heroku/cli/branch/master)
|
| 8 | [](https://circleci.com/gh/heroku/cli-macos-installer/tree/master)
|
| 9 | [](https://build.snapcraft.io/user/heroku/cli)
|
| 10 | [](https://github.com/heroku/cli/blob/master/LICENSE)
|
| 11 | [](https://www.npmjs.com/package/heroku)
|
| 12 |
|
| 13 | The Heroku CLI is used to manage Heroku apps from the command line. It is built using [oclif](https://oclif.io).
|
| 14 |
|
| 15 | For more about Heroku see <https://www.heroku.com/home>
|
| 16 |
|
| 17 | To get started see <https://devcenter.heroku.com/start>
|
| 18 |
|
| 19 | Overview
|
| 20 | ========
|
| 21 |
|
| 22 | 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.
|
| 23 |
|
| 24 | It has identical functionality to the old Ruby CLI. Under the hood, it is a modular CLI made up of node.js plugins.
|
| 25 |
|
| 26 | For more on developing plugins, read [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)
|
| 27 |
|
| 28 | Issues
|
| 29 | ======
|
| 30 |
|
| 31 | For problems directly related to the CLI, [add an issue on GitHub](https://github.com/heroku/cli/issues/new).
|
| 32 |
|
| 33 | For other issues, [submit a support ticket](https://help.heroku.com/).
|
| 34 |
|
| 35 | [Contributors](https://github.com/heroku/cli/contributors)
|
| 36 |
|
| 37 |
|
| 38 | # Command Topics
|
| 39 |
|
| 40 | * [`heroku access`](docs/access.md) - manage user access to apps
|
| 41 | * [`heroku addons`](docs/addons.md) - tools and services for developing, extending, and operating your app
|
| 42 | * [`heroku apps`](docs/apps.md) - manage apps on Heroku
|
| 43 | * [`heroku auth`](docs/auth.md) - check 2fa status
|
| 44 | * [`heroku authorizations`](docs/authorizations.md) - OAuth authorizations
|
| 45 | * [`heroku autocomplete`](docs/autocomplete.md) - display autocomplete installation instructions
|
| 46 | * [`heroku base`](docs/base.md)
|
| 47 | * [`heroku buildpacks`](docs/buildpacks.md) - scripts used to compile apps
|
| 48 | * [`heroku certs`](docs/certs.md) - a topic for the ssl plugin
|
| 49 | * [`heroku ci`](docs/ci.md) - run an application test suite on Heroku
|
| 50 | * [`heroku clients`](docs/clients.md) - OAuth clients on the platform
|
| 51 | * [`heroku config`](docs/config.md) - environment variables of apps
|
| 52 | * [`heroku container`](docs/container.md) - Use containers to build and deploy Heroku apps
|
| 53 | * [`heroku domains`](docs/domains.md) - custom domains for apps
|
| 54 | * [`heroku drains`](docs/drains.md) - forward logs to syslog or HTTPS
|
| 55 | * [`heroku features`](docs/features.md) - add/remove app features
|
| 56 | * [`heroku git`](docs/git.md) - manage local git repository for app
|
| 57 | * [`heroku help`](docs/help.md) - display help for heroku
|
| 58 | * [`heroku keys`](docs/keys.md) - add/remove account ssh keys
|
| 59 | * [`heroku labs`](docs/labs.md) - add/remove experimental features
|
| 60 | * [`heroku local`](docs/local.md) - run Heroku app locally
|
| 61 | * [`heroku logs`](docs/logs.md) - display recent log output
|
| 62 | * [`heroku maintenance`](docs/maintenance.md) - enable/disable access to app
|
| 63 | * [`heroku members`](docs/members.md) - manage organization members
|
| 64 | * [`heroku notifications`](docs/notifications.md) - display notifications
|
| 65 | * [`heroku orgs`](docs/orgs.md) - manage organizations
|
| 66 | * [`heroku pg`](docs/pg.md) - manage postgresql databases
|
| 67 | * [`heroku pipelines`](docs/pipelines.md) - manage pipelines
|
| 68 | * [`heroku plugins`](docs/plugins.md) - list installed plugins
|
| 69 | * [`heroku ps`](docs/ps.md) - Client tools for Heroku Exec
|
| 70 | * [`heroku psql`](docs/psql.md) - open a psql shell to the database
|
| 71 | * [`heroku redis`](docs/redis.md) - manage heroku redis instances
|
| 72 | * [`heroku regions`](docs/regions.md) - list available regions for deployment
|
| 73 | * [`heroku releases`](docs/releases.md) - display the releases for an app
|
| 74 | * [`heroku reviewapps`](docs/reviewapps.md) - manage reviewapps in pipelines
|
| 75 | * [`heroku run`](docs/run.md) - run a one-off process inside a Heroku dyno
|
| 76 | * [`heroku sessions`](docs/sessions.md) - OAuth sessions
|
| 77 | * [`heroku spaces`](docs/spaces.md) - manage heroku private spaces
|
| 78 | * [`heroku status`](docs/status.md) - status of the Heroku platform
|
| 79 | * [`heroku teams`](docs/teams.md) - manage teams
|
| 80 | * [`heroku update`](docs/update.md) - update the Heroku CLI
|
| 81 | * [`heroku webhooks`](docs/webhooks.md) - list webhooks on an app
|
| 82 |
|
| 83 |
|
| 84 |
|
| 85 | Developing
|
| 86 | ==========
|
| 87 |
|
| 88 | This project is built with [lerna](https://lerna.js.org/). The core plugins are located in [./packages](./packages). Run `lerna bootstrap` after cloning the repository to set it up.
|
| 89 |
|
| 90 | To cut a release, simply run `lerna publish` and it will create a CHANGELOG from the pending commits using [Conventional Commits](http://conventionalcommits.org). CircleCI will run the jobs to publish the CLI once it receives the git tag.
|
| 91 |
|
| 92 | Review our [PR guidelines](./.github/PULL_REQUEST_TEMPLATE.md).
|