yargs
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

yargs

yargs the modern, pirate-themed, successor to optimist.

14.0.0  •  Updated 7 months ago  •  by yargs  •  MIT License

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.

TypeScript

yargs has type definitions at @types/yargs.

npm i @types/yargs --save-dev

See usage examples in docs

Community :

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

Documentation :

Table of Contents

Popularity

Weekly Downloads
28.3M
Stars
7.1K

Maintenance

Development

Last ver 8 months ago
Created 6 years ago
Last commit 4 months ago
2 days between commits

Technology

Node version: 12.4.0
230K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

173 contributors
Benjamin E. Coe
Maintainer, 257 commits, 450 merges, 225 PRs
Works at Google
Benjamin Coe
360 commits
nexdrew
Maintainer, 43 commits, 46 merges, 51 PRs
Max Rittmüller
Maintainer, 44 commits, 26 merges, 18 PRs
Works at NewStore
Mael Le Guen
Maintainer, 11 commits, 13 merges, 19 PRs
Works at LaPoste-DSICentrale
chevtek
22 merges

Tags

argument
args
option
parser
parsing
cli
command
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.