heroku-cli-util

heroku-cli-util

Set of helpful CLI utilities

Installation

npm install heroku-cli-util --save

Prompt

var h = require('heroku-cli-util');
h.prompt('email', function (email) {
  console.log(`your email is: ${email}`);
});

Errors (display in red)

var h = require('heroku-cli-util');
h.error("App not found");
// !    App not found

Warnings (display in yellow)

var h = require('heroku-cli-util');
h.warn("App not found");
// !    App not found

Tables/Columns

var h = require('heroku-cli-util');
h.columnify({
  'Dynos':  1,
  'Region': 'us',
  'Stack':  'cedar-14'
});
// Dynos  1
// Region us
// Stack  cedar-14

Dates

var h = require('heroku-cli-util');
var d = new Date();
console.log(h.formatDate(d));
// 2001-01-01T08:00:00.000Z

Command

Used for initializing a plugin command. It will set the cwd to the user's current location, give you an auth'ed instance of heroku-client, and cleanly handle API exceptions.

It uses co so you can yield promises.

let h = require('heroku-cli-util');
module.exports.commands = [
  {
    topic: 'apps',
    command: 'info',
    needsAuth: true,
    needsApp: true,
    run: h.command(function* (context, heroku) {
      let app = yield heroku.apps(context.app).info();
      console.dir(app);
    })
  }
];

Preauth

var h = require('heroku-cli-util');
h.preauth("APPNAME", "APITOKEN", function (err) {
  console.log('preauthed');
});

Tests

npm install
npm test

License

ISC