npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@heroku/heroku-cli-util

v8.0.15

Published

Set of helpful CLI utilities

Downloads

20,576

Maintainers

jesse.brown-sfjesse.brown-sfmgomes-herokumgomes-herokusruthichsruthichmarcusblankenshipmarcusblankenshipbrittany.jonesbrittany.jonesviniljainviniljainjoshwlewis-sfdcjoshwlewis-sfdcmengxiao.zhaomengxiao.zhaodlira-sfdlira-sfjulianduque-sfdcjulianduque-sfdcnilamuthunilamuthusmrutisamantasmrutisamantajdowningjdowningdpark.herokudpark.herokunnaidu9nnaidu9cgfuhcgfuhyann_ckyann_ckjeffrey.estradajeffrey.estradacwallsfcwallsfaklimaiteaklimaiterishabh.wasonrishabh.wasondzuelke-sfdcdzuelke-sfdcdgallegossfdcdgallegossfdcsmukusmukukmichalskiskmichalskiscory.steelecory.steeleykatzykatzkerry-bennettkerry-bennettangelayoungangelayoungdreichenbergdreichenbergmble-sfdc-2mble-sfdc-2taylor.jonestaylor.jonessfjonnpmsfjonnpmsimonebonettisfitasimonebonettisfitakamakshinagarkamakshinagarafraidknotafraidknotvish_herokuvish_herokusarahoh2468sarahoh2468sghaffarsghaffardkabanov1dkabanov1sbosio_sfsbosio_sfangelcampbellangelcampbell7ftz7ftzsfalansfalanhillzbot2000hillzbot2000kdreyerorenkdreyerorenrcrossrcrosslsorstokkelsorstokkesudarshanhiraysudarshanhirayalex_herokualex_herokurajashri-gurusamyrajashri-gurusamymandeepsfmandeepsfmingzhi-liu1258mingzhi-liu1258beanieboibeanieboidougmcinnes-sfdcdougmcinnes-sfdcbeckychenbeckychendasofieidasofieixx-sfdc-npmxx-sfdc-npmkpremkumarkpremkumarstessema-sfcstessema-sfcchap-herokuchap-herokudhammer25dhammer25ndavidson-sfndavidson-sfumarsfdcumarsfdccdwort-sfdccdwort-sfdcapoorvasrivapoorvasrivmichellejhlimmichellejhlimjhili!16jhili!16apadalaapadalacmcclung-npm-salesforce.comcmcclung-npm-salesforce.comrstiltonsfrstiltonsftlowrimoretlowrimorerchandarchandaabhinavkoulabhinavkouldaniel.brightdaniel.brightjonnymacjonnymacjustinwilaby-sfjustinwilaby-sfcv88cv88aaronromeosfdcaaronromeosfdctenharmsel_sftenharmsel_sfekozilforceekozilforcecoreypurcell_salesforcecoreypurcell_salesforcejmonrealjmonrealsconklinsconklinsuppadasuppadagnettergnettertkoh-sfdctkoh-sfdcjasoncummings-herokujasoncummings-herokudiana.doherty.sfdcdiana.doherty.sfdcjoeybrown90sfjoeybrown90sfrsoerensenrsoerensenademusoyoademusoyolsangalang2023lsangalang2023ccaseyccaseyryanbrainardryanbrainardmarcelsfdcmarcelsfdcnrisaronrisarochetankd10chetankd10kscareykscareybemory-herokubemory-herokurevativelagadarevativelagadabrock-salesforcebrock-salesforcebencdentonbencdentonrafaydinrafaydindhagberg-sfdhagberg-sfelzoonaelzoonacmarcojoscmarcojosadirasanamadirasanamkbaird-sfkbaird-sfbhawnaherokubhawnaherokujondaniel-sfdcjondaniel-sfdcgkomminenigkomminenip.shreyap.shreyasai_harshitha_neelasai_harshitha_neelaktsforcektsforcehkiihkiiheroku-front-endheroku-front-endvammundravammundrathe7okathe7okavlazukavlazukagrismar17grismar17lucaszhoulucaszhoumarsmarsnlanattanlanattapranamsharmapranamsharmanrenkenrenkerichatiwaririchatiwaripsalimpsalimwchrisjohnsonwchrisjohnsonagatpareekagatpareekswapnilghoseswapnilghosemgates-salesforcemgates-salesforceryoneyamaryoneyamasripad.kulkarnisripad.kulkarnianujpandey001anujpandey001dboston528dboston528adirksmeieradirksmeierchristopher.josechristopher.josecbaxtersfcbaxtersfmttrmttrtetsuya_tetsuya_daebumleedaebumleemsaminenimsaminenisrishtigautamsrishtigautampbommapbommalalitreddylalitreddyzli-sfzli-sfsbaner18sbaner18joanneyeungjoanneyeungpaguilarpaguilarbleongbleongmontes_herokumontes_herokupfuentepfuentesaikrishna0202saikrishna0202jwadsworthsfjwadsworthsfjheikesjheikesmimenmimendaigo-herokudaigo-herokujmccartiejmccartiejordaneekeyjordaneekeylmckenzielmckenziev.anandv.anandarajaarajasarassassinsarassassinreidmixreidmixmbuschherokumbuschherokuk.plentyk.plentyeblackeblacksheax0rsheax0rk80bowmank80bowmanrdagg-herordagg-herogrundy.ggrundy.grobinson.mrobinson.mtcareysmith-sfdctcareysmith-sfdcptemporiniptemporinipaulaprado18paulaprado18harish.457harish.457jsullivandigsjsullivandigsntonollierntonollierelearyelearysalesforce-releasessalesforce-releases

Keywords

Readme

Heroku CLI Utilities

GitHub Actions CI npm version License

Set of helpful CLI utilities

Installation

npm install heroku-cli-util --save

Action

let cli = require('heroku-cli-util');
await cli.action('restarting dynos', async function() {
  let app = await heroku.get(`/apps/${context.app}`);
  await heroku.request({method: 'DELETE', path: `/apps/${app.name}/dynos`});
});

// restarting dynos... done

Prompt

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

cli.prompt options

cli.prompt('email', {
  mask: true, // mask input field after submitting
  hide: true // mask characters while entering
});

Confirm App

Supports the same async styles as prompt(). Errors if not confirmed.

Basic

let cli = require('heroku-cli-util');
await cli.confirmApp('appname', context.flags.confirm);

// !     WARNING: Destructive Action
// !     This command will affect the app appname
// !     To proceed, type appname or re-run this command with --confirm appname

> appname

Custom message

let cli = require('heroku-cli-util');
await cli.confirmApp('appname', context.flags.confirm, 'foo');

// !     foo
// !     To proceed, type appname or re-run this command with --confirm appname

> appname

Note that you will still need to define a confirm flag for your command.

Errors

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

Warnings

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

Dates

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

Hush

Use hush for verbose logging when HEROKU_DEBUG=1.

let cli = require('heroku-cli-util');
cli.hush('foo');
// only prints if HEROKU_DEBUG is set

Debug

Pretty print an object.

let cli = require('heroku-cli-util');
cli.debug({foo: [1,2,3]});
// { foo: [ 1, 2, 3 ] }

Stylized output

Pretty print a header, hash, and JSON

let cli = require('heroku-cli-util');
cli.styledHeader("MyApp");
cli.styledHash({name: "myapp", collaborators: ["[email protected]", "[email protected]"]});
cli.styledJSON({name: "myapp"});

Produces

=== MyApp
Collaborators: [email protected]
               [email protected]
Name:          myapp

{
  "name": "myapp"
}

Table

cli.table([
  {app: 'first-app',  language: 'ruby', dyno_count: 3},
  {app: 'second-app', language: 'node', dyno_count: 2},
], {
  columns: [
    {key: 'app'},
    {key: 'dyno_count', label: 'Dyno Count'},
    {key: 'language', format: language => cli.color.red(language)},
  ]
});

Produces:

app         Dyno Count  language
──────────  ──────────  ────────
first-app   3           ruby
second-app  2           node

Linewrap

Used to indent output with wrapping around words:

cli.log(cli.linewrap(2, 10, 'this is text is longer than 10 characters'));
// Outputs:
//
// this
// text is
//  longer
//  than 10
//  characters`);

Useful with process.stdout.columns || 80.

Open Web Browser

await cli.open('https://github.com');

HTTP calls

heroku-cli-util includes an instance of got that will correctly use HTTP proxies.

let cli = require('heroku-cli-util');
let rsp = await cli.got('https://google.com');

Mocking

Mock stdout and stderr by using cli.log() and cli.error().

let cli = require('heroku-cli-util');
cli.log('message 1'); // prints 'message 1'
cli.mockConsole();
cli.log('message 2'); // prints nothing
cli.stdout.should.eq('message 2\n');

Command

Used for initializing a plugin command. give you an auth'ed instance of heroku-client and cleanly handle API exceptions.

It expects you to return a promise chain. This is usually done with co.

let cli = require('heroku-cli-util');
let co  = require('co');
module.exports.commands = [
  {
    topic: 'apps',
    command: 'info',
    needsAuth: true,
    needsApp: true,
    run: cli.command(async function (context, heroku) {
      let app = await heroku.get(`/apps/${context.app}`);
      console.dir(app);
    })
  }
];

With options:

let cli = require('heroku-cli-util');
let co  = require('co');
module.exports.commands = [
  {
    topic: 'apps',
    command: 'info',
    needsAuth: true,
    needsApp: true,
    run: cli.command(
      {preauth: true},
      async function (context, heroku) {
        let app = await heroku.get(`/apps/${context.app}`);
        console.dir(app);
      }
    )
  }
];

If the command has a two_factor API error, it will ask the user for a 2fa code and retry. If you set preauth: true it will preauth against the current app instead of just setting the header on an app. (This is necessary if you need to do more than 1 API call that will require 2fa)

Tests

npm install
npm test

License

ISC