1 | # heroku-cli-addons [![Circle CI](https://circleci.com/gh/heroku/heroku-cli-addons.svg?style=svg)](https://circleci.com/gh/heroku/heroku-cli-addons)
|
2 |
|
3 | [![Code Climate](https://codeclimate.com/github/heroku/heroku-cli-addons/badges/gpa.svg)](https://codeclimate.com/github/heroku/heroku-cli-addons)
|
4 | [![codecov](https://codecov.io/gh/heroku/heroku-cli-addons/branch/master/graph/badge.svg)](https://codecov.io/gh/heroku/heroku-cli-addons)
|
5 | [![npm version](https://badge.fury.io/js/heroku-cli-addons.svg)](https://badge.fury.io/js/heroku-cli-addons)
|
6 | [![License](https://img.shields.io/github/license/heroku/heroku-cli-addons.svg)](https://github.com/heroku/heroku-cli-addons/blob/master/LICENSE)
|
7 |
|
8 | [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
|
9 |
|
10 | This re-implements the `heroku addons [--app APP|--all]` command in Node with a
|
11 | new UX which aims to make the concepts clearer and the relationships between
|
12 | them more accessible.
|
13 |
|
14 | Example output:
|
15 |
|
16 | ``` sh-session
|
17 | $ heroku addons -a addons-reports
|
18 | Add-on Plan Price
|
19 | ────────────────────────────────── ──────────────────────────────── ───────────────────────────
|
20 | flowing-tidily-5466 heroku-postgresql:kappa (billed to addons app)
|
21 | ├─ support-api::ADDONS_DATABASE
|
22 | ├─ ADDONS_DATABASE
|
23 | ├─ addons::HEROKU_POSTGRESQL_BLUE
|
24 | └─ addons::DATABASE
|
25 | practicing-nobly-1495 heroku-postgresql:premium-yanari $200/month
|
26 | ├─ DATABASE
|
27 | ├─ addons::ADDONS_REPORTS
|
28 | └─ HEROKU_POSTGRESQL_SILVER
|
29 | swimming-truly-2371 openredis:micro $8/month
|
30 | └─ OPENREDIS
|
31 | cooling-avidly-8928 ? (billed to vault-usage app)
|
32 | └─ VAULT_USAGE
|
33 |
|
34 | ```
|
35 |
|
36 | As an experiment, it also makes use of ANSI colours where appropriate, by highlighting
|
37 | reference types by consistent colours and dimming non-critical information:
|
38 |
|
39 | ![colour example](https://cloud.githubusercontent.com/assets/66427/9675115/55693244-526e-11e5-95aa-dd437c24d5f1.png)
|
40 |
|
41 | ## Install
|
42 |
|
43 | ### Latest dev version
|
44 |
|
45 | ``` sh-session
|
46 | $ git clone https://github.com/heroku/heroku-cli-addons.git heroku-cli-addons
|
47 | $ cd heroku-cli-addons
|
48 | $ npm install # dependencies
|
49 | $ heroku plugins:link
|
50 | ```
|
51 |
|
52 | If you run into any problems, open an issue. You can remove the plugin in the
|
53 | meantime if it's borked:
|
54 |
|
55 | ``` sh-session
|
56 | $ rm ~/.heroku/node_modules/heroku-cli-addons
|
57 | ```
|
58 |
|
59 | ## Developing
|
60 |
|
61 | ```sh-session
|
62 | $ npm install # install all dependencies
|
63 | $ npm test # run the tests
|
64 | $ npm version <major|minor|patch> # bump the version number and publish to npm
|
65 | ```
|