{ "name": "docopt", "versions": { "0.4.0": { "name": "docopt", "version": "0.4.0", "author": { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, "contributors": [ { "name": "Andrew Kassen", "email": "atkassen@berkeley.edu" }, { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, { "name": "Stuart Carnie", "email": "stuart.carnie@gmail.com" } ], "description": "a command line option parser that will make you smile", "main": "docopt.js", "engines": { "node": ">=0.8.0" }, "keywords": [ "command", "options", "argument", "args", "cli", "commandline" ], "licenses": "MIT", "repository": { "type": "git", "url": "git://github.com/scarnie/docopt.coffee.git" }, "_id": "docopt@0.4.0", "dist": { "shasum": "3d2ec9240c0929146b694692f45bcbf135301905", "tarball": "https://registry.npmjs.org/docopt/-/docopt-0.4.0.tgz" }, "_npmVersion": "1.1.62", "_npmUser": { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" }, "maintainers": [ { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" } ], "directories": {} }, "0.4.1": { "name": "docopt", "version": "0.4.1", "author": { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, "contributors": [ { "name": "Andrew Kassen", "email": "atkassen@berkeley.edu" }, { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, { "name": "Stuart Carnie", "email": "stuart.carnie@gmail.com" } ], "description": "a command line option parser that will make you smile", "main": "docopt.js", "engines": { "node": ">=0.8.0" }, "keywords": [ "command", "options", "argument", "args", "cli", "commandline" ], "licenses": "MIT", "repository": { "type": "git", "url": "git://github.com/scarnie/docopt.coffee.git" }, "gitHead": "53be2d963ae6b96e0012d5e2055861b6fb8c6c81", "bugs": { "url": "https://github.com/scarnie/docopt.coffee/issues" }, "homepage": "https://github.com/scarnie/docopt.coffee", "_id": "docopt@0.4.1", "scripts": {}, "_shasum": "e9ae4d3d14f7fea3e48019235ebc5f1004d22e87", "_from": ".", "_npmVersion": "2.1.2", "_nodeVersion": "0.10.32", "_npmUser": { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" }, "maintainers": [ { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" } ], "dist": { "shasum": "e9ae4d3d14f7fea3e48019235ebc5f1004d22e87", "tarball": "https://registry.npmjs.org/docopt/-/docopt-0.4.1.tgz" }, "directories": {} }, "0.6.0": { "name": "docopt", "version": "0.6.0", "author": { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, "contributors": [ { "name": "Andrew Kassen", "email": "atkassen@berkeley.edu" }, { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, { "name": "Stuart Carnie", "email": "stuart.carnie@gmail.com" } ], "description": "a command line option parser that will make you smile", "main": "docopt.js", "engines": { "node": ">=0.8.0" }, "keywords": [ "command", "options", "argument", "args", "cli", "commandline" ], "licenses": "MIT", "repository": { "type": "git", "url": "git://github.com/scarnie/docopt.coffee.git" }, "gitHead": "e50b52715eb98497181de074f6192cf9266d4246", "bugs": { "url": "https://github.com/scarnie/docopt.coffee/issues" }, "homepage": "https://github.com/scarnie/docopt.coffee", "_id": "docopt@0.6.0", "scripts": {}, "_shasum": "5e39538f2474e73545e1c17347a5ff427fd1533a", "_from": ".", "_npmVersion": "2.5.0", "_nodeVersion": "0.12.0", "_npmUser": { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" }, "maintainers": [ { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" } ], "dist": { "shasum": "5e39538f2474e73545e1c17347a5ff427fd1533a", "tarball": "https://registry.npmjs.org/docopt/-/docopt-0.6.0.tgz" }, "directories": {} }, "0.6.1": { "name": "docopt", "version": "0.6.1", "author": { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, "contributors": [ { "name": "Andrew Kassen", "email": "atkassen@berkeley.edu" }, { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, { "name": "Stuart Carnie", "email": "stuart.carnie@gmail.com" }, { "name": "Matthias Rolke", "email": "mr.amtrack@gmail.com" } ], "description": "a command line option parser that will make you smile", "main": "docopt.js", "scripts": { "test": "coffee test_docopt.coffee", "test_cases": "./language_agnostic_tests/language_agnostic_tester.py ./language_agnostic_tests/testee.coffee", "lint": "coffeelint docopt.coffee", "prepublish": "coffee -c docopt.coffee" }, "engines": { "node": ">=0.10.0" }, "keywords": [ "command", "options", "argument", "args", "cli", "commandline" ], "licenses": "MIT", "repository": { "type": "git", "url": "git://github.com/scarnie/docopt.coffee.git" }, "devDependencies": { "coffee-script": "^1.9.1", "coffeelint": "^1.9.2" }, "gitHead": "0409cb1d0899c671265de4c46bdbab46a5223e34", "bugs": { "url": "https://github.com/scarnie/docopt.coffee/issues" }, "homepage": "https://github.com/scarnie/docopt.coffee", "_id": "docopt@0.6.1", "_shasum": "31f245631d9a20ddf7d13c1574a5dd418307fa50", "_from": ".", "_npmVersion": "2.7.3", "_nodeVersion": "0.12.0", "_npmUser": { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" }, "maintainers": [ { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" } ], "dist": { "shasum": "31f245631d9a20ddf7d13c1574a5dd418307fa50", "tarball": "https://registry.npmjs.org/docopt/-/docopt-0.6.1.tgz" }, "directories": {} }, "0.6.2": { "name": "docopt", "version": "0.6.2", "author": { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, "contributors": [ { "name": "Andrew Kassen", "email": "atkassen@berkeley.edu" }, { "name": "Vladimir Keleshev", "email": "vladimir@keleshev.com" }, { "name": "Stuart Carnie", "email": "stuart.carnie@gmail.com" }, { "name": "Matthias Rolke", "email": "mr.amtrack@gmail.com" } ], "description": "a command line option parser that will make you smile", "main": "docopt.js", "scripts": { "test": "mocha --compilers coffee:coffee-script/register", "lint": "coffeelint docopt.coffee test/*.coffee", "prepublish": "coffee -c docopt.coffee" }, "engines": { "node": ">=0.10.0" }, "keywords": [ "command", "options", "argument", "args", "cli", "commandline" ], "licenses": "MIT", "repository": { "type": "git", "url": "git://github.com/scarnie/docopt.coffee.git" }, "devDependencies": { "chai": "^2.2.0", "coffee-script": "^1.9.1", "coffeelint": "^1.9.2", "mocha": "^2.2.1" }, "gitHead": "198e5c72baff8a6e10832c677eba67dc29068792", "bugs": { "url": "https://github.com/scarnie/docopt.coffee/issues" }, "homepage": "https://github.com/scarnie/docopt.coffee", "_id": "docopt@0.6.2", "_shasum": "b28e9e2220da5ec49f7ea5bb24a47787405eeb11", "_from": ".", "_npmVersion": "2.7.5", "_nodeVersion": "0.12.2", "_npmUser": { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" }, "maintainers": [ { "name": "stuartcarnie", "email": "stuart.carnie@gmail.com" } ], "dist": { "shasum": "b28e9e2220da5ec49f7ea5bb24a47787405eeb11", "tarball": "https://registry.npmjs.org/docopt/-/docopt-0.6.2.tgz" }, "directories": {} } }, "time": { "modified": "2017-02-15T14:30:10.332Z", "created": "2012-10-08T18:17:04.808Z", "0.4.0": "2012-10-08T18:17:05.980Z", "0.4.1": "2014-10-07T15:49:40.894Z", "0.6.0": "2015-03-08T16:32:57.814Z", "0.6.1": "2015-03-22T00:45:51.824Z", "0.6.2": "2015-04-13T16:46:33.993Z" }, "users": {}, "dist-tags": { "latest": "0.6.2" }, "_uplinks": { "npmjs": { "etag": "W/\"d543dd73fbddd411b80839e81406edf5\"", "fetched": 1593324461296 } }, "_distfiles": { "docopt-0.4.0.tgz": { "url": "https://registry.npmjs.org/docopt/-/docopt-0.4.0.tgz", "sha": "3d2ec9240c0929146b694692f45bcbf135301905", "registry": "npmjs" }, "docopt-0.4.1.tgz": { "url": "https://registry.npmjs.org/docopt/-/docopt-0.4.1.tgz", "sha": "e9ae4d3d14f7fea3e48019235ebc5f1004d22e87", "registry": "npmjs" }, "docopt-0.6.0.tgz": { "url": "https://registry.npmjs.org/docopt/-/docopt-0.6.0.tgz", "sha": "5e39538f2474e73545e1c17347a5ff427fd1533a", "registry": "npmjs" }, "docopt-0.6.1.tgz": { "url": "https://registry.npmjs.org/docopt/-/docopt-0.6.1.tgz", "sha": "31f245631d9a20ddf7d13c1574a5dd418307fa50", "registry": "npmjs" }, "docopt-0.6.2.tgz": { "url": "https://registry.npmjs.org/docopt/-/docopt-0.6.2.tgz", "sha": "b28e9e2220da5ec49f7ea5bb24a47787405eeb11", "registry": "npmjs" } }, "_attachments": { "docopt-0.6.2.tgz": { "shasum": "b28e9e2220da5ec49f7ea5bb24a47787405eeb11" } }, "_rev": "2-9427f820f773a5fb", "_id": "docopt", "readme": "`docopt` – a command line option parser that will make you smile [![Build Status](https://travis-ci.org/stuartcarnie/docopt.coffee.svg)](https://travis-ci.org/stuartcarnie/docopt.coffee)\n===============================================================\n\n> [docopt](http://docopt.org) is a language for description of command-line\n> interfaces. This is `docopt` implementation in CoffeeScript, that could\n> be used for server-side CoffeeScript and JavaScript programs.\n\nIsn't it awesome how modern command-line arguments parsers generate\nhelp message based on your code?!\n\n**Hell no!** You know what's awesome? When the option parser *is* generated\nbased on the help message that you write yourself! This way you don't need to \nwrite this stupid repeatable parser-code, and instead can write a beautiful \nhelp message (the way you want it!), which adds readability to your code.\n\nNow you can write an awesome, readable, clean, DRY code like *this*:\n\n```coffeescript\ndoc = \"\"\"\nUsage:\n quick_example.coffee tcp [--timeout=]\n quick_example.coffee serial [--baud=9600] [--timeout=]\n quick_example.coffee -h | --help | --version\n\n\"\"\"\n{docopt} = require '../docopt'\n\nconsole.log docopt(doc, version: '0.1.1rc')\n```\n\nHell yeah! The option parser is generated based on `doc` string above, that you\npass to the `docopt` function.\n\n\n\nAPI `{docopt} = require 'docopt'`\n---------------------------------\n\n### `options = docopt(doc, {argv: process.argv[2..], help: true, version: null, options_first: false, exit: true})`\n\n`docopt` takes 1 required argument, and 3 optional keyword arguments:\n\n* `doc` (required) should be a string with the help message, written according \nto rules of the [docopt language](http://docopt.org). Here's a quick example:\n\n ```bash\n Usage: your_program [options]\n\n -h --help Show this.\n -v --verbose Print more text.\n --quiet Print less text.\n -o FILE Specify output file [default: ./test.txt].\n ```\n\n* `argv` is an optional argument vector. It defaults to the arguments passed\nto your program (`process.argv[2..]`). You can also supply it with an array\nof strings, as with `process.argv`. For example: `['--verbose', '-o', 'hai.txt']`.\n\n* `help` (default:`true`) specifies whether the parser should automatically\nprint the help message (supplied as `doc`) in case `-h` or `--help` options\nare encountered. After showing the usage-message, the program will terminate.\nIf you want to handle `-h` or `--help` options manually (the same as other options),\nset `help=false`.\n\n* `version` (default:`null`) is an optional argument that specifies the\nversion of your program. If supplied, then, if the parser encounters\n`--version` option, it will print the supplied version and terminate.\n`version` could be any printable object, but most likely a string,\ne.g. `'2.1.0rc1'`.\n\n* `options_first`, by default `false`. If set to `true` will\ndisallow mixing options and positional argument. I.e. after first\npositional argument, all arguments will be interpreted as positional\neven if the look like options. This can be used for strict\ncompatibility with POSIX, or if you want to dispatch your arguments\nto other programs.\n\n* `exit`, by default `true`. If set to `false` will\ncause docopt to throw exceptions instead of printing the error to console and terminating the application.\nThis flag is mainly for testing purposes.\n\n**Note:** Although `docopt` automatically handles `-h`, `--help` and `--version` options,\nyou still need to mention them in the options description (`doc`) for your users to\nknow about them.\n\nThe **return** value is an `Object` with properties (giving long options precedence), \nlike this:\n\n```javascript\n{'--timeout': '10',\n '--baud': '4800',\n '--version': false,\n '--help': false,\n '-h': false,\n serial: true,\n tcp: false,\n '': false,\n '': '/dev/ttyr01'}\n```" }