yargs
yargs the modern, pirate-themed, successor to optimist.
Last updated 10 months ago
by oss-bot
.
MIT
·
Repository
·
Bugs
·
Original npm
·
Tarball
·
package.json
$ cnpm install yargs
SYNC missed versions from
official npm registry.
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:
npm i yargs
Bleeding edge version with the most recent features:
npm i yargs@next
Usage
Simple Example
#!/usr/bin/env node
import yargs from 'yargs';
import { hideBin } from '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:
hideBinis a shorthand forprocess.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
import yargs from 'yargs';
import { hideBin } from '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@v17.7.2-deno/deno.ts'
import { Arguments } from 'https://deno.land/x/yargs@v17.7.2-deno/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()
Note: If you use version tags in url then you also have to add
-denoflag on the end, like@17.7.2-deno
Usage in Browser
See examples of using yargs in the browser in docs.
Documentation
Table of Contents
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.
Current Tags
- 18.0.0-browser.2 ... browser (a year ago)
- 18.0.0 ... latest (10 months ago)
- 11.1.1 ... latest-11 (7 years ago)
- 13.3.2 ... latest-13 (6 years ago)
- 14.2.3 ... latest-14 (6 years ago)
- 7.1.2 ... latest-7 (5 years ago)
- 18.0.0-candidate.7 ... next (a year ago)
- 14.2.1 ... next-14 (6 years ago)
- 15.5.0-candidate.0 ... next-15 (5 years ago)
261 Versions
- 18.0.0 ... 10 months ago
- 18.0.0-candidate.7 ... a year ago
- 18.0.0-candidate.6 ... a year ago
- 18.0.0-candidate.5 ... a year ago
- 18.0.0-candidate.4 ... a year ago
- 18.0.0-candidate.3 ... a year ago
- 18.0.0-browser.2 ... a year ago
- 18.0.0-browser.1 ... a year ago
- 18.0.0-browser.0 ... a year ago
- 18.0.0-candidate.2 ... a year ago
- 18.0.0-candidate.1 ... a year ago
- 17.7.2 ... 3 years ago
- 17.7.1 ... 3 years ago
- 17.7.0 ... 3 years ago
- 17.6.2 ... 3 years ago
- 17.6.1 ... 3 years ago
- 17.6.0 ... 4 years ago
- 17.5.1 ... 4 years ago
- 17.5.0 ... 4 years ago
- 17.4.1 ... 4 years ago
- 17.4.0 ... 4 years ago
- 17.3.1 ... 4 years ago
- 17.3.0 ... 4 years ago
- 17.2.1 ... 5 years ago
- 17.2.0 ... 5 years ago
- 17.1.1 ... 5 years ago
- 17.1.1-candidate.0 ... 5 years ago
- 17.1.0 ... 5 years ago
- 17.1.0-candidate.0 ... 5 years ago
- 17.0.2-candidate.1 ... 5 years ago
- 17.0.2-candidate ... 5 years ago
- 17.0.1 ... 5 years ago
- 17.0.0 ... 5 years ago
- 17.0.0-candidate.13 ... 5 years ago
- 7.1.2 ... 5 years ago
- 17.0.0-candidate.12 ... 5 years ago
- 17.0.0-candidate.11 ... 5 years ago
- 17.0.0-candidate.10 ... 5 years ago
- 17.0.0-candidate.9 ... 5 years ago
- 17.0.0-candidate.8 ... 5 years ago
- 17.0.0-candidate.7 ... 5 years ago
- 17.0.0-candidate.6 ... 5 years ago
- 17.0.0-candidate.5 ... 5 years ago
- 17.0.0-candidate.4 ... 5 years ago
- 17.0.0-candidate.3 ... 5 years ago
- 15.5.0-candidate.0 ... 5 years ago
- 17.0.0-candidate.2 ... 5 years ago
- 17.0.0-candidate.1 ... 5 years ago
- 17.0.0-candidate.0 ... 5 years ago
- 16.2.0 ... 5 years ago
- 16.1.1 ... 5 years ago
- 16.1.0 ... 5 years ago
- 16.0.4-candidate.0 ... 6 years ago
- 16.0.3 ... 6 years ago
- 16.0.2 ... 6 years ago
- 16.0.1 ... 6 years ago
- 16.0.0 ... 6 years ago
- 16.0.0-beta.3 ... 6 years ago
- 16.0.0-beta.2 ... 6 years ago
- 16.0.0-beta.1 ... 6 years ago
- 16.0.0-beta.0 ... 6 years ago
- 16.0.0-alpha.3 ... 6 years ago
- 16.0.0-alpha.2 ... 6 years ago
- 16.0.0-alpha.1 ... 6 years ago
- 16.0.0-alpha.0 ... 6 years ago
- 15.4.1 ... 6 years ago
- 15.4.0 ... 6 years ago
- 15.4.0-beta.1 ... 6 years ago
- 7.1.1 ... 6 years ago
- 15.4.0-beta.0 ... 6 years ago
- 15.3.2-beta.0 ... 6 years ago
- 15.3.1 ... 6 years ago
- 13.3.2 ... 6 years ago
- 14.2.3 ... 6 years ago
- 15.3.1-beta.0 ... 6 years ago
- 15.3.0 ... 6 years ago
- 15.3.0-beta.1 ... 6 years ago
- 15.3.0-beta.0 ... 6 years ago
- 15.2.0 ... 6 years ago
- 15.2.0-beta.2 ... 6 years ago
- 15.2.0-beta.1 ... 6 years ago
- 15.2.0-beta.0 ... 6 years ago
- 15.1.0 ... 6 years ago
- 14.2.2 ... 6 years ago
- 15.0.2 ... 6 years ago
- 15.0.1 ... 6 years ago
- 15.0.0 ... 6 years ago
- 14.2.1 ... 6 years ago
- 11.1.1 ... 7 years ago
- 14.2.0 ... 7 years ago
- 14.1.0 ... 7 years ago
- 14.0.0 ... 7 years ago
- 13.3.0 ... 7 years ago
- 13.2.4 ... 7 years ago
- 13.2.2 ... 7 years ago
- 13.2.1 ... 7 years ago
- 13.2.0 ... 7 years ago
- 13.1.0 ... 7 years ago
- 13.0.0-candidate.0 ... 7 years ago
- 12.0.5 ... 7 years ago
- 12.0.4 ... 7 years ago
- 12.0.3-candidate.0 ... 8 years ago
- 12.0.2 ... 8 years ago
- 12.0.1 ... 8 years ago
- 12.0.0 ... 8 years ago
- 12.0.0-candidate.0 ... 8 years ago
- 11.1.0 ... 8 years ago
- 11.0.0 ... 8 years ago
- 10.1.2 ... 8 years ago
- 10.1.1 ... 8 years ago
- 10.1.0 ... 8 years ago
- 10.0.3 ... 8 years ago
- 10.0.2 ... 8 years ago
- 10.0.1 ... 8 years ago
- 10.0.0 ... 8 years ago
- 10.0.0-alpha.4 ... 8 years ago
- 10.0.0-alpha.3 ... 8 years ago
- 10.0.0-alpha.2 ... 8 years ago
- 10.0.0-alpha.1 ... 8 years ago
- 10.0.0-alpha.0 ... 8 years ago
- 9.0.1 ... 9 years ago
- 9.0.0 ... 9 years ago
- 8.0.2 ... 9 years ago
- 8.0.1 ... 9 years ago
- 8.0.0 ... 9 years ago
- 8.0.0-candidate.1 ... 9 years ago
- 8.0.0-candidate.0 ... 9 years ago
- 7.1.0 ... 9 years ago
- 7.0.2 ... 9 years ago
- 7.0.2-candidate.1 ... 9 years ago
- 7.0.1 ... 9 years ago
- 7.0.0 ... 9 years ago
- 7.0.0-alpha.3 ... 9 years ago
- 7.0.0-alpha.2 ... 9 years ago
- 7.0.0-alpha.1 ... 9 years ago
- 6.6.1-candidate.4 ... 9 years ago
- 6.6.1-candidate.3 ... 9 years ago
- 6.6.1-candidate.2 ... 9 years ago
- 6.6.1-candidate.1 ... 9 years ago
- 6.6.1-candidate.0 ... 9 years ago
- 6.6.0 ... 9 years ago
- 6.6.0-candidate.0 ... 9 years ago
- 6.5.0 ... 9 years ago
- 6.4.0 ... 9 years ago
- 6.3.0 ... 9 years ago
- 6.3.0-candidate ... 9 years ago
- 6.2.0 ... 9 years ago
- 6.2.0-candidate ... 9 years ago
- 6.1.1 ... 9 years ago
- 6.1.1-candidate ... 9 years ago
- 6.1.0-candidate ... 9 years ago
- 6.0.0 ... 10 years ago
- 6.0.0-alpha.1 ... 10 years ago
- 5.0.0 ... 10 years ago
- 5.0.0-candidate ... 10 years ago
- 4.8.1 ... 10 years ago
- 4.8.1-candidate ... 10 years ago
- 4.8.0 ... 10 years ago
- 4.8.0-candidate3 ... 10 years ago
- 4.8.0-candidate2 ... 10 years ago
- 4.8.0-candidate ... 10 years ago
- 4.7.1 ... 10 years ago
- 4.7.0 ... 10 years ago
- 4.7.0-pre ... 10 years ago
- 4.6.0 ... 10 years ago
- 4.6.0-candidate ... 10 years ago
- 4.5.0 ... 10 years ago
- 4.4.0 ... 10 years ago
- 4.3.2 ... 10 years ago
- 4.3.1 ... 10 years ago
- 4.3.0 ... 10 years ago
- 4.2.0 ... 10 years ago
- 4.1.0 ... 10 years ago
- 4.0.0 ... 10 years ago
- 4.0.0-alpha5 ... 10 years ago
- 4.0.0-alpha4 ... 10 years ago
- 4.0.0-alpha3 ... 10 years ago
- 4.0.0-alpha2 ... 10 years ago
- 4.0.0-alpha1 ... 10 years ago
- 3.32.0 ... 10 years ago
- 3.31.0 ... 10 years ago
- 3.30.0 ... 10 years ago
- 3.29.0 ... 10 years ago
- 3.28.0 ... 10 years ago
- 3.27.0 ... 11 years ago
- 3.26.0 ... 11 years ago
- 3.25.0 ... 11 years ago
- 3.24.0 ... 11 years ago
- 3.23.0 ... 11 years ago
- 3.22.2 ... 11 years ago
- 3.22.1 ... 11 years ago
- 3.22.0 ... 11 years ago
- 3.21.1 ... 11 years ago
- 3.21.0 ... 11 years ago
- 3.20.0 ... 11 years ago
- 3.19.0 ... 11 years ago
- 3.18.1 ... 11 years ago
- 3.18.0 ... 11 years ago
- 3.17.1 ... 11 years ago
- 3.16.1 ... 11 years ago
- 3.16.0 ... 11 years ago
- 3.15.0 ... 11 years ago
- 3.14.0 ... 11 years ago
- 3.13.0 ... 11 years ago
- 3.12.0 ... 11 years ago
- 3.11.0 ... 11 years ago
- 3.10.0 ... 11 years ago
- 3.9.1 ... 11 years ago
- 3.9.0 ... 11 years ago
- 3.8.0 ... 11 years ago
- 3.7.2 ... 11 years ago
- 3.7.1 ... 11 years ago
- 3.7.0 ... 11 years ago
- 3.6.0 ... 11 years ago
- 3.5.4 ... 11 years ago
- 3.5.3 ... 11 years ago
- 3.5.2 ... 11 years ago
- 3.5.1 ... 11 years ago
- 3.5.0 ... 11 years ago
- 3.4.5 ... 11 years ago
- 3.4.4 ... 11 years ago
- 3.4.0 ... 11 years ago
- 3.3.1 ... 11 years ago
- 3.2.1 ... 11 years ago
- 3.1.0 ... 11 years ago
- 3.0.4 ... 11 years ago
- 3.0.3 ... 11 years ago
- 3.0.2 ... 11 years ago
- 3.0.1 ... 11 years ago
- 3.0.0 ... 11 years ago
- 2.3.0 ... 11 years ago
- 2.1.1 ... 11 years ago
- 1.3.3 ... 11 years ago
- 1.3.2 ... 12 years ago
- 1.3.1 ... 12 years ago
- 1.3.0 ... 12 years ago
- 1.2.6 ... 12 years ago
- 1.2.5 ... 12 years ago
- 1.2.4 ... 12 years ago
- 1.2.3 ... 12 years ago
- 1.2.2 ... 12 years ago
- 1.2.1 ... 12 years ago
- 1.2.0 ... 12 years ago
- 1.1.3 ... 12 years ago
- 1.1.2 ... 12 years ago
- 1.1.1 ... 12 years ago
- 1.1.0 ... 12 years ago
- 1.0.15 ... 12 years ago
- 1.0.13 ... 12 years ago
- 1.0.12 ... 12 years ago
- 1.0.11 ... 12 years ago
- 1.0.10 ... 12 years ago
- 1.0.9 ... 12 years ago
- 1.0.8 ... 12 years ago
- 1.0.7 ... 12 years ago
- 1.0.6 ... 12 years ago
- 1.0.5 ... 12 years ago
- 1.0.4 ... 12 years ago
- 1.0.3 ... 12 years ago
- 1.0.1 ... 12 years ago
- 1.0.0 ... 12 years ago
Maintainers (2)
bcoe
Downloads
Today
0
This Week
218
This Month
316
Last Day
29
Last Week
249
Last Month
1,170
Dependencies (6)
- cliui ^9.0.1
- escalade ^3.1.1
- get-caller-file ^2.0.5
- string-width ^7.2.0
- y18n ^5.0.5
- yargs-parser ^22.0.0
Dev Dependencies (22)
- @babel/eslint-parser ^7.26.10
- @babel/preset-typescript ^7.26.0
- @types/chai ^4.2.11
- @types/mocha ^9.0.0
- @types/node ^20.0.0
- @typescript-eslint/eslint-plugin ^8.26.1
- browserslist-generator ^2.0.1
- c8 ^9.1.0
- chai ^4.2.0
- chalk ^4.0.0
- cpr ^3.0.1
- cross-env ^7.0.2
- cross-spawn ^7.0.6
- eslint ^8.57.1
- eslint-plugin-prettier ^5.1.2
- gts ^5.2.0
- hashish 0.0.4
- mocha ^10.8.2
- rimraf ^3.0.2
- typescript ^5.8.3
- which ^2.0.0
- yargs-test-extends ^1.0.1
Dependents (217)
- @angular/compiler-cli
- @antfu/eslint-config
- @ardatan/relay-compiler
- @chromaui/localtunnel
- @commitlint/cli
- @danielberndt/htmltojsx
- @electron/rebuild
- @gatsbyjs/relay-compiler
- @gerhobbelt/json5
- @google-cloud/nodejs-repo-tools
- @google/gemini-cli
- @graphql-cli/common
- @graphql-codegen/cli
- @grpc/proto-loader
- @iarna/cli
- @intlify/cli
- @kbrandwijk/swagger-to-graphql
- @lerna/cli
- @lerna/create
- @lerna/legacy-package-management
- @maxbrunsfeld/flame-graph
- @nrwl/cli
- @nrwl/workspace
- @nx/workspace
- @puppeteer/browsers
- @react-native-community/bob
- @react-native/codegen
- @rspack/cli
- @tensorflow/tfjs
- @test-graphql-cli/common
- @umijs/utils
- @vscode/test-cli
- @webpack-cli/info
- @zkochan/libnpx
- apollo-codegen
- ava
- babel-minify
- browser-sync
- browserstack-runner
- c8
- canonical
- chrome-devtools-mcp
- cid-tool
- cli-highlight
- clite
- cmake-js
- code-suggester
- colorguard
- common-bin
- concurrently
- confidence
- copyfiles
- cowsay
- cp-cli
- create-graphback
- create-nx-workspace
- create-react-class
- dagsby
- defs
- depcheck
- depcheck-es6
- derequire
- documentation
- docz
- docz-core
- doiuse
- eclint
- edgedriver
- egg-bin
- egg-init
- ejs-lint
- electron-builder
- electron-installer-debian
- electron-rebuild
- eslint-find-rules
- esprint
- export-size
- figma-developer-mcp
- file-dedupe
- flow-coverage-report
- flow-typed
- forever
- ganache-core
- gatsby-cli
- gatsby-theme-docz
- get-pkg-repo
- gitlab
- glob-all
- gltf-pipeline
- gluejs
- good
- graphback-cli
- graphql-binding
- graphql-cli
- graphql-language-service
- graphql-serve
- graphql-yoga
- gulp-cli
- handlebars
- htmltojsx
- ipfs
- ipfs-cli
- ipfs-repo-migrations
- jest-cli
- jest-repl
- jest-runtime
- json-server
- karma
- lerna
- libnpx
- lighthouse
- lightswitch
- localtunnel
- lockfile-lint
- logkitty
- loop
- loop-things
- machine-as-script
- metro
- metro-bundler
- metro-inspector-proxy
- mgeneratejs
- microbundle
- miniprogram-ci
- mocha
- mocha-webpack
- mochawesome-merge
- mochawesome-report-generator
- module
- mongodb-download
- mongodb-prebuilt
- msw
- nconf
- node-edge-tts
- node-inspector
- node-llama-cpp
- node-sass
- npx
- nsp
- nunjucks
- nx
- nyc
- oas-resolver
- obj2gltf
- optimize-js
- package-json-validator
- pandora
- pkg-add-deps
- pkg-fetch
- prettier-tslint
- prisma-binding
- protobufjs
- pruner
- publishr
- purge-icons
- purgecss
- qrcode
- react-native
- react-native-vector-icons
- react-three-fiber
- regexp-tree
- relay-compiler
- release-please
- replace
- replace-in-file
- roarr
- rollup-plugin-visualizer
- safe-publish-latest
- sass-graph
- saucelabs
- scss-bundle
- season
- semantic-release
- sharp-cli
- showdown
- signcode
- signcode-tf
- smartwrap
- solc
- ssim.js
- standard-version
- surge
- svg-to-jsx
- swagger2openapi
- tacks
- transliteration
- travis-deploy-once
- tree-sitter-cli
- ts-jest
- ts-jest-babel-7
- tty-table
- typed-css-modules
- typed-scss-modules
- typeorm
- uglify-js
- universal-dotenv
- unleash
- v8-coverage
- vega
- vega-lite
- vite-ssg
- vows
- vue-codemod
- wdio-cli
- weallbehave
- weallcontribute
- webpack
- webpack-cli
- webpack-dev-server
- webpack-validator
- whelk
- win-detect-browsers
- xhs-mp-cli
- yalc
- yargs-unparser
- ypkgfiles
- zx