minimist
    Overview
    Playground
    Code
    Issues
    Career Opportunities
    Alternatives
    Dependencies
    Documentation
    Find an Expert
    Versions
    Insights & Analysis

minimist

parse argument options

1.2.0  •  Published 4 years ago  •  by James Halliday  •  MIT License

parse argument options

This module is the guts of optimist’s argument parser without all the fanciful decoration.

browser support

build status

example

var argv = require('minimist')(process.argv.slice(2));
console.dir(argv);
$ node example/parse.js -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }
$ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop foo bar baz
{ _: [ 'foo', 'bar', 'baz' ],
  x: 3,
  y: 4,
  n: 5,
  a: true,
  b: true,
  c: true,
  beep: 'boop' }

methods

var parseArgs = require('minimist')

var argv = parseArgs(args, opts={})

Return an argument object argv populated with the array arguments from args.

argv._ contains all the arguments that didn’t have an option associated with them.

Numeric-looking arguments will be returned as numbers unless opts.string or opts.boolean is set for that argument name.

Any arguments after '--' will not be parsed and will end up in argv._.

options can be:

  • opts.string - a string or array of strings argument names to always treat as strings
  • opts.boolean - a boolean, string or array of strings to always treat as booleans. if true will treat all double hyphenated arguments without equal signs as boolean (e.g. affects --foo, not -f or --foo=bar)
  • opts.alias - an object mapping string names to strings or arrays of string argument names to use as aliases
  • opts.default - an object mapping string argument names to default values
  • opts.stopEarly - when true, populate argv._ with everything after the first non-option
  • opts['--'] - when true, populate argv._ with everything before the -- and argv['--'] with everything after the --. Here’s an example:
  • opts.unknown - a function which is invoked with a command line parameter not defined in the opts configuration object. If the function returns false, the unknown option is not added to argv.
> require('./')('one two three -- four five --six'.split(' '), { '--': true })
{ _: [ 'one', 'two', 'three' ],
  '--': [ 'four', 'five', '--six' ] }

Note that with opts['--'] set, parsing for arguments still stops after the --.

install

With npm do:

npm install minimist

license

MIT

Dependencies

covert  ·  tap  ·  tape

Tags

argv
getopt
parser
optimist
Get an open source license report with a click
Whether it's for legal, customers or investors, upload your package.json files, and get a comprehensive license report page and spreadsheet. No hassle, it just works!
$49 one time fee, money back guarantee

Popularity

Weekly Downloads
29.0M
Stars
3.7K

Issues and PRs

Activity

Last ver 4 years ago
Created 6 years ago
Last commit 4 years ago
13 days between commits

Sustainability

14 contributors

Technology

Node version: 2.4.0
0 unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Top Experts

James Halliday
Maintainer, 50 commits, 5 merges
Works at bits.coop
Trevor Senior
4 commits
Dominic Tarr
3 commits, 1 PRs
Works at Protozoa
ELLIOTTCABLE
2 commits, 2 PRs
Jeff Barczewski
2 commits, 1 PRs
Works at CodeWinds / Inspired Horizons
Stephane Le Cornec
1 commits, 1 PRs