# m-cli-builder

> Easy to use cli builder by MiftikCZ.

Latest version **1.0.0** (published 2021-11-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install m-cli-builder
pnpm add m-cli-builder
yarn add m-cli-builder
bun add m-cli-builder
```

## 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.0 |
| Published | 2021-11-20 |
| First published | 2021-11-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | miftikcz |
| Keywords | cli, miftikcz, builder |

## Links

- npm: https://www.npmjs.com/package/m-cli-builder
- npm.io page: https://npm.io/package/m-cli-builder

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

- 1.0.0 (latest) — 2021-11-20

## README

# Install
```bash
npm i m-cli-builder
```

# Usage
```js
const mclib = require("m-cli-builder")(
    "Default message title",
    "Default message description",
    "--" // prefix
);

mclib.add("
    command", // command's name
    "description", // command's description
    false // required?
);

// check if user used "test" argument (--test)
if(mclib.args["test"]) {
    console.log("You used --test !");
}

// see more details about the arguments
console.log(mclib.args);

mclib.check(); // check if user used all required arguments
```


U can use `--command=<detail> <more details>`
for example: `--send=true Hello from mclib! --type=message`

```json
{
    "send": {
        "text": "Hello from mclib!",
        "description": "true",
        "name": "--send"
    },
    "type": {
        "text": "",
        "description": "message",
        "name": "--type"
    },
}

```

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