protogram-help
A simple to use, help module to auto generate usage info when using the protogram module for node.js.
Installation
npm install --save protogram-help
Basic Usage
Include with Protogram
var program = ;var help = ;
Configure Your Help (if you want)
help;
Add as an Option Flag
program ;
Done.
API
help.set(options)
Sets certain options that will be used to handle the display of usage information.
options
Object:version
String: Your program's version number.name
String: The name of your program.handleError
Boolean: Output usage information for your program if there is an argument error.
help;
Or use it directly when setting your --help
option:
program ;
help.version
Alternative to help.set({version: xxx })
helpversion = '0.0.3';
help.name
Alternative to help.set({name: xxx })
helpname = 'Protogram Help Example';
help.handleError
Alternative to help.set({handleError: xxx })
helphandleError = true;
License
The MIT License (MIT) Copyright (c) 2014 Arjun Mehta