{"_id":"cli-usage","_rev":"33498","name":"cli-usage","description":"Easily show CLI usage from a markdown source file","dist-tags":{"latest":"0.1.10"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"time":{"modified":"2021-06-03T10:06:13.000Z","created":"2014-07-28T22:31:56.514Z","0.1.10":"2019-09-23T06:19:38.395Z","0.1.9":"2019-04-15T11:06:22.324Z","0.1.8":"2018-09-08T08:16:07.044Z","0.1.7":"2018-01-11T07:18:19.831Z","0.1.4":"2016-09-08T08:51:28.114Z","0.1.3":"2016-09-02T20:04:19.876Z","0.1.2":"2015-08-26T17:05:50.752Z","0.1.1":"2014-07-28T22:31:56.514Z"},"users":{"dylanf":true},"author":{"name":"Mikael Brevik"},"repository":{"type":"git","url":"git+https://github.com/mikaelbr/cli-usage.git"},"versions":{"0.1.10":{"name":"cli-usage","version":"0.1.10","description":"Easily show CLI usage from a markdown source file","repository":{"type":"git","url":"git+https://github.com/mikaelbr/cli-usage.git"},"bugs":{"url":"https://github.com/mikaelbr/cli-usage/issues"},"homepage":"https://github.com/mikaelbr/cli-usage","main":"index.js","scripts":{"test":"mocha tests.js -R spec"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.7.0","marked-terminal":"^3.3.0"},"devDependencies":{"mocha":"^6.2.0"},"gitHead":"2974153db243d8d28ae2a872a9ee21f61586d0e0","_id":"cli-usage@0.1.10","_nodeVersion":"12.7.0","_npmVersion":"6.11.3","dist":{"shasum":"2c9d30a3824b48d161580a8f8d5dfe53d66b00d2","size":1902,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.10.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.10.tgz"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-usage_0.1.10_1569219578206_0.22475988704392624"},"_hasShrinkwrap":false,"publish_time":1569219578395,"_cnpm_publish_time":1569219578395},"0.1.9":{"name":"cli-usage","version":"0.1.9","description":"Easily show CLI usage from a markdown source file","repository":{"type":"git","url":"git+https://github.com/mikaelbr/cli-usage.git"},"bugs":{"url":"https://github.com/mikaelbr/cli-usage/issues"},"homepage":"https://github.com/mikaelbr/cli-usage","main":"index.js","scripts":{"test":"mocha tests.js -R spec"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.6.2","marked-terminal":"^3.2.0"},"devDependencies":{"mocha":"^4.1.0"},"gitHead":"860390dcacc543949f940a427921ecc279ee091c","_id":"cli-usage@0.1.9","_nodeVersion":"11.10.0","_npmVersion":"6.8.0","dist":{"shasum":"a81d0f78af3999be3f51cb5cb6e8b2d3c02f4a44","size":1900,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.9.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.9.tgz"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-usage_0.1.9_1555326382162_0.3633241630034776"},"_hasShrinkwrap":false,"publish_time":1555326382324,"_cnpm_publish_time":1555326382324},"0.1.8":{"name":"cli-usage","version":"0.1.8","description":"Easily show CLI usage from a markdown source file","repository":{"type":"git","url":"git+https://github.com/mikaelbr/cli-usage.git"},"bugs":{"url":"https://github.com/mikaelbr/cli-usage/issues"},"homepage":"https://github.com/mikaelbr/cli-usage","main":"index.js","scripts":{"test":"mocha tests.js -R spec"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.5.0","marked-terminal":"^3.0.0"},"devDependencies":{"mocha":"^4.1.0"},"gitHead":"4443ba385799fc42e8d700f7628d1be897f2cb0a","_id":"cli-usage@0.1.8","_npmVersion":"6.4.1","_nodeVersion":"10.10.0","_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"dist":{"shasum":"16479361f3a895a81062d02d9634827c713aaaf8","size":1900,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.8.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.8.tgz"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-usage_0.1.8_1536394566942_0.8488283237324579"},"_hasShrinkwrap":false,"publish_time":1536394567044,"_cnpm_publish_time":1536394567044},"0.1.7":{"name":"cli-usage","version":"0.1.7","description":"Easily show CLI usage from a markdown source file","main":"index.js","scripts":{"test":"mocha tests.js -R spec"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.3.12","marked-terminal":"^2.0.0"},"devDependencies":{"mocha":"^4.1.0"},"gitHead":"5493d603ee7d233d88606260c433eff8eb07a959","_id":"cli-usage@0.1.7","_npmVersion":"5.5.1","_nodeVersion":"8.9.3","_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"dist":{"shasum":"eaf1c9d5b91e22482333072a12127f05cd99a3ba","size":1834,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.7.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.7.tgz"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-usage-0.1.7.tgz_1515655099685_0.6258480006363243"},"directories":{},"publish_time":1515655099831,"_hasShrinkwrap":false,"_cnpm_publish_time":1515655099831},"0.1.4":{"name":"cli-usage","version":"0.1.4","description":"Easily show CLI usage from a markdown source file","main":"index.js","scripts":{"test":"mocha tests.js -R spec"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.3.6","marked-terminal":"^1.6.2"},"devDependencies":{"mocha":"^3.0.2"},"gitHead":"998afc5fe38325f26c043a93d554ec5cc5ef8a0b","_id":"cli-usage@0.1.4","_shasum":"7c01e0dc706c234b39c933838c8e20b2175776e2","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.1","_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"dist":{"shasum":"7c01e0dc706c234b39c933838c8e20b2175776e2","size":1902,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.4.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.4.tgz"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/cli-usage-0.1.4.tgz_1473324686930_0.2721161802764982"},"directories":{},"publish_time":1473324688114,"_cnpm_publish_time":1473324688114,"_hasShrinkwrap":false},"0.1.3":{"name":"cli-usage","version":"0.1.3","description":"Easily show CLI usage from a markdown source file","main":"index.js","scripts":{"test":"mocha tests.js -R spec"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.3.6","marked-terminal":"^1.6.2","mocha":"^3.0.2"},"devDependencies":{"mocha":"*"},"gitHead":"435af8783718f759684c6546c8256a235e2a4755","_id":"cli-usage@0.1.3","_shasum":"57fd40617dff91e75c7db32ec024a4b893e3d81f","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.1","_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"dist":{"shasum":"57fd40617dff91e75c7db32ec024a4b893e3d81f","size":1905,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.3.tgz"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/cli-usage-0.1.3.tgz_1472846658078_0.8912871729116887"},"directories":{},"publish_time":1472846659876,"_cnpm_publish_time":1472846659876,"_hasShrinkwrap":false},"0.1.2":{"name":"cli-usage","version":"0.1.2","description":"Easily show CLI usage from a markdown source file","main":"index.js","scripts":{"test":"mocha tests.js -R spec"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.3.2","marked-terminal":"^1.6.1","minimist":"^0.2.0"},"devDependencies":{"mocha":"^1.21.3"},"gitHead":"240f39aa2d2db7abb8ab81029c1872eac428f443","_id":"cli-usage@0.1.2","_shasum":"497c20eaf12ec2779393a9bfac225c5f6cb9152d","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.5","_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"dist":{"shasum":"497c20eaf12ec2779393a9bfac225c5f6cb9152d","size":2715,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.2.tgz"},"directories":{},"publish_time":1440608750752,"_cnpm_publish_time":1440608750752,"_hasShrinkwrap":false},"0.1.1":{"name":"cli-usage","version":"0.1.1","description":"Easily show CLI usage from a markdown source file","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"author":{"name":"Mikael Brevik"},"license":"MIT","dependencies":{"marked":"^0.3.2","minimist":"^0.2.0","marked-terminal":"^0.1.0"},"_id":"cli-usage@0.1.1","dist":{"shasum":"4fa60aa9cdf005baf6b2889f6748b34159f25b8c","size":2375,"noattachment":false,"key":"/cli-usage/-/cli-usage-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-usage/download/cli-usage-0.1.1.tgz"},"_from":".","_npmVersion":"1.4.4","_npmUser":{"name":"mikaelb","email":"mikaelbre@gmail.com"},"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"directories":{},"publish_time":1406586716514,"_cnpm_publish_time":1406586716514,"_hasShrinkwrap":false}},"readme":"# cli-usage\n\nEasily show the usage of your CLI tool from a Markdown string\nor file. You can just plug `cli-usage` in without thinking\nabout paramters, or you can handle that your self using the\n`.get` API end-point.\n\n## Install\n\n```\nnpm install cli-usage\n```\n\n## Usage\n\nMost basic usage, just plug in:\n\n```javascript\nvar usage = require('cli-usage');\nusage();\n//=> If help-flag is passed, print usage\n//=> and exit with code 0.\n```\n\nThis will listen for `-h`, `-help` or `--help` passed\ninto your CLI and try to locate a `usage.md` file from\nthe directory of the file. If `help` is passed and the\n`usage.md` file found, the usage will be printed and\nthe application will exit with code `0`.\n\nYou can also pass in a filename or a string.\n\n```javascript\nvar usage = require('cli-usage');\nusage('./some/path/to/usage.md');\n```\n\nor\n\n```javascript\nvar usage = require('cli-usage');\nusage('# Simple usage');\n```\n\n### Get compiled usage\nInstead of `cli-usage` doing all the work, you can\nalso just retrieve the compiled usage text and handle\nit your self.\n\n#### Example\n```javascript\nvar usage = require('cli-usage');\n\nconsole.log(usage.get('# some custom markdown from string'));\n\nconsole.log(usage.get('./usage.md'));\n```\n","_attachments":{},"homepage":"https://github.com/mikaelbr/cli-usage","bugs":{"url":"https://github.com/mikaelbr/cli-usage/issues"},"license":"MIT"}