simpleargs

Simple Arguments processing for Node.js

npm install simpleargs
2 downloads in the last week
11 downloads in the last month

SimpleArgs

Simple Command Line Arguments process, for Node.js.

Installation

Via npm on Node:

npm install simpleargs

Reference in your program:

var simpleargs = require('simpleargs');

Usage


// define parameters, with short name, name, default value and description
simpleargs.define('p','port',3000,'Port number')
    .define('h','host','localhost', 'Host name/address')
// define value to receive     
    .defineValue('message', 'hello, world', 'Message to send');

// if you call the program
// node hello.js 'Hello, world' -p 4000 --host 'mydomain'        
var options = simpleargs.process(process.argv);
// then options is { message: 'Hello, world', port: 4000, host: 'mydomain' }

Development

git clone git://github.com/ajlopez/SimpleArgs.git
cd SimpleArgs
npm install
npm test

Samples

TBD

To do

  • Invalid parameters
  • Show usage

Versions

  • 0.0.1: Published

Contribution

Feel free to file issues and submit pull requests � contributions are welcome.

If you submit a pull request, please be sure to add or update corresponding test cases, and ensure that npm test continues to pass.

(Thanks to JSON5 by aseemk. This file is based on that project README.md).

npm loves you