veloq: Benchmarking in your terminal!

           __         
 _  _____ / /__  ___ _
| |/ / -_) / _ \/ _ `/
|___/\__/_/\___/\_, / 
                 /_/  

Veloq is a simple benchmarking & replay tool for command line interfaces.

Warning

This project is in early stages of development and can change anytime.

Index

• veloq: Benchmarking in your terminal!
  • Index
  • Features
  • Installing
  • Usage
  • Building
  • Examples
  • Testing
  • The name
  • Contribute
  • License
  • About

Features

• Benchmark commands
• Capture commands for replay
• Save output of commands to file
• Diff output of commands for easy comparing
• Export reports as JSON & XML

Installing

Work in progress

Building

To build this project from source follow these steps. You need cmake & ninja to do this.

1. Clone repository

git clone https://github.com/aaronlyy/veloq

2. Cd into project

cd veloq

3. Create build directory

mkdir build

4. Create build files

cmake -S . -B build -G "Ninja" -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

5. Build project

cmake --build build

Usage

Work in progress

Examples

Work in progress

The name

Contribute

Work in progress

License

Work in progress

About

Made with ♥️ by Aaron Levi (aaronlyy) Can