Command line args parser.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.jshintrc
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

jargvy

Command line args parser.

Getting Started

Install the module with: npm install jargvy

// get it
var jargvy = require('jargvy');

/**
  define rules. 
  'id' is command line arg label
  'name' is what you want to call the option
  'default' is the default value
  'type' which can be one of ['number', 'string', 'boolean]
    lets you define a type without specifying a default
  --flag creates a bool flag that needs no default/type.
    It defaults to true when detected
*/
var rules = [
  {'id': '-str', 'name': 'str', 'default': '.' },
  {'id': '-num', 'name': 'num', 'default': 5 },
  {'id': '-bool', 'name': 'bool', 'default': true },
  {'id': '--help', 'name': 'help'},
];
jargvy.define(rules);

// parse params
var options = jargvy.extract();
// options will be something like {"str": "./dir", "num": 5}

License

Copyright (c) 2014 Mustafa Rizvi
Licensed under the MIT license.