Skip to content

Files

Latest commit

2e8c207 · Oct 29, 2017

History

History
59 lines (45 loc) · 1.12 KB

meow.md

File metadata and controls

59 lines (45 loc) · 1.12 KB
title category layout updated weight intro
Meow
JavaScript libraries
2017/sheet
2017-10-30
-1
[meow](https://npmjs.com/package/meow) is the easiest way to write command line apps for Node.js.

Typical settings

const cli = require('meow')(`
  Usage: appname [options]

  Options:
        --lang LANG    set the language

  Other options:
    -h, --help         show usage information
    -v, --version      print version info and exit
`, {
  string: ['lang'],
  boolean: ['help', 'version'],
  alias: { h: 'help', v: 'version' }
})

string and boolean lets meow/minimist know which flags expect arguments (string) and which don't (boolean).

Using the result

cli.flags   // { lang: 'en' }
cli.input   // []

Yes, flags are automatically camelCased!

Lesser-used settings

meow(`...`, {
  // Default values if flags are not specified
  default: { lang: 'en' },

  // allow using -- to stop processing flags
  '--': true,

  // Populate `_` with first non-option
  stopEarly: true,

  // Invoked on unknown param
  unknown: function () { ... }
})

Also see minimist.