# arg-parser

> node cli arguments parser

Latest version **2.0.1** (published 2022-09-19) · 0 weekly downloads

## Install

```sh
npm install arg-parser
pnpm add arg-parser
yarn add arg-parser
bun add arg-parser
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-09-19 |
| First published | 2013-09-12 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 0 |
| Unpacked size | 43.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Tom |
| Maintainers | tborychowski |
| Keywords | args, parser |

## Links

- npm: https://www.npmjs.com/package/arg-parser
- Repository: https://github.com/tborychowski/node-arg-parser
- Homepage: https://github.com/tborychowski/node-arg-parser#readme
- Issues: https://github.com/tborychowski/node-arg-parser/issues
- npm.io page: https://npm.io/package/arg-parser

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2022-09-19
- 2.0.0 — 2022-09-19
- 1.2.0 — 2016-01-20
- 1.1.1 — 2015-04-24
- 1.1.0 — 2014-06-10
- 1.0.1 — 2013-09-12

## README

node-arg-parser
===============

node cli arguments parser



## Install

```sh
npm install arg-parser
```

## Example

**test.js**

```js

import Args from 'arg-parser';
const args = new Args(
    'ArgParserTester',
    '1.0',
    'NodeJS arg-parser module tester',
    'In addition to these parameters - more info here...'
);

args.add({ name: 'input', desc: 'input file', switches: [ '-i', '--input-file'], value: 'file' });
args.add({ name: 'output', desc: 'output file', switches: [ '-o', '--output-file'], value: 'file' });
args.add({ name: 'quiet', desc: 'quiet mode', switches: [ '-q', '--quiet'] });
args.add({ name: 'verbose', desc: 'verbose mode', switches: [ '-V', '--verbose'] });
args.add({ name: 'text', desc: 'text to store', required: true });

if (args.parse()) console.log(args.params);
```

**Run test.js**

```sh
node test.js -h
```

**Output**

```
NodeJS arg-parser module tester
usage: test [options] <text>

    <text>                   text to store

    -V, --verbose            verbose mode
    -h, --help               display help & usage
    -i, --input-file=FILE    input file
    -o, --output-file=FILE   output file
    -q, --quiet              quiet mode
    -v, --version            display cli name & version

    In addition to these parameters - more info here...

```

---
_Source: https://npm.io/package/arg-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._