{
  "name": "argv",
  "description": "CLI Argument Parser",
  "url": "http://codenothing.github.com/argv/",
  "keywords": [
    "cli",
    "argv",
    "options"
  ],
  "author": {
    "name": "Corey Hart",
    "email": "corey@codenothing.com"
  },
  "version": "0.0.2",
  "main": "./index.js",
  "engines": {
    "node": ">=0.6.10"
  },
  "scripts": {
    "test": "make test"
  },
  "dependencies": {},
  "devDependencies": {
    "nlint": "0.0.4",
    "munit": "0.0.5"
  },
  "readme": "# argv\n\nargv is a nodejs module that does command line argument parsing.  \n  \n[![Build Status](https://travis-ci.org/codenothing/argv.png?branch=master)](https://travis-ci.org/codenothing/argv)  \n\n### Installation\n\n```bash\n$ npm install argv\n```\n\n\n### Usage\n\n```js\nvar argv = require( 'argv' );\nvar args = argv.option( options ).run();\n-> { targets: [], options: {} }\n```\n\n\n### Run\n\nRuns the argument parser on the global arguments. Custom arguments array can be used by passing into this method\n\n```js\n// Parses default arguments 'process.argv.slice( 2 )'\nargv.run();\n\n// Parses array instead\nargv.run([ '--option=123', '-o', '123' ]);\n```\n\n\n### Options\n\nargv is a strict argument parser, which means all options must be defined before parsing starts.\n\n```js\nargv.option({\n\tname: 'option',\n\tshort: 'o',\n\ttype: 'string',\n\tdescription: 'Defines an option for your script',\n\texample: \"'script --opiton=value' or 'script -o value'\"\n});\n```\n\n\n### Modules\n\nModules are nested commands for more complicated scripts. Each module has it's own set of options that\nhave to be defined independently of the root options.\n\n```js\nargv.mod({\n\tmod: 'module',\n\tdescription: 'Description of what the module is used for',\n\toptions: [ list of options ]\n});\n```\n\n\n### Types\n\nTypes convert option values to useful js objects. They are defined along with each option.\n\n* **string**: Ensure values are strings\n* **path**: Converts value into a fully resolved path.\n* **int**: Converts value into an integer\n* **float**: Converts value into a float number\n* **boolean**: Converts value into a boolean object. 'true' and '1' are converted to true, everything else is false.\n* **csv**: Converts value into an array by splitting on comma's.\n* **list**: Allows for option to be defined multiple times, and each value added to an array\n* **[list|csv],[type]**: Combo type that allows you to create a list or csv and convert each individual value into a type.\n\n```js\nargv.option([\n\t{\n\t\tname: 'option',\n\t\ttype: 'csv,int'\n\t},\n\t{\n\t\tname: 'path',\n\t\tshort: 'p',\n\t\ttype: 'list,path'\n\t}\n]);\n\n// csv and int combo\n$ script --option=123,456.001,789.01\n-> option: [ 123, 456, 789 ]\n\n// list and path combo\n$ script -p /path/to/file1 -p /path/to/file2\n-> option: [ '/path/to/file1', '/path/to/file2' ]\n```\n\nYou can also create your own custom type for special conversions.\n\n```js\nargv.type( 'squared', function( value ) {\n\tvalue = parseFloat( value );\n\treturn value * value;\n});\n\nargv.option({\n\tname: 'square',\n\tshort: 's',\n\ttype: 'squared'\n});\n\n$ script -s 2\n-> 4\n```\n\n\n### Version\n\nDefining the scripts version number will add the version option and print it out when asked.\n\n```js\nargv.version( 'v1.0' );\n\n$ script --version\nv1.0\n\n```\n\n\n### Info\n\nCustom information can be displayed at the top of the help printout using this method\n\n```js\nargv.info( 'Special script info' );\n\n$ script --help\n\nSpecial script info\n\n... Rest of Help Doc ...\n```\n\n\n### Clear\n\nIf you have competing scripts accessing the argv object, you can clear out any previous options that may have been set.\n\n```js\nargv.clear().option( [new options] );\n```\n\n\n### Help\n\nargv injects a default help option initially and on clears. The help() method triggers the help printout.\n\n```js\nargv.help();\n```\n\n----\n### License\n\n```\nThe MIT License\n\nCopyright (c) 2012-2013 Corey Hart\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n```\n",
  "readmeFilename": "README.md",
  "_id": "argv@0.0.2",
  "_from": "argv@"
}
