@apitrakr/cli v0.1.6

@apitrakr/cli

APITrakr is an API testing tool which makes testing your API endpoint extremely easy. This CLI (Command Line Interface) allows to run your API tests from your terminal or CI/CD pipeline with ease.

Getting started

To start using APITrakr, just install the NPM package and start using it!

Install from NPM

npm i @apitrakr/cli

Run the CLI

npx @apitrakr/cli -u "https://api.github.com/octocat" -n 10 -m GET -x parallel -s chart -t 2500

More options

Options:
  -V, --version                output the version number
  -u, --url <value>            The URL of the request
  -m, --method <value>         The method of the request (GET, POST, HEAD, etc..)
  -s, --visualization <value>  Shows a visualization related to the current execution run. table, chart, text
  -n, --iterations <value>     The number of iterations
  -p, --payload <value>        The payload file path
  -e, --headers <value>        The headers file path
  -x, --execution <value>      The execution type (sequential or parallel)
  -t, --timeout <value>        Max timeout in ms
  -h, --help                   Show help

Output example

--------------------------------------------------------
-       APITrakr CLI - API testing tool                -
--------------------------------------------------------

   167.00┤ ╭╮
   162.80┤ ││
   158.60┤ ││
   154.40┤ ││
   150.20┤ ││                    ╭╮   ╭
   146.00┤ ││                  ╭╮││  ╭╯
   141.80┤ ││               ╭─╮│││╰──╯
   137.60┤ │╰╮        ╭─╮  ╭╯ ╰╯╰╯
   133.40┤╭╯ │ ╭╮╭╮   │ ╰╮ │
   129.20┼╯  │╭╯╰╯╰╮ ╭╯  │ │
   125.00┤   ╰╯    ╰─╯   ╰─╯


✅ 10 executions complete on:
https://api.github.com/octocat


✅ Execution stats
  ➡️  Median: 232.5 ms
  ➡️  Min: 228 ms
  ➡️  Max: 273 ms
  ➡️  StdDev: 13.24 ms