CLI

A CLI is included in wrktoolbox, with built-in help. The CLI can be used to start benchmarks and generate reports using configuration files. Configuration files can be loaded from file system (default), or from an URL.

wrktoolbox --help
Usage: wrktoolbox [OPTIONS] COMMAND [ARGS]...

  wrktoolbox is a tool to run HTTP benchmarks with wrk and wrk2 tools, store
  their output, and generate reports.

  For examples and more information, refer to the project in GitHub:
  https://github.com/RobertoPrevato/wrktoolbox

Options:
  --verbose  Whether to display debug output.
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  reports
  run

Loading settings

Settings can be fetched from an URL or from file system.

wrktoolbox run --settings settings.yaml

wrktoolbox run --settings https://example-source/settings.yaml

Display help for commands

wrktoolbox reports --help

>>>

Usage: wrktoolbox reports [OPTIONS]

Options:
  --settings TEXT  Settings source (YAML or JSON); can be a file path or an
                   URL.  [default: reports.yaml]
  --help           Show this message and exit.