UNPKG

5.39 kBMarkdownView Raw
1Heroku CLI
2==========
3
4![Heroku logo](https://d4yt8xl9b7in.cloudfront.net/assets/home/logotype-heroku.png)
5
6[![Circle CI](https://circleci.com/gh/heroku/cli/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/cli/tree/master)
7[![Build status](https://ci.appveyor.com/api/projects/status/ouee3b9d7jwkjcr1/branch/master?svg=true)](https://ci.appveyor.com/project/Heroku/cli/branch/master)
8[![CircleCI](https://circleci.com/gh/heroku/cli-macos-installer/tree/master.svg?style=svg&circle-token=90b3b4392dc1668e97108edabdfc2c6baddc3a17)](https://circleci.com/gh/heroku/cli-macos-installer/tree/master)
9[![Snap Status](https://build.snapcraft.io/badge/heroku/cli.svg)](https://build.snapcraft.io/user/heroku/cli)
10[![ISC License](https://img.shields.io/github/license/heroku/cli.svg)](https://github.com/heroku/cli/blob/master/LICENSE)
11[![homebrew](https://img.shields.io/homebrew/v/heroku.svg)](https://github.com/Homebrew/homebrew-core/blob/master/Formula/heroku.rb)
12[![npm](https://img.shields.io/npm/v/heroku.svg)](https://www.npmjs.com/package/heroku)
13
14The Heroku CLI is used to manage Heroku apps from the command line. It is built using [oclif](https://oclif.io).
15
16For more about Heroku see <https://www.heroku.com/home>
17
18To get started see <https://devcenter.heroku.com/start>
19
20Overview
21========
22
23This 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.
24
25It has identical functionality to the old Ruby CLI. Under the hood, it is a modular CLI made up of node.js plugins.
26
27For more on developing plugins, read [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)
28
29Issues
30======
31
32For problems directly related to the CLI, [add an issue on GitHub](https://github.com/heroku/cli/issues/new).
33
34For other issues, [submit a support ticket](https://help.heroku.com/).
35
36[Contributors](https://github.com/heroku/cli/contributors)
37
38<!-- commands -->
39# Command Topics
40
41* [`heroku access`](docs/access.md) - manage user access to apps
42* [`heroku addons`](docs/addons.md) - tools and services for developing, extending, and operating your app
43* [`heroku apps`](docs/apps.md) - manage apps on Heroku
44* [`heroku auth`](docs/auth.md) - check 2fa status
45* [`heroku authorizations`](docs/authorizations.md) - OAuth authorizations
46* [`heroku autocomplete`](docs/autocomplete.md) - display autocomplete installation instructions
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) - groups of apps that share the same codebase
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) - disposable apps built on GitHub pull requests
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) - setup HTTP notifications of app activity
82
83<!-- commandsstop -->
84
85Developing
86==========
87
88This project is built with [lerna](http://lernajs.io). The core plugins are located in [./packages](./packages). Run `lerna bootstrap` after cloning the repository to set it up.
89
90To 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
92Review our [PR guidelines](./.github/PULL_REQUEST_TEMPLATE.md).