![](\"/yargs-logo.png\"){kind=logo}
\n\n \n
\n Yargs be a node.js library fer hearties tryin' ter parse optstrings\n
\n![](\"/screen.png\")
\n\n* bash-completion shortcuts for commands and options.\n* and [tons more](/docs/api.md).\n\n## Installation\n\n```bash\nnpm i yargs --save\n```\n\n## Usage :\n\n### Simple Example\n\n````javascript\n#!/usr/bin/env node\nconst argv = require('yargs').argv\n\nif (argv.ships > 3 && argv.distance < 53.5) {\n console.log('Plunder more riffiwobbles!')\n} else {\n console.log('Retreat from the xupptumblers!')\n}\n````\n\n```bash\n$ ./plunder.js --ships=4 --distance=22\nPlunder more riffiwobbles!\n\n$ ./plunder.js --ships 12 --distance 98.7\nRetreat from the xupptumblers!\n```\n\n### Complex Example\n\n```javascript\n#!/usr/bin/env node\nrequire('yargs') // eslint-disable-line\n .command('serve [port]', 'start the server', (yargs) => {\n yargs\n .positional('port', {\n describe: 'port to bind on',\n default: 5000\n })\n }, (argv) => {\n if (argv.verbose) console.info(`start server on :${argv.port}`)\n serve(argv.port)\n })\n .option('verbose', {\n alias: 'v',\n default: false\n })\n .argv\n```\n\nRun the example above with `--help` to see the help for the application.\n\n## Community :\n\nHaving problems? want to contribute? join our [community slack](http://devtoolscommunity.herokuapp.com).\n\n## Documentation :\n\n### Table of Contents\n\n* [Yargs' API](/docs/api.md)\n* [Examples](/docs/examples.md)\n* [Parsing Tricks](/docs/tricks.md)\n * [Stop the Parser](/docs/tricks.md#stop)\n * [Negating Boolean Arguments](/docs/tricks.md#negate)\n * [Numbers](/docs/tricks.md#numbers)\n * [Arrays](/docs/tricks.md#arrays)\n * [Objects](/docs/tricks.md#objects)\n* [Advanced Topics](/docs/advanced.md)\n * [Composing Your App Using Commands](/docs/advanced.md#commands)\n * [Building Configurable CLI Apps](/docs/advanced.md#configuration)\n * [Customizing Yargs' Parser](/docs/advanced.md#customizing)\n* [Contributing](/contributing.md)\n\n[travis-url]: https://travis-ci.org/yargs/yargs\n[travis-image]: https://img.shields.io/travis/yargs/yargs/master.svg\n[coveralls-url]: https://coveralls.io/github/yargs/yargs\n[coveralls-image]: https://img.shields.io/coveralls/yargs/yargs.svg\n[npm-url]: https://www.npmjs.com/package/yargs\n[npm-image]: https://img.shields.io/npm/v/yargs.svg\n[windows-url]: https://ci.appveyor.com/project/bcoe/yargs-ljwvf\n[windows-image]: https://img.shields.io/appveyor/ci/bcoe/yargs-ljwvf/master.svg?label=Windows%20Tests\n[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n[standard-url]: http://standardjs.com/\n[conventional-commits-image]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg\n[conventional-commits-url]: https://conventionalcommits.org/\n[slack-image]: http://devtoolscommunity.herokuapp.com/badge.svg\n[slack-url]: http://devtoolscommunity.herokuapp.com\n","readmeFilename":"README.md"}