\n Yargs be a node.js library fer hearties tryin' ter parse optstrings\n
\n\n \n\n\n[![NPM version][npm-image]][npm-url]\n[![js-standard-style][standard-image]][standard-url]\n[![Coverage][coverage-image]][coverage-url]\n[![Conventional Commits][conventional-commits-image]][conventional-commits-url]\n[![Slack][slack-image]][slack-url]\n\n## Description\nYargs helps you build interactive command line tools, by parsing arguments and generating an elegant user interface.\n\nIt gives you:\n\n* commands and (grouped) options (`my-program.js serve --port=5000`).\n* a dynamically generated help menu based on your arguments:\n\n```\nmocha [spec..]\n\nRun tests with Mocha\n\nCommands\n mocha inspect [spec..] Run tests with Mocha [default]\n mocha init create a client-side Mocha setup at \n\nRules & Behavior\n --allow-uncaught Allow uncaught errors to propagate [boolean]\n --async-only, -A Require all tests to use a callback (async) or\n return a Promise [boolean]\n```\n\n* bash-completion shortcuts for commands and options.\n* and [tons more](/docs/api.md).\n\n## Installation\n\nStable version:\n```bash\nnpm i yargs\n```\n\nBleeding edge version with the most recent features:\n```bash\nnpm i yargs@next\n```\n\n## Usage\n\n### Simple Example\n\n```javascript\n#!/usr/bin/env node\nconst yargs = require('yargs/yargs')\nconst { hideBin } = require('yargs/helpers')\nconst argv = yargs(hideBin(process.argv)).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\nconst yargs = require('yargs/yargs')\nconst { hideBin } = require('yargs/helpers')\n\nyargs(hideBin(process.argv))\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 type: 'boolean',\n description: 'Run with verbose logging'\n })\n .argv\n```\n\nRun the example above with `--help` to see the help for the application.\n\n## Supported Platforms\n\n### TypeScript\n\nyargs has type definitions at [@types/yargs][type-definitions].\n\n```\nnpm i @types/yargs --save-dev\n```\n\nSee usage examples in [docs](/docs/typescript.md).\n\n### Deno\n\nAs of `v16`, `yargs` supports [Deno](https://github.com/denoland/deno):\n\n```typescript\nimport yargs from 'https://deno.land/x/yargs/deno.ts'\nimport { Arguments } from 'https://deno.land/x/yargs/deno-types.ts'\n\nyargs(Deno.args)\n .command('download ', 'download a list of files', (yargs: any) => {\n return yargs.positional('files', {\n describe: 'a list of files to do something with'\n })\n }, (argv: Arguments) => {\n console.info(argv)\n })\n .strictCommands()\n .demandCommand(1)\n .argv\n```\n\n### ESM\n\nAs of `v16`,`yargs` supports ESM imports:\n\n```js\nimport yargs from 'yargs'\nimport { hideBin } from 'yargs/helpers'\n\nyargs(hideBin(process.argv))\n .command('curl ', 'fetch the contents of the URL', () => {}, (argv) => {\n console.info(argv)\n })\n .demandCommand(1)\n .argv\n```\n\n### Usage in Browser\n\nSee examples of using yargs in the browser in [docs](/docs/browser.md).\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 * [Quotes](/docs/tricks.md#quotes)\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 * [Bundling yargs](/docs/bundling.md)\n* [Contributing](/contributing.md)\n\n## Supported Node.js Versions\n\nLibraries in this ecosystem make a best effort to track\n[Node.js' release schedule](https://nodejs.org/en/about/releases/). Here's [a\npost on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).\n\n[npm-url]: https://www.npmjs.com/package/yargs\n[npm-image]: https://img.shields.io/npm/v/yargs.svg\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[type-definitions]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs\n[coverage-image]: https://img.shields.io/nycrc/yargs/yargs\n[coverage-url]: https://github.com/yargs/yargs/blob/master/.nycrc\n",
"licenseText": "MIT License\n\nCopyright 2010 James Halliday (mail@substack.net); Modified work Copyright 2014 Contributors (ben@npmjs.com)\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"
},
"artifacts": [],
"remote": {
"resolved": "https://registry.yarnpkg.com/yargs/-/yargs-16.2.0.tgz#1c82bf0f6b6a66eafce7ef30e376f49a12477f66",
"type": "tarball",
"reference": "https://registry.yarnpkg.com/yargs/-/yargs-16.2.0.tgz",
"hash": "1c82bf0f6b6a66eafce7ef30e376f49a12477f66",
"integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==",
"registry": "npm",
"packageName": "yargs",
"cacheIntegrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw== sha1-HIK/D2tqZur85+8w43b0mhJHf2Y="
},
"registry": "npm",
"hash": "1c82bf0f6b6a66eafce7ef30e376f49a12477f66"
}
![](\"https://raw.githubusercontent.com/yargs/yargs/master/yargs-logo.png\"){kind=logo}
\n