Auto-generate program usage info when using the protogram module
npm install protogram-helpprotogram-help
===================

A simple to use, help module to auto generate usage info when using the protogram module for node.js.
``bash`
npm install --save protogram-help
`javascript`
var program = require('protogram').create();
var help = require('protogram-help');
`javascript`
help.set({
version: '0.0.3',
name: 'Protogram Help Example',
handleError: true
});
`javascript`
program
.command('*', { includeRoot: true })
.option('--help', help);
- 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.
`javascript`
help.set({
version: '0.0.3',
name: 'Protogram Help Example',
handleError: true
});
Or use it directly when setting your --help option:`javascript`
program
.command('*', { includeRoot: true })
.option('--help', help.set({
version: '0.0.3',
name: 'Protogram Help Example',
handleError: true
}));
`javascript
help.version = '0.0.3';
`$3
Alternative to help.set({name: xxx })`javascript
help.name = 'Protogram Help Example';
`$3
Alternative to help.set({handleError: xxx })`javascript
help.handleError = true;
``The MIT License (MIT)
Copyright (c) 2014 Arjun Mehta