UNPKG

heroku-cli/README.md

Version:

2.49 kBMarkdownView Raw

1Heroku CLI
2==========
3
4![Heroku logo](https://d4yt8xl9b7in.cloudfront.net/assets/home/logotype-heroku.png)
5
6[![Greenkeeper badge](https://badges.greenkeeper.io/heroku/cli.svg)](https://greenkeeper.io/)
7[![Circle CI](https://circleci.com/gh/heroku/cli/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/cli/tree/master)
8[![Build status](https://ci.appveyor.com/api/projects/status/ouee3b9d7jwkjcr1/branch/master?svg=true)](https://ci.appveyor.com/project/Heroku/cli/branch/master)
9[![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)
10[![Snap Status](https://build.snapcraft.io/badge/heroku/cli.svg)](https://build.snapcraft.io/user/heroku/cli)
11[![ISC License](https://img.shields.io/github/license/heroku/cli.svg)](https://github.com/heroku/cli/blob/master/LICENSE)
12[![homebrew](https://img.shields.io/homebrew/v/heroku.svg)](https://github.com/Homebrew/homebrew-core/blob/master/Formula/heroku.rb)
13[![npm](https://img.shields.io/npm/v/heroku-cli.svg)](https://www.npmjs.com/package/heroku-cli)
14
15The Heroku CLI is used to manage Heroku apps from the command line.
16
17For more about Heroku see <https://www.heroku.com/home>
18
19To get started see <https://devcenter.heroku.com/start>
20
21Overview
22========
23
24This 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.
25
26It has identical functionality to the old Ruby CLI. Under the hood, it is a modular CLI made up of node.js plugins.
27
28For more on developing plugins, read [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)
29
30Issues
31======
32
33For problems directly related to the CLI, [add an issue on GitHub](https://github.com/heroku/cli/issues/new).
34
35For other issues, [submit a support ticket](https://help.heroku.com/).
36
37[Contributors](https://github.com/heroku/cli/contributors)
38
39Developing
40==========
41
42Developing the CLI locally requires node.
43
44The bulk of the code for this project lives at [heroku/cli-engine](https://github.com/heroku/cli-engine) and its dependencies.
45
46To run the CLI locally, use the `./bin/run` script.
47
48**Alpha build note:** To make the run script operable, you must use yarn >= 0.21.3. After the initial project `yarn install`, do the following:
49
50```
51cd ./node_modules/cli-engine
52yarn install
53yarn prepare
54```

1	`Heroku CLI`
2	`==========`
3
4	`![Heroku logo](https://d4yt8xl9b7in.cloudfront.net/assets/home/logotype-heroku.png)`
5
6	`[![Greenkeeper badge](https://badges.greenkeeper.io/heroku/cli.svg)](https://greenkeeper.io/)`
7	`[![Circle CI](https://circleci.com/gh/heroku/cli/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/cli/tree/master)`
8	`[![Build status](https://ci.appveyor.com/api/projects/status/ouee3b9d7jwkjcr1/branch/master?svg=true)](https://ci.appveyor.com/project/Heroku/cli/branch/master)`
9	`[![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)`
10	`[![Snap Status](https://build.snapcraft.io/badge/heroku/cli.svg)](https://build.snapcraft.io/user/heroku/cli)`
11	`[![ISC License](https://img.shields.io/github/license/heroku/cli.svg)](https://github.com/heroku/cli/blob/master/LICENSE)`
12	`[![homebrew](https://img.shields.io/homebrew/v/heroku.svg)](https://github.com/Homebrew/homebrew-core/blob/master/Formula/heroku.rb)`
13	`[![npm](https://img.shields.io/npm/v/heroku-cli.svg)](https://www.npmjs.com/package/heroku-cli)`
14
15	`The Heroku CLI is used to manage Heroku apps from the command line.`
16
17	`For more about Heroku see <https://www.heroku.com/home>`
18
19	`To get started see <https://devcenter.heroku.com/start>`
20
21	`Overview`
22	`========`
23
24	`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.`
25
26	`It has identical functionality to the old Ruby CLI. Under the hood, it is a modular CLI made up of node.js plugins.`
27
28	`For more on developing plugins, read [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)`
29
30	`Issues`
31	`======`
32
33	`For problems directly related to the CLI, [add an issue on GitHub](https://github.com/heroku/cli/issues/new).`
34
35	`For other issues, [submit a support ticket](https://help.heroku.com/).`
36
37	`[Contributors](https://github.com/heroku/cli/contributors)`
38
39	`Developing`
40	`==========`
41
42	`Developing the CLI locally requires node.`
43
44	`The bulk of the code for this project lives at [heroku/cli-engine](https://github.com/heroku/cli-engine) and its dependencies.`
45
46	To run the CLI locally, use the `./bin/run` script.
47
48	Alpha build note: To make the run script operable, you must use yarn >= 0.21.3. After the initial project `yarn install`, do the following:
49
50	```
51	`cd ./node_modules/cli-engine`
52	`yarn install`
53	`yarn prepare`
54	```