{"_id":"protogram-help","_rev":"6-5e57531df208c20cf1c5bf2c66b3d16b","name":"protogram-help","description":"Auto-generate program usage info when using the protogram module","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.1":{"name":"protogram-help","version":"1.0.1","description":"auto generate usage info when using the protogram module","main":"main.js","scripts":{"test":"nodeunit test/test.js"},"repository":{"type":"git","url":"https://github.com/arjunmehta/node-protogram-help.git"},"keywords":["commander","help","protogram","program","command","line","usage","information"],"author":{"name":"Arjun Mehta"},"license":"MIT","bugs":{"url":"https://github.com/arjunmehta/node-protogram-help/issues"},"homepage":"https://github.com/arjunmehta/node-protogram-help","dependencies":{"columnify":"~1.3.2","pkginfo":"~0.3.0"},"devDependencies":{"nodeunit":"~0.8.8","protogram":"~1.1.0"},"gitHead":"ca1cb7d03c2a1a3cd50561f4f8e07ceb3ca83c5d","_id":"protogram-help@1.0.1","_shasum":"659099f76886190e8d4e0454fdf005c1d9a418bb","_from":".","_npmVersion":"2.1.14","_nodeVersion":"0.10.35","_npmUser":{"name":"arjunmehta","email":"arjunmeht@gmail.com"},"maintainers":[{"name":"arjunmehta","email":"arjunmeht@gmail.com"}],"dist":{"shasum":"659099f76886190e8d4e0454fdf005c1d9a418bb","tarball":"https://registry.npmjs.org/protogram-help/-/protogram-help-1.0.1.tgz","integrity":"sha512-FTsEMvBRKhxqBxfIBXYsZOG/zxDkMTHPtep7YNBkmQXKVDS0tCYajcg6vVQDwlGQlxuC813TELE5Cu8h0OrNXQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEA/e8Ifnrr1d64maop+niZfbCxuJtSzStSEaUM+F8V8AiEA6nctHwIhaBYiZ/wwUvTeWa0YWSBrz6bYyZY3mUJVRw8="}]}},"1.0.2":{"name":"protogram-help","version":"1.0.2","description":"Auto-generate program usage info when using the protogram module","main":"main.js","scripts":{"test":"nodeunit test/test.js"},"repository":{"type":"git","url":"https://github.com/arjunmehta/node-protogram-help.git"},"keywords":["commander","help","protogram","program","command","line","usage","information"],"author":{"name":"Arjun Mehta"},"license":"MIT","bugs":{"url":"https://github.com/arjunmehta/node-protogram-help/issues"},"homepage":"https://github.com/arjunmehta/node-protogram-help","dependencies":{"columnify":"~1.3.2","pkginfo":"~0.3.0"},"devDependencies":{"nodeunit":"~0.8.8","protogram":"~1.1.0"},"gitHead":"7258fa0992cc7247f90a5bc3096da276c77ec1a8","_id":"protogram-help@1.0.2","_shasum":"fb49cacff85fe80edb3568ac6eac78af0b032a19","_from":".","_npmVersion":"2.1.14","_nodeVersion":"0.10.35","_npmUser":{"name":"arjunmehta","email":"arjunmeht@gmail.com"},"maintainers":[{"name":"arjunmehta","email":"arjunmeht@gmail.com"}],"dist":{"shasum":"fb49cacff85fe80edb3568ac6eac78af0b032a19","tarball":"https://registry.npmjs.org/protogram-help/-/protogram-help-1.0.2.tgz","integrity":"sha512-6s6DJh7V5mk1afjx3pdxns98/BmrBEOBzWsMKU8acaLgq6Iv6FNUn0nDq6uX2SmQy4vtpjjJOx93hk8q3ulCJg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGgH0QNoqvr9n4WEyiF942WA61wnLsXSndpyUTZBIaqSAiBvCSF7EmF0/MEcDVpCBXsgu4ePDqf+zYJ1COYALrOrIA=="}]}}},"readme":"protogram-help\n===================\n\n[![Build Status](https://travis-ci.org/arjunmehta/node-protogram-help.svg?branch=master)](https://travis-ci.org/arjunmehta/node-protogram-help)\n\n\nA simple to use, help module to auto generate usage info when using the [protogram](https://github.com/arjunmehta/node-protogram) module for node.js.\n\n## Installation\n\n```bash\nnpm install --save protogram-help\n```\n\n## Basic Usage\n\n### Include with Protogram\n\n```javascript\nvar program = require('protogram').create();\nvar help = require('protogram-help');\n```\n\n### Configure Your Help (if you want)\n\n```javascript\nhelp.set({\n    version: '0.0.3',\n    name: 'Protogram Help Example',\n    handleError: true\n});\n```\n\n### Add as an Option Flag\n\n```javascript\nprogram\n    .command('*', { includeRoot: true })\n    .option('--help', help);\n```\n\n### Done.\n\n\n## API\n\n### help.set(options)\nSets certain options that will be used to handle the display of usage information.\n\n- `options` **Object**:\n    - `version` **String**: Your program's version number.\n    - `name` **String**: The name of your program.\n    - `handleError` **Boolean**: Output usage information for your program if there is an argument error.\n\n```javascript\nhelp.set({\n    version: '0.0.3',\n    name: 'Protogram Help Example',\n    handleError: true\n});\n```\n\nOr use it directly when setting your `--help` option:\n```javascript\nprogram\n    .command('*', { includeRoot: true })\n    .option('--help', help.set({\n        version: '0.0.3',\n        name: 'Protogram Help Example',\n        handleError: true\n    }));\n```\n\n### help.version\nAlternative to `help.set({version: xxx })`\n\n```javascript\nhelp.version = '0.0.3';\n```\n\n### help.name\nAlternative to `help.set({name: xxx })`\n\n```javascript\nhelp.name = 'Protogram Help Example';\n```\n\n### help.handleError\nAlternative to `help.set({handleError: xxx })`\n\n```javascript\nhelp.handleError = true;\n```\n\n\n## License\n\nThe MIT License (MIT)\nCopyright (c) 2014 Arjun Mehta\n","maintainers":[{"name":"arjunmehta","email":"arjunmeht@gmail.com"}],"time":{"modified":"2022-06-24T21:02:14.006Z","created":"2015-01-09T23:47:35.348Z","1.0.1":"2015-01-09T23:47:35.348Z","1.0.2":"2015-01-10T17:55:05.124Z"},"homepage":"https://github.com/arjunmehta/node-protogram-help","keywords":["commander","help","protogram","program","command","line","usage","information"],"repository":{"type":"git","url":"https://github.com/arjunmehta/node-protogram-help.git"},"author":{"name":"Arjun Mehta"},"bugs":{"url":"https://github.com/arjunmehta/node-protogram-help/issues"},"license":"MIT","readmeFilename":"README.md"}