Yargs

Yargs be a node.js library fer hearties tryin' ter parse optstrings


Build Status Coverage Status NPM version js-standard-style Conventional Commits Slack

Description :

Yargs helps you build interactive command line tools, by parsing arguments and generating an elegant user interface.

It gives you:

Installation

Stable version: bash npm i yargs

Bleeding edge version with the most recent features: bash npm i yargs@next

Usage :

Simple Example

````javascript

!/usr/bin/env node

const argv = require('yargs').argv

if (argv.ships > 3 && argv.distance < 53.5) { console.log('Plunder more riffiwobbles!') } else { console.log('Retreat from the xupptumblers!') } ````

```bash $ ./plunder.js --ships=4 --distance=22 Plunder more riffiwobbles!

$ ./plunder.js --ships 12 --distance 98.7 Retreat from the xupptumblers! ```

Complex Example

```javascript

!/usr/bin/env node

require('yargs') // eslint-disable-line .command('serve [port]', 'start the server', (yargs) => { yargs .positional('port', { describe: 'port to bind on', default: 5000 }) }, (argv) => { if (argv.verbose) console.info(start server on :${argv.port}) serve(argv.port) }) .option('verbose', { alias: 'v', default: false }) .argv ```

Run the example above with --help to see the help for the application.

Community :

Having problems? want to contribute? join our community slack.

Documentation :

Table of Contents