meow

CLI app helper

meow

CLI app helper

  • Parses arguments using minimist
  • Converts flags to camelCase
  • Outputs version when --version
  • Outputs description and supplied help text when --help
$ npm install --save meow
$ ./foo-app.js unicorns --rainbow-cake
#!/usr/bin/env node
'use strict';
var meow = require('meow');
var fooApp = require('./');
 
var cli = meow({
    help: [
        'Usage',
        '  foo-app <input>'
    ].join('\n')
});
/*
{
    input: ['unicorns'],
    flags: {rainbowCake: true},
    ...
}
*/
 
fooApp(cli.input[0], cli.flags);

Returns an object with:

  • input (array) - Non-flag arguments
  • flags (object) - Flags converted to camelCase
  • pkg (object) - The package.json object
  • help (object) - The help text used with --help
  • showHelp() (function) - Show the help text and exit

Type: string, boolean

The help text you want shown.

If you don't specify anything, it will still show the package.json "description".

Set it to false to disable it all together.

Type: string, boolean
Default: the package.json "version" property

Set a custom version output.

Set it to false to disable it all together.

Type: string, object
Default: package.json

Relative path to package.json or it as an object.

Type: array
Default: process.argv.slice(2)

Custom arguments object.

Type: object
Default: {}

Minimist options.

MIT © Sindre Sorhus