Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodeca/argparse
CLI arguments parser for node.js. JS port of python's argparse module.
https://github.com/nodeca/argparse
Last synced: 1 day ago
JSON representation
CLI arguments parser for node.js. JS port of python's argparse module.
- Host: GitHub
- URL: https://github.com/nodeca/argparse
- Owner: nodeca
- License: other
- Created: 2012-05-14T15:30:37.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2023-11-09T18:31:05.000Z (over 1 year ago)
- Last Synced: 2025-02-06T13:50:44.402Z (9 days ago)
- Language: JavaScript
- Homepage:
- Size: 372 KB
- Stars: 493
- Watchers: 21
- Forks: 74
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs - argparse - CLI arguments parser for node.js.  (Repository / Command-line Utilities)
README
argparse
========
[](https://github.com/nodeca/argparse/actions)
[](https://www.npmjs.org/package/argparse)
CLI arguments parser for node.js, with [sub-commands](https://docs.python.org/3.9/library/argparse.html#sub-commands) support. Port of python's [argparse](http://docs.python.org/dev/library/argparse.html) (version [3.9.0](https://github.com/python/cpython/blob/v3.9.0rc1/Lib/argparse.py)).
**Difference with original.**
- JS has no keyword arguments support.
- Pass options instead: `new ArgumentParser({ description: 'example', add_help: true })`.
- JS has no python's types `int`, `float`, ...
- Use string-typed names: `.add_argument('-b', { type: 'int', help: 'help' })`.
- `%r` format specifier uses `require('util').inspect()`.
More details in [doc](./doc).
Example
-------
Following code is a JS program that takes a list of integers and produces either the sum or the max:
```js
const { ArgumentParser } = require('argparse')
const parser = new ArgumentParser({ description: 'Process some integers.' })
let sum = ints => ints.reduce((a, b) => a + b)
let max = ints => ints.reduce((a, b) => a > b ? a : b)
parser.add_argument('integers', { metavar: 'N', type: 'int', nargs: '+',
help: 'an integer for the accumulator' })
parser.add_argument('--sum', { dest: 'accumulate', action: 'store_const',
const: sum, default: max,
help: 'sum the integers (default: find the max)' });
let args = parser.parse_args()
console.log(args.accumulate(args.integers))
```
Assuming the JS code above is saved into a file called prog.js, it can be run at the command line and provides useful help messages:
```
$ node prog.js -h
usage: prog.js [-h] [--sum] N [N ...]
Process some integers.
positional arguments:
N an integer for the accumulator
optional arguments:
-h, --help show this help message and exit
--sum sum the integers (default: find the max)
```
When run with the appropriate arguments, it prints either the sum or the max of the command-line integers:
```
$ node prog.js 1 2 3 4
4
$ node prog.js 1 2 3 4 --sum
10
```
If invalid arguments are passed in, it will issue an error:
```
$ node prog.js a b c
usage: prog.js [-h] [--sum] N [N ...]
prog.js: error: argument N: invalid 'int' value: 'a'
```
This is an example ported from Python. You can find detailed explanation [here](https://docs.python.org/3.9/library/argparse.html).
API docs
--------
Since this is a port with minimal divergence, there's no separate documentation.
Use original one instead, with notes about difference.
1. [Original doc](https://docs.python.org/3.9/library/argparse.html).
2. [Original tutorial](https://docs.python.org/3.9/howto/argparse.html).
3. [Difference with python](./doc).
argparse for enterprise
-----------------------
Available as part of the Tidelift Subscription
The maintainers of argparse and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-argparse?utm_source=npm-argparse&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)