# argler

> Parses a raw command line into arguments

Latest version **1.0.1** (published 2015-10-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install argler
pnpm add argler
yarn add argler
bun add argler
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-10-06 |
| First published | 2015-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lukas Pokorny |
| Maintainers | lukaaash |
| Keywords | command line, arguments, parser |

## Links

- npm: https://www.npmjs.com/package/argler
- Repository: https://github.com/lukaaash/argler
- Homepage: https://github.com/lukaaash/argler#readme
- Issues: https://github.com/lukaaash/argler/issues
- npm.io page: https://npm.io/package/argler

## 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

- 1.0.1 (latest) — 2015-10-06
- 1.0.0 — 2015-08-30

## README

argler
======

Argler is a simple module that parses a whole command line string into individual arguments
that can be passed to modules (such as [minimist](https://www.npmjs.com/package/minimist)) that expect `process.argv`-like argument array on input.

## Examples

```javascript
var argler = require('argler');

// 'one two three' -> [ 'one', 'two', 'three' ]
var args = argler('one two three');
console.dir(args);

// say -n 7 "this is a single argument"' -> [ 'say', '-n', '7', 'this is a single argument' ]
var args = argler('say -n 7 "this is a single argument"');
console.dir(args);

// 'say Hello\\ world!' -> [ 'say', 'Hello world!' ]
var args = argler('say Hello\\ world!');
console.dir(args);
```

## Examples with minimist

```javascript
var argler = require('argler');
var minimist = require('minimist');

// with minimist, you can do this:
var args = minimist(argler('get --retries 3 "document 1.txt"'));
console.dir(args);

// you might want to force all arguments (but not options) to be strings:
var args = minimist(argler('echo 1 2 3 4'), { string: ['_'] });
console.dir(args);

// parsing a command line into a command, arguments and options:
var args = argler('open sftp.nuane.com -P 22');
var cmd = args.shift();
var options = minimist(args, { string: ['_'] });
args = options._;
delete options._;
console.log(cmd);
console.dir(args);
console.dir(options);
```

## Installing

```shell
$ npm install argler
```

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