npmpackage.info

NPM was acquired by GitHub in March 2020.

yargs

yargs the modern, pirate-themed successor to optimist.

17.7.2

11,049

MIT

JavaScript

33.51 kB

19,587,421,698

6.7

Installations

npm install yargs

Score

91.1

Supply Chain Risk

99.6

Quality

77.9

Maintenance

100

Vulnerability

Pull Requests

Open

25

Total

1,131

Closed

244

Merged

862

Issues

Open

294

Total

1,271

Closed

977

Releases

v17.7.2

Published on 27 Apr 2023

v17.7.1

Published on 21 Feb 2023

v17.7.0

Published on 16 Feb 2023

v17.6.2

Published on 03 Nov 2022

v17.6.1

Published on 02 Nov 2022

v17.6.0

Published on 01 Oct 2022

View all 56 releases

Contributors

269

View all 269 contributors

Developer

yargs

Statistics

11,049 Stars

1,822 Commits

993 Forks

82 Watching

86 Branches

269 Contributors

Updated on 13 Sept 2024

Bundle Size

110.95 kB

Minified

33.51 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (70.91%)

TypeScript (28.85%)

HTML (0.25%)

Total Downloads

Cumulative downloads

Total Downloads

19,587,421,698

Last day

3.5%

18,070,545

Compared to previous day

Last week

5.7%

93,728,560

Compared to previous week

Last month

-0.4%

388,607,031

Compared to previous month

Last year

6.2%

4,522,484,202

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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]

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 yargs = require('yargs/yargs')
const { hideBin } = require('yargs/helpers')
const argv = yargs(hideBin(process.argv)).parse()

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!

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

#!/usr/bin/env node
const yargs = require('yargs/yargs')
const { hideBin } = require('yargs/helpers')

yargs(hideBin(process.argv))
  .command('serve [port]', 'start the server', (yargs) => {
    return 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',
    type: 'boolean',
    description: 'Run with verbose logging'
  })
  .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:

import yargs from 'https://deno.land/x/yargs/deno.ts'
import { Arguments } from 'https://deno.land/x/yargs/deno-types.ts'

yargs(Deno.args)
  .command('download <files...>', 'download a list of files', (yargs: any) => {
    return yargs.positional('files', {
      describe: 'a list of files to do something with'
    })
  }, (argv: Arguments) => {
    console.info(argv)
  })
  .strictCommands()
  .demandCommand(1)
  .parse()

ESM

As of v16,yargs supports ESM imports:

import yargs from 'yargs'
import { hideBin } from 'yargs/helpers'

yargs(hideBin(process.argv))
  .command('curl <url>', 'fetch the contents of the URL', () => {}, (argv) => {
    console.info(argv)
  })
  .demandCommand(1)
  .parse()

Usage in Browser

See examples of using yargs in the browser in docs.

Community

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

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.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

10

Dangerous-Workflow

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

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.

8

Code-Review

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

0

CII-Best-Practices

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

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:69: 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:70: 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: 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:42: 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:43: 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:53: 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:54: 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:60: 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:23
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:25
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:47
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:49
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:58
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:59
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:74
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:75
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 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 0 out of 11 npmCommand dependencies pinned

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 2024-09-02

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

yargs-parser

21.1.1

the mighty option parser used by yargs

y18n

5.0.8

the bare-bones internationalization library used by yargs

@types/yargs-parser

21.0.3

TypeScript definitions for yargs-parser

@types/yargs

17.0.33

TypeScript definitions for yargs

yargs

Installations

Score

Pull Requests

25

1,131

244

862

Issues

294

1,271

977

Releases

Contributors

Developer

Statistics

Bundle Size

110.95 kB

33.51 kB

Languages

Total Downloads

19,587,421,698

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Yargs

Description

Installation

Usage

Simple Example

Complex Example

Supported Platforms

TypeScript

Deno

ESM

Usage in Browser

Community

Documentation

Table of Contents

Supported Node.js Versions

10

10

10

10

10

10

8

0

0

0

0

0

6.7

/10

Other packages similar to yargs

Weekly Downloads

Monthly Downloads

Yearly Downloads