Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including yargs with all npm packages installed. Try it out:

var yargs = require("yargs")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

yargs v15.4.1

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


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

Build Status NPM version js-standard-style Coverage 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.


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')

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) => {
      .positional('port', {
        describe: 'port to bind on',
        default: 5000
  }, (argv) => {
    if (argv.verbose)`start server on :${argv.port}`)
  .option('verbose', {
    alias: 'v',
    type: 'boolean',
    description: 'Run with verbose logging'

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


yargs has type definitions at @types/yargs.

npm i @types/yargs --save-dev

See usage examples in docs.


See usage examples of yargs with webpack in docs.

Community :

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

Documentation :

Table of Contents


RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free