{"maintainers":[{"name":"mikaelb","email":"mikaelbre@gmail.com"}],"keywords":["CLI-Usage","Markdown","Usage","CLI","Print-Usage"],"dist-tags":{"latest":"0.1.4"},"author":{"name":"Mikael Brevik"},"description":"Easily show CLI usage from a markdown source file","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","users":{"dylanf":true},"license":"MIT","versions":{"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","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/cli-usage/-/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":{}},"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","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/cli-usage/-/cli-usage-0.1.2.tgz"},"directories":{}},"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","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/cli-usage/-/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":{}},"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","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/cli-usage/-/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":{}}},"name":"cli-usage","time":{"modified":"2016-09-08T08:51:28.114Z","created":"2014-07-28T22:31:56.514Z","0.1.1":"2014-07-28T22:31:56.514Z","0.1.2":"2015-08-26T17:05:50.752Z","0.1.3":"2016-09-02T20:04:19.876Z","0.1.4":"2016-09-08T08:51:28.114Z"},"readmeFilename":"README.md"}