# base-argv

> Plugin that post-processes the object returned from [yargs-parser] so that values can be passed over to base-cli

Latest version **0.5.0** (published 2016-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install base-argv
pnpm add base-argv
yarn add base-argv
bun add base-argv
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2016-05-24 |
| First published | 2015-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 9 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Jon Schlinkert |
| Maintainers | doowb, jonschlinkert |
| Keywords | arguments, argv, base, base-methods, baseplugin, cli, command, command-line, line, methods, plugin, terminal |

## Links

- npm: https://www.npmjs.com/package/base-argv
- Repository: https://github.com/node-base/base-argv
- Issues: https://github.com/node-base/base-argv/issues
- npm.io page: https://npm.io/package/base-argv

## Dependencies (9)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [arr-diff](https://npm.io/package/arr-diff.md) ^3.0.0
- [arr-union](https://npm.io/package/arr-union.md) ^3.1.0
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.1
- [expand-args](https://npm.io/package/expand-args.md) ^0.4.2
- [is-registered](https://npm.io/package/is-registered.md) ^0.1.4
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
- [define-property](https://npm.io/package/define-property.md) ^0.2.5
- [is-valid-instance](https://npm.io/package/is-valid-instance.md) ^0.1.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.5.0 (latest) — 2016-05-24
- 0.4.5 — 2016-04-17
- 0.4.4 — 2016-04-14
- 0.4.2 — 2016-02-04
- 0.4.1 — 2016-02-04
- 0.4.0 — 2016-01-29
- 0.3.0 — 2015-12-04
- 0.2.0 — 2015-12-03
- 0.1.6 — 2015-12-01
- 0.1.5 — 2015-12-01
- 0.1.4 — 2015-11-30
- 0.1.3 — 2015-11-29
- 0.1.2 — 2015-11-29
- 0.1.1 — 2015-11-24
- 0.1.0 — 2015-11-24

## README

# base-argv [![NPM version](https://img.shields.io/npm/v/base-argv.svg?style=flat)](https://www.npmjs.com/package/base-argv) [![NPM downloads](https://img.shields.io/npm/dm/base-argv.svg?style=flat)](https://npmjs.org/package/base-argv) [![Build Status](https://img.shields.io/travis/node-base/base-argv.svg?style=flat)](https://travis-ci.org/node-base/base-argv)

Plugin that post-processes the object returned from [yargs-parser](https://github.com/yargs/yargs-parser) so that values can be passed over to base-cli

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install base-argv --save
```

## Usage

Use as a plugin with [base](https://github.com/node-base/base).

```js
var Base = require('base');
var argv = require('base-argv');

var app = new Base();
app.use(argv());

// parse argv
var args = app.argv(['foo', 'bar', '--set=a:b']);
console.log(args);
```

Results in:

```js
{ set: { a: 'b' }, tasks: [ 'foo', 'bar' ] }
```

This object can then be passed to something else for further processing.

## Related projects

You might also be interested in these projects:

* [base-cli](https://www.npmjs.com/package/base-cli): Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… [more](https://www.npmjs.com/package/base-cli) | [homepage](https://github.com/node-base/base-cli)
* [base-config](https://www.npmjs.com/package/base-config): base-methods plugin that adds a `config` method for mapping declarative configuration values to other 'base'… [more](https://www.npmjs.com/package/base-config) | [homepage](https://github.com/node-base/base-config)
* [base-option](https://www.npmjs.com/package/base-option): Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme… [more](https://www.npmjs.com/package/base-option) | [homepage](https://github.com/node-base/base-option)
* [base-plugins](https://www.npmjs.com/package/base-plugins): Upgrade's plugin support in base applications to allow plugins to be called any time after… [more](https://www.npmjs.com/package/base-plugins) | [homepage](https://github.com/node-base/base-plugins)
* [base](https://www.npmjs.com/package/base): base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://www.npmjs.com/package/base) | [homepage](https://github.com/node-base/base)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/node-base/base-argv/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/node-base/base-argv/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 24, 2016._

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