Gathering detailed insights and metrics for command-line-args
Gathering detailed insights and metrics for command-line-args
A mature, feature-complete library to parse command-line options.
Installations
npm install command-line-argsDeveloper
75lb
Developer Guide
BETA
Module System
ESM
Min. Node Version
>=12.20
Typescript Support
No
Node Version
23.1.0
NPM Version
10.9.0
Statistics
697 Stars
431 Commits
106 Forks
6 Watching
3 Branches
11 Contributors
Updated on 27 Nov 2024
Bundle Size
14.22 kB
Minified
5.26 kB
Minified + Gzipped
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
331,074,338
Last day
-12.4%
427,278
Compared to previous day
Last week
0.7%
2,520,620
Compared to previous week
Last month
13.5%
10,247,756
Compared to previous month
Last year
20.3%
97,946,364
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
4
Peer Dependencies
1
Dev Dependencies
1
Versions
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.
The polymer-cli usage guide is a good real-life example.
Further Reading
There is plenty more to learn, please see the wiki for examples and documentation.
Install
1$ npm install command-line-args --save
© 2014-24 Lloyd Brookes <opensource@75lb.com>.
Documented by jsdoc-to-markdown.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/node.js.yml:15
- Warn: no topLevel permission defined: .github/workflows/node.js.yml:1
- Info: no jobLevel write permissions found
Reason
6 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5
Reason
Found 4/24 approved changesets -- score normalized to 1
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/75lb/command-line-args/node.js.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/75lb/command-line-args/node.js.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:34
- Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:35
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 10 are checked with a SAST tool
Score
4.8
/10
Last Scanned on 2024-11-25
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