yargs the modern, pirate-themed successor to optimist.
JavaScript HTML
Clone or download
Latest commit 18b2fcb Jun 28, 2018
Permalink
Failed to load latest commit information.
docs feat: allow setting scriptName $0 (#1143) Jun 24, 2018
example docs: corrected version specifier in help example (#1163) Jun 24, 2018
lib fix: .argv and .parse() now invoke identical code path (#1126) May 10, 2018
locales feat: add Norwegian Nynorsk translations (#1028) Dec 31, 2017
test feat: remove `setPlaceholderKeys` (#1105) Jun 26, 2018
.editorconfig chore: add editorconfig (#848) Apr 4, 2017
.gitignore feat: introduce .positional() for configuring positional arguments (#967 Oct 12, 2017
.travis.yml chore: cache node_modules (#1159) Jun 26, 2018
CHANGELOG.md chore(release): 12.0.1 Jun 29, 2018
CODE_OF_CONDUCT.md docs: move Code of Conduct section to CODE_OF_CONDUCT.md (#1155) Jun 24, 2018
LICENSE docs(license): update license to reflect work undertaken since projec… Apr 10, 2016
README.md docs: add info about installing @next version, see #1134 (#1165) Jun 27, 2018
appveyor.yml chore: cache node_modules (#1159) Jun 26, 2018
completion.sh.hbs fix: use correct completion command in generated completion script (#988 Oct 18, 2017
contributing.md docs: move Code of Conduct section to CODE_OF_CONDUCT.md (#1155) Jun 24, 2018
index.js refactor: ES6ify (#937) Aug 17, 2017
package.json chore(release): 12.0.1 Jun 29, 2018
screen.png chore: finally splitting README.md into a few sections (#892) Jun 12, 2017
yargs-logo.png update logo with proper antialiasing (#1086) Mar 8, 2018
yargs.js feat: remove `setPlaceholderKeys` (#1105) Jun 26, 2018

README.md

Yargs

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


Build Status Coverage Status NPM version Windows Tests 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:

  • commands and (grouped) options (my-program.js serve --port=5000).
  • a dynamically generated help menu based on your arguments.
  • bash-completion shortcuts for commands and options.
  • and tons more.

Installation

Stable version:

npm i yargs --save

Bleeding edge version with the most recent features:

npm i yargs@next --save

Usage :

Simple Example

#!/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!')
}
$ ./plunder.js --ships=4 --distance=22
Plunder more riffiwobbles!

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

Complex Example

#!/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