get-them-args

Parse argument options

Monthly Downloads: 0

Programming language: JavaScript

License: MIT License

Tags: Utilities     Command Line Utilities     Console     Parser     Terminal     CLI     Args     Get-them-args    

Latest version: v1.3.2

README

get-them-args

Parse argument options

Table of Contents

• About
• Install
• Usage
• Contribute
• License

About

Simple CLI argument parser hacked from minimist that adds support for objects and additional initialization options.

Install

$ npm install --save get-them-args
# Or
$ yarn add get-them-args

Usage

To use, provide arguments as argument:

const parse = require('get-them-args')
const options = {} // Options to be passed. CURRENTLY NONE AVAILABLE

// $ node ./example.js --dir . --command foo
console.log(parse(process.argv.slice(2) ))
// { unknown: [], dir: '.', command: 'foo' }

console.log(parse(process.argv))
// { unknown: [], dir: '.', command: 'foo' }

console.log(parse())
// { unknown: [], dir: '.', command: 'foo' }

For example, if the arguments provided are --hello world --parse=all --no-drugs --make-friends -n 4 -t 5, the function will return:

{ unknown: [],
  hello: 'world',
  parse: 'all',
  drugs: false,
  'make-friends': true,
  n: 4,
  t: 5
}

There is also support for parsing objects:

$ node example.js --headers={"Foo": "5", "bar": "6"}
# { unknown: [], headers: { Foo: 5, bar: 6 } }

All unparsed arguments will end up in the unknown array. The following types of arguments are supported:

--key=value
--key value
--key # true
--no-key # false
-key=value
-key value

Contribute

1. Fork it and create your feature branch: git checkout -b my-new-feature
2. Commit your changes: git commit -am 'Add some feature'
3. Push to the branch: git push origin my-new-feature
4. Submit a pull request

License

MIT