# mntr-cli

> A stress test CLI tool for Minter blockhain

Latest version **1.3.0** (published 2019-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install mntr-cli
pnpm add mntr-cli
yarn add mntr-cli
bun add mntr-cli
```

Provides the command `mntr-cli`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2019-11-13 |
| First published | 2019-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.5.0 |
| Dependencies | 15 |
| Unpacked size | 40.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | German Ivanov |
| Maintainers | tasyp |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/mntr-cli
- Repository: https://github.com/tasyp/mntr-cli
- Issues: https://github.com/tasyp/mntr-cli/issues
- npm.io page: https://npm.io/package/mntr-cli

## Dependencies (15)

- [rxjs](https://npm.io/package/rxjs.md) ^6.5.3
- [tslib](https://npm.io/package/tslib.md) ^1
- [cli-ux](https://npm.io/package/cli-ux.md) ^5.3.2
- [p-limit](https://npm.io/package/p-limit.md) ^2.2.1
- [winston](https://npm.io/package/winston.md) ^3.2.1
- [dot-prop](https://npm.io/package/dot-prop.md) ^5.1.0
- [p-throttle](https://npm.io/package/p-throttle.md) ^3.1.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1
- [@oclif/errors](https://npm.io/package/@oclif/errors.md) ^1.2.2
- [minter-js-sdk](https://npm.io/package/minter-js-sdk.md) ^0.21.0
- [minterjs-util](https://npm.io/package/minterjs-util.md) ^0.13.0
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1
- [simple-backoff](https://npm.io/package/simple-backoff.md) ^1.1.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^2
- [node-worker-threads-pool](https://npm.io/package/node-worker-threads-pool.md) ^1.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

- 1.3.0 (latest) — 2019-11-13
- 1.2.1 — 2019-11-10
- 1.2.0 — 2019-10-27
- 1.1.0 — 2019-10-22
- 1.0.26 — 2019-10-18
- 1.0.25 — 2019-10-18
- 1.0.24 — 2019-10-18
- 1.0.23 — 2019-10-18
- 1.0.22 — 2019-10-18
- 1.0.21 — 2019-10-18

## README

mntr-cli
====

> A stress test CLI for Minter Blockhain

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/mntr-cli.svg)](https://npmjs.org/package/mntr-cli)
[![Downloads/week](https://img.shields.io/npm/dw/mntr-cli.svg)](https://npmjs.org/package/mntr-cli)
[![License](https://img.shields.io/npm/l/mntr-cli.svg)](https://github.com/tasyp/mntr-cli/blob/master/package.json)

A simple but very powerful tool to test any node for reliability.

Features:

- Response stats
- Shows failed responses by status code
- In-depth logging, if `MNTR_DEBUG=*` env variable is set

## Usage

We recommend to run this at first:
```
$ ulimit -n 2048
```

To use production version:
```
$ yarn global add mntr-cli
$ npx mntr-cli -p PRIVATE_KEY -n https://gungnir.stakeholder.space --rate 100 --duration 10 -s Mxbc04b1c077df678355c6c7c924d0f59ce66acf4f
```
To use dev version:
```
$ git clone https://github.com/tasyp/mntr-cli
$ cd mntr-cli/
$ ./bin/run -p PRIVATE_KEY -n https://gungnir.stakeholder.space --rate 100 --duration 10 -s Mxbc04b1c077df678355c6c7c924d0f59ce66acf4f
```

## Command Params

Available CLI arguments

* `--help / -h` - Gives you a manual with description of all available params 
* `--privateKey / -p` _[string]_  - Wallet private key which will be used to send transactions.
* `--node / -n` _[string]_ - A node URI to connect to.
* `--send_to / -s` _[string]_ - The address of test transactions retriever
* `--rate / -r` _[integer=2000]_ - The amount of requests per second.
* `--duration / -d` _[integer=60]_ - The duration of test in seconds
* `--coin / -c` _[string='MNT']_ - A coin to use for transactions
* `--amount / -a` _[float='0.01']_ - The amount of coins used for a test transactions
* `--maxSockets / -m` _[integer=2048]_ - Max sockets amount
* `--chainId / -i` _[string='2']_ - Chain ID to use: 1 for mainnet and 2 for testnet
* `--headers` _[string]_ - Headers to use for requests. Format -`Key:Value`. It can be used multiple times to use many headers at once, e.g.:
```
mntr-cli --headers "X-Project-Id:project-id" --headers "X-Project-Secret:secret"
```

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