npmpackage.info

Gathering detailed insights and metrics for yargs

Other packages similar to yargs

yargs-parser

22.0.0

the mighty option parser used by yargs

@types/yargs

17.0.33

TypeScript definitions for yargs

@types/yargs-parser

21.0.3

TypeScript definitions for yargs-parser

y18n

5.0.8

the bare-bones internationalization library used by yargs

Gathering detailed insights and metrics for yargs

yargs - 18.0.0 | npmpackage.info

yargs

yargs the modern, pirate-themed successor to optimist.

18.0.0

11,318

MIT

JavaScript

226.01 kB

6.7

Installations

npm install yargs

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

^20.19.0 || ^22.12.0 || >=23

Node Version

22.15.0

NPM Version

11.4.1 Pull Requests

Open

1

Total

1,155

Closed

266

Merged

888

Issues

Open

290

Total

1,292

Closed

1,002

Releases

v18.0.0

Updated on May 27, 2025

v17.7.2

Updated on Apr 27, 2023

v17.7.1

Updated on Feb 21, 2023

v17.7.0

Updated on Feb 16, 2023

v17.6.2

Updated on Nov 03, 2022

v17.6.1

Updated on Nov 02, 2022

View All 57 releases

Languages

JavaScript

TypeScript

HTML

JavaScript (71.05%)

TypeScript (28.71%)

HTML (0.25%)

Developer

yargs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

11,318 Stars

1,848 Commits

1,005 Forks

80 Watchers

82 Branches

283 Contributors

Updated on Jul 18, 2025

Maintainers

View All 283 Contributors

Package Meta Information

Latest Version

18.0.0

Package Id

yargs@18.0.0

Unpacked Size

226.01 kB

Size

46.75 kB

File Count

NPM Version

11.4.1

Node Version

22.15.0

Published on

May 27, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Yargs

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

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:

mocha [spec..]

Run tests with Mocha

Commands
  mocha inspect [spec..]  Run tests with Mocha                         [default]
  mocha init <path>       create a client-side Mocha setup at <path>

Rules & Behavior
  --allow-uncaught           Allow uncaught errors to propagate        [boolean]
  --async-only, -A           Require all tests to use a callback (async) or
                             return a Promise                          [boolean]

generate completion scripts for Bash and Zsh for your command
and tons more.

Installation

Stable version:

1npm i yargs

Bleeding edge version with the most recent features:

1npm i yargs@next

Usage

Simple Example

1#!/usr/bin/env node
2import yargs from 'yargs';
3import { hideBin } from 'yargs/helpers';
4const argv = yargs(hideBin(process.argv)).parse()
5
6if (argv.ships > 3 && argv.distance < 53.5) {
7  console.log('Plunder more riffiwobbles!')
8} else {
9  console.log('Retreat from the xupptumblers!')
10}

1$ ./plunder.js --ships=4 --distance=22
2Plunder more riffiwobbles!
3
4$ ./plunder.js --ships 12 --distance 98.7
5Retreat from the xupptumblers!

Note: hideBin is a shorthand for process.argv.slice(2). It has the benefit that it takes into account variations in some environments, e.g., Electron.

Complex Example

1#!/usr/bin/env node
2import yargs from 'yargs';
3import { hideBin } from 'yargs/helpers';
4
5yargs(hideBin(process.argv))
6  .command('serve [port]', 'start the server', (yargs) => {
7    return yargs
8      .positional('port', {
9        describe: 'port to bind on',
10        default: 5000
11      })
12  }, (argv) => {
13    if (argv.verbose) console.info(`start server on :${argv.port}`)
14    serve(argv.port)
15  })
16  .option('verbose', {
17    alias: 'v',
18    type: 'boolean',
19    description: 'Run with verbose logging'
20  })
21  .parse()

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

Supported Platforms

TypeScript

yargs has type definitions at @types/yargs.

npm i @types/yargs --save-dev

See usage examples in docs.

Deno

As of v16, yargs supports Deno:

1import yargs from 'https://deno.land/x/yargs@v17.7.2-deno/deno.ts'
2import { Arguments } from 'https://deno.land/x/yargs@v17.7.2-deno/deno-types.ts'
3
4yargs(Deno.args)
5  .command('download <files...>', 'download a list of files', (yargs: any) => {
6    return yargs.positional('files', {
7      describe: 'a list of files to do something with'
8    })
9  }, (argv: Arguments) => {
10    console.info(argv)
11  })
12  .strictCommands()
13  .demandCommand(1)
14  .parse()

Note: If you use version tags in url then you also have to add -deno flag on the end, like @17.7.2-deno

Usage in Browser

See examples of using yargs in the browser in docs.

Documentation

Supported Node.js Versions

Libraries in this ecosystem make a best effort to track Node.js' release schedule. Here's a post on why we think this is important.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/ci.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/release-please.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/release-please.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/release-please.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/yargs/release-please.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:60
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:61
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:23
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:25
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:44
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:45
Warn: npmCommand not pinned by hash: .github/workflows/release-please.yml:25
Warn: npmCommand not pinned by hash: .github/workflows/release-please.yml:26
Warn: npmCommand not pinned by hash: .github/workflows/release-please.yml:45
Info: 0 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 0 out of 9 npmCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

6.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to yargs

Other packages similar to yargs

yargs

Installations

Developer Guide

No

ESM

^20.19.0 || ^22.12.0 || >=23

22.15.0

11.4.1

Pull Requests

1

1,155

266

888

Issues

290

1,292

1,002

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Yargs

Description

Installation

Usage

Simple Example

Complex Example

Supported Platforms

TypeScript

Deno

Usage in Browser

Documentation

Table of Contents

Supported Node.js Versions

10

10

10

10

10

10

8

0

0

0

0

0

6.7

/10