https://github.com/piecioshka/makiwara

🔨 Test URL to gain HTTP response limits in time thresholds
https://github.com/piecioshka/makiwara

cli http load-testing stress-testing

Last synced: 22 days ago
JSON representation

🔨 Test URL to gain HTTP response limits in time thresholds

• Host: GitHub
• URL: https://github.com/piecioshka/makiwara
• Owner: piecioshka
• Created: 2017-12-16T10:00:27.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2026-06-09T12:02:10.000Z (29 days ago)
• Last Synced: 2026-06-09T14:05:16.760Z (29 days ago)
• Topics: cli, http, load-testing, stress-testing
• Language: JavaScript
• Homepage:
• Size: 1.06 MB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# makiwara

[![cli-available](https://badgen.net/static/cli/available/?icon=terminal)](#cli)

[![node version](https://img.shields.io/node/v/makiwara.svg)](https://www.npmjs.com/package/makiwara)

[![npm version](https://badge.fury.io/js/makiwara.svg)](https://badge.fury.io/js/makiwara)

[![downloads count](https://img.shields.io/npm/dt/makiwara.svg)](https://www.npmjs.com/package/makiwara)

[![size](https://packagephobia.com/badge?p=makiwara)](https://packagephobia.com/result?p=makiwara)

[![license](https://img.shields.io/npm/l/makiwara.svg)](https://piecioshka.mit-license.org)

[![github-ci](https://github.com/piecioshka/makiwara/actions/workflows/testing.yml/badge.svg)](https://github.com/piecioshka/makiwara/actions/workflows/testing.yml)

🔨 CLI to benchmark URL to gain HTTP requests limits

## Usage

Installation:

```bash

npm install makiwara

```

```javascript

const { benchmark } = require('makiwara');

benchmark('https://example.org', [1, 5, 10], 'sequence')

    .then((result) => {

        console.log(result);

    })

    .catch((err) => {

        console.log(err);

    });

```

## CLI

Installation:

```bash

npm install -g makiwara

```

```bash

makiwara --help

```

```text

Usage: cli [options]

Example:

    makiwara -u https://localhost:3000 -t 10 -s sequence

Options:

  -V, --version                         output the version number

  -u, --url                        Define URL to benchmark. Ex. https://example.org/

  -t, --timelimit [numbers]             Define list of time thresholds (in seconds). Ex. 10,100,1000

  -s, --strategy   Define strategy for making requests

  -h, --help                            output usage information

```

## Example

```bash

makiwara -u https://example.org -t 1,5 -s sequence

```

Result:

```text

╔════════════════════════╤════════════════════════════════╗

║ HTTP Status Code       │ Requests quantity              ║

╟────────────────────────┼────────────────────────────────╢

║ 200 OK                 │ 3                              ║

╚════════════════════════╧════════════════════════════════╝

╔════════════════════════╤════════════════════════════════╗

║ Type                   │ Sequence                       ║

╟────────────────────────┼────────────────────────────────╢

║ Effective Duration     │ 1.456 seconds                  ║

╟────────────────────────┼────────────────────────────────╢

║ Times                  │ 3                              ║

╚════════════════════════╧════════════════════════════════╝

----------------------------------------------------

╔════════════════════════╤════════════════════════════════╗

║ HTTP Status Code       │ Requests quantity              ║

╟────────────────────────┼────────────────────────────────╢

║ 200 OK                 │ 10                             ║

╚════════════════════════╧════════════════════════════════╝

╔════════════════════════╤════════════════════════════════╗

║ Type                   │ Sequence                       ║

╟────────────────────────┼────────────────────────────────╢

║ Effective Duration     │ 5.399 seconds                  ║

╟────────────────────────┼────────────────────────────────╢

║ Times                  │ 10                             ║

╚════════════════════════╧════════════════════════════════╝

```

## License

[The MIT License](https://piecioshka.mit-license.org) @ 2017