npmpackage.info

Gathering detailed insights and metrics for command-line-args

Other packages similar to command-line-args

@types/command-line-args

5.2.3

TypeScript definitions for command-line-args

commander

13.1.0

the complete solution for node.js command-line programs

has-flag

5.0.1

Check if argv has a specific flag

ts-command-line-args

2.5.1

A Typescript wrapper around command-line-args with additional support for markdown usage guide generation

Gathering detailed insights and metrics for command-line-args

command-line-args

A mature, feature-complete library to parse command-line options.

6.0.1

701

MIT

JavaScript

5.26 kB

354,946,744 4.7

Installations

npm install command-line-args

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=12.20

Node Version

23.1.0

NPM Version

10.9.0 Score

66.5

Supply Chain

93.2

Quality

75.9

Maintenance

100

Vulnerability

97.3

License

Pull Requests

Open

1

Total

27

Closed

10

Merged

16

Issues

Open

7

Total

109

Closed

102

Releases

v6.0.0

Updated on Jul 05, 2024

v5.2.0

Updated on Jul 29, 2021

v5.1.0

Updated on Mar 24, 2019

v5.0.0

Updated on Jan 17, 2018

v4.0.0

Updated on Jan 31, 2017

v3.0.0

Updated on May 29, 2016

View All 8 releases

Contributors

Unable to fetch Contributors

View All 11 Contributors

Languages

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

75lb

Download Statistics

Total Downloads

354,946,744

Last Day

106,103

Last Week

2,482,834

Last Month

9,833,364

Last Year

104,046,879

GitHub Statistics

MIT License

701 Stars

431 Commits

105 Forks

6 Watchers

3 Branches

11 Contributors

Updated on Dec 15, 2024

Bundle Size

14.22 kB

Minified

5.26 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

6.0.1

Package Id

command-line-args@6.0.1

Unpacked Size

66.40 kB

Size

15.36 kB

File Count

NPM Version

10.9.0

Node Version

23.1.0

Published on

Oct 28, 2024

Total Downloads

Cumulative downloads

Total Downloads

354,946,744

Last Day

-10.9%

106,103

Compared to previous day

Last Week

4.4%

2,482,834

Compared to previous week

Last Month

26.8%

9,833,364

Compared to previous month

Last Year

24.1%

104,046,879

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Upgraders, please read the release notes

command-line-args

A mature, feature-complete library to parse command-line options.

Synopsis

You can set options using the main notation standards (learn more). These commands are all equivalent, setting the same values:

$ example --verbose --timeout=1000 --src one.js --src two.js
$ example --verbose --timeout 1000 --src one.js two.js
$ example -vt 1000 --src one.js two.js
$ example -vt 1000 one.js two.js

To access the values, first create a list of option definitions describing the options your application accepts. The type property is a setter function (the value supplied is passed through this), giving you full control over the value received.

1const optionDefinitions = [
2  { name: 'verbose', alias: 'v', type: Boolean },
3  { name: 'src', type: String, multiple: true, defaultOption: true },
4  { name: 'timeout', alias: 't', type: Number }
5]

Next, parse the options using commandLineArgs():

1import commandLineArgs from 'command-line-args'
2const options = commandLineArgs(optionDefinitions)

options now looks like this:

1{
2  src: [
3    'one.js',
4    'two.js'
5  ],
6  verbose: true,
7  timeout: 1000
8}

Advanced usage

Beside the above typical usage, you can configure command-line-args to accept more advanced syntax forms.

Command-based syntax (git style) in the form:

$ executable <command> [options]

For example.

$ git commit --squash -m "This is my commit message"

Command and sub-command syntax (docker style) in the form:

$ executable <command> [options] <sub-command> [options]

For example.

$ docker run --detached --image centos bash -c yum install -y httpd

Usage guide generation

A usage guide (typically printed when --help is set) can be generated using command-line-usage. See the examples below and read the documentation for instructions how to create them.

A typical usage guide example.

usage

The polymer-cli usage guide is a good real-life example.

usage

Install

1$ npm install command-line-args --save

Documented by jsdoc-to-markdown.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

Token-Permissions

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

3

Maintained

Determines if the project is "actively maintained".

1

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.

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

4.7

/10

Last Scanned on 2025-02-10

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 command-line-args

Other packages similar to command-line-args

command-line-args

Installations

Developer Guide

No

ESM

>=12.20

23.1.0

10.9.0

Score

Pull Requests

1

27

10

16

Issues

7

109

102

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

75lb

Download Statistics

GitHub Statistics

Bundle Size

14.22 kB

5.26 kB

Maintainers

Package Meta Information

Total Downloads

354,946,744

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

command-line-args

Synopsis

Advanced usage

Usage guide generation

Further Reading

Install

10

10

10

10

9

3

1

0

0

0

0

0

0

4.7

/10