Skip to content
yargs the modern, pirate-themed successor to optimist.
Branch: master
Clone or download
Latest commit e7f2937 Mar 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs feat: zsh auto completion (#1292) Feb 14, 2019
example docs: corrected version specifier in help example (#1163) Jun 24, 2018
lib fix: support options/sub-commands in zsh completion Feb 18, 2019
locales fix: improve Norwegian Nynorsk translations (#1207) Oct 6, 2018
test test: correct test description Mar 6, 2019
.editorconfig
.gitignore fix: translation not working when using __ with a single parameter (#… Aug 11, 2018
.travis.yml
CHANGELOG.md
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: remove --save option as it isn't required anymore (#1301) Feb 19, 2019
completion.sh.hbs fix: better bash path completion (#1272) Jan 28, 2019
completion.zsh.hbs fix: support options/sub-commands in zsh completion Feb 18, 2019
contributing.md docs: fix sublist indentation (#1238) Nov 5, 2018
index.js refactor: ES6ify (#937) Aug 17, 2017
package.json chore(release): 13.2.2 Mar 6, 2019
screen.png
yargs-logo.png update logo with proper antialiasing (#1086) Mar 8, 2018
yargs.js chore: update deps (#1296) Feb 15, 2019

README.md

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:

  • 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

Bleeding edge version with the most recent features:

npm i yargs@next

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

You can’t perform that action at this time.