diff options
Diffstat (limited to 'node_modules/commander/Readme.md')
| -rw-r--r-- | node_modules/commander/Readme.md | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/node_modules/commander/Readme.md b/node_modules/commander/Readme.md index 08b9e4cb9..3135a9443 100644 --- a/node_modules/commander/Readme.md +++ b/node_modules/commander/Readme.md @@ -1,18 +1,18 @@ # Commander.js -[](http://travis-ci.org/tj/commander.js) +[](http://travis-ci.org/tj/commander.js) [](https://www.npmjs.org/package/commander) [](https://www.npmjs.org/package/commander) [](https://gitter.im/tj/commander.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/tj/commander). + The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/commander-rb/commander). [API documentation](http://tj.github.com/commander.js/) ## Installation - $ npm install commander + $ npm install commander --save ## Option parsing @@ -28,7 +28,7 @@ var program = require('commander'); program - .version('0.0.1') + .version('0.1.0') .option('-p, --peppers', 'Add peppers') .option('-P, --pineapple', 'Add pineapple') .option('-b, --bbq-sauce', 'Add bbq sauce') @@ -66,7 +66,7 @@ function increaseVerbosity(v, total) { } program - .version('0.0.1') + .version('0.1.0') .usage('[options] <file ...>') .option('-i, --integer <n>', 'An integer argument', parseInt) .option('-f, --float <n>', 'A float argument', parseFloat) @@ -91,7 +91,7 @@ console.log(' args: %j', program.args); ## Regular Expression ```js program - .version('0.0.1') + .version('0.1.0') .option('-s --size <size>', 'Pizza size', /^(large|medium|small)$/i, 'medium') .option('-d --drink [drink]', 'Drink', /^(coke|pepsi|izze)$/i) .parse(process.argv); @@ -115,7 +115,7 @@ console.log(' drink: %j', program.drink); var program = require('commander'); program - .version('0.0.1') + .version('0.1.0') .command('rmdir <dir> [otherDirs...]') .action(function (dir, otherDirs) { console.log('rmdir %s', dir); @@ -137,10 +137,10 @@ program.parse(process.argv); ```js #!/usr/bin/env node -var program = require('../'); +var program = require('commander'); program - .version('0.0.1') + .version('0.1.0') .arguments('<cmd> [env]') .action(function (cmd, env) { cmdValue = cmd; @@ -156,15 +156,16 @@ if (typeof cmdValue === 'undefined') { console.log('command:', cmdValue); console.log('environment:', envValue || "no environment given"); ``` +Angled brackets (e.g. `<cmd>`) indicate required input. Square brackets (e.g. `[env]`) indicate optional input. ## Git-style sub-commands ```js // file: ./examples/pm -var program = require('..'); +var program = require('commander'); program - .version('0.0.1') + .version('0.1.0') .command('install [name]', 'install one or more packages') .command('search [query]', 'search with optional query') .command('list', 'list packages installed', {isDefault: true}) @@ -226,7 +227,7 @@ You can enable `--harmony` option in two ways: var program = require('commander'); program - .version('0.0.1') + .version('0.1.0') .option('-f, --foo', 'enable some foo') .option('-b, --bar', 'enable some bar') .option('-B, --baz', 'enable some baz'); @@ -280,7 +281,7 @@ var program = require('commander'); var colors = require('colors'); program - .version('0.0.1') + .version('0.1.0') .command('getstream [url]', 'get stream URL') .parse(process.argv); @@ -304,10 +305,10 @@ function make_red(txt) { var program = require('commander'); program - .version('0.0.1') + .version('0.1.0') .option('-C, --chdir <path>', 'change the working directory') .option('-c, --config <path>', 'set config path. defaults to ./deploy.conf') - .option('-T, --no-tests', 'ignore test hook') + .option('-T, --no-tests', 'ignore test hook'); program .command('setup [env]') @@ -348,4 +349,3 @@ More Demos can be found in the [examples](https://github.com/tj/commander.js/tre ## License MIT - |