# @allegiant/cmdhelper

> Simple command line argument parser library.

Latest version **0.0.1** (published 2017-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @allegiant/cmdhelper
pnpm add @allegiant/cmdhelper
yarn add @allegiant/cmdhelper
bun add @allegiant/cmdhelper
```

## 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.0.1 |
| Published | 2017-12-26 |
| First published | 2017-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | echopoint |
| Maintainers | echopoint |

## Links

- npm: https://www.npmjs.com/package/@allegiant/cmdhelper
- Repository: https://github.com/allegiant-js/cmdhelper
- Homepage: https://github.com/allegiant-js/cmdhelper#readme
- Issues: https://github.com/allegiant-js/cmdhelper/issues
- npm.io page: https://npm.io/package/@allegiant/cmdhelper

## Recent versions

- 0.0.1 (latest) — 2017-12-26

## README

# cmdhelper

Simple command line argument parser library.

	const cmdHelper = require('@allegiant/cmdhelper');
	const SETTINGS = cmdHelper.process(params => {
	    return {
	        host: params.get('host') || '0.0.0.0',
	        port: params.get('port') || 80
	    };
	});

SETTINGS will now hold the two properties, 'host' and 'port'. These are available to the command line as --host "hostname" and --port "port number" respectively.


#### Note
This is a preliminary release, api breakage may happen.


### Copyright & License

Copyright © 2017 Allegiant. Distributed under the terms of the MIT License, see [LICENSE](https://github.com/allegiant-js/cmdhelper/blob/master/LICENSE)

Availble via [npm](https://www.npmjs.com/org/allegiant/cmdhelper) or [github](https://github.com/allegiant-js/cmdhelper).

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