Basemark is a CLI benchmarking tool designed for use in Continuous Integration (CI) environments. It allows you to measure performance metrics over multiple iterations and verify them against predefined acceptance criteria.
- Iteration-based Testing: Run a specific number of iterations to assess performance consistency.
- Acceptance Criteria: Validate performance against a target acceptance time.
- Variance Threshold: Define acceptable variance levels for performance results.
Download the prebuilt binary for your platform or install using Go:
go install github.com/shabinesh/basemark@latestbasemark [global options] command [command options]| Option | Alias | Description | Default |
|---|---|---|---|
--iterations value |
-n |
Number of iterations to run | 0 |
--acceptance-time value |
-t |
Acceptance time in milliseconds | 0 |
--variance value |
-v |
Acceptable variance from acceptance time (%) | 0 |
--help |
-h |
Show help |
| Command | Alias | Description |
|---|---|---|
help |
h |
Shows a list of commands or help for one command |
Run a benchmark with 10 iterations, an acceptance time of 500ms, and a 5% variance threshold:
basemark -n 10 -t 500 -v 5 sleep 2The tool will provide results for each iteration and highlight any deviations from the defined thresholds.
Contributions are welcome! Feel free to open issues or submit pull requests to improve the tool.
This project is licensed under the MIT License.
Feel free to adapt the sections to match the exact functionality of your CLI tool or its specific repository details.