<p align="center">
<img width="128" height="128" src="assets/logo/quicktest-512x512.png">
</p>
<h1 align="center">Quick Test CLI</h1>
<p align="center">Command Line Interface (CLI) for Stress Testing for Competitive Programming</p>
<h2 align="center">📖 <a href="https://luchobazz.github.io/quicktest/docs/intro">Docs</a></h2>
[](https://crates.io/crates/quicktest) [](https://app.circleci.com/pipelines/github/LuchoBazz/quicktest) [](https://opensource.org/licenses/MIT) [](https://github.com/LuchoBazz/quicktest)
## Demo
## Documentation
**Table of Contents**
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Introduction](#introduction)
- [Disclaimer](#disclaimer)
- [Commands](#commands)
- [How to Contribute](#how-to-contribute)
- [Bug reports](#bug-reports)
- [Supported Languages](#supported-languages)
- [Compilation and Execution Commands](#compilation-and-execution-commands)
- [License](#license)
- [Credits](#credits)
## Getting Started
### Installation
Installation tutorials for Linux, Windows, and macOS are available [here](https://luchobazz.github.io/quicktest/docs/getting-started/installation) on the documentation website.
### Disclaimer
QuickTest supports Windows and Linux. While the CLI has been successfully tested on these platforms, macOS functionality is currently unverified. macOS users should proceed with caution and are encouraged to report any issues.
## Introduction
Quick Test CLI is a tool designed for fast and easy stress testing in competitive programming, allowing you to focus entirely on the contest.
Quick Test CLI currently supports the following three test types:
|  |  |  |
* `quicktest cmp | qt cmp`: Verifies the correctness of an algorithm by comparing it against a brute-force solution. The brute-force solution, while typically slower, is guaranteed to be correct.
* **Sample:**
```shell
quicktest cmp --target-file=main.cpp --correct-file=correct.cpp --gen-file=gen.cpp
# Or shorter:
qt cmp -t main.cpp -c correct.cpp -g gen.cpp --tout 1000 --tc 1000
```
* `quicktest stress | qt stress`: Verifies that the code executes within the time limit using a random generator for multiple test cases.
**Note:** This mode does not compare against a slower, correct solution.
* **Sample:**
```shell
quicktest stress --target-file=main.cpp --gen-file=gen.cpp
# Or shorter:
qt stress -t main.cpp -g gen.cpp --tout 1000 --tc 1000
```
* `quicktest check | qt check`: For problems with multiple valid answers where `quicktest cmp` is unsuitable, a script checker is used to verify algorithm correctness.
* **Sample:**
```shell
quicktest check --target-file=main.cpp --checker-file=correct.cpp --gen-file=gen.cpp
# Or shorter:
qt check -t main.cpp -c check.cpp -g gen.cpp --tout 1000 --tc 1000
```
* `quicktest output | qt output`: Runs all test cases matching a prefix and saves the results to an output file.
* **Sample:**
```shell
quicktest output --target-file=main.cpp --prefix=testcase_ac
# Or shorter:
qt output -t main.cpp -p test_cases/testcase_ac --tout 1000
```
## Commands
**Note:** you can use the long command `quicktest` or the alias `qt`
* `quicktest cmp | qt cmp`
**Required Options**
* `-t=<value> | --target-file=<value>`
* `-c=<value> | --correct-file=<value>`
* `-g=<value> | --gen-file=<value>`
**Other Options**
* `--test-cases=<value> | --tc=<value> [default: 1000]`
* `--timeout=<value> | --tout=<value> [default: 2000]` Unit of time: `ms`
* `--memory-limit=<value> | --ml=<value> [default: 1000000000 - 1GB]` Unit of time: `bytes`
* `--prefix=<value> | -p=<value>` Conflicts with `--gen-file` (Only one can be used at a time).
* `--diff` Show differences between the expected file and the output file
---
* `quicktest stress | qt stress`
**Required Options**
* `-t=<value> | --target-file=<value>`
* `-g=<value> | --gen-file=<value>`
**Other Options**
* `--test-cases=<value> | --tc=<value> [default: 1000]`
* `--timeout=<value> | --tout=<value> [default: 2000]` Unit of time: `ms`
* `--memory-limit=<value> | --ml=<value> [default: 1000000000 - 1GB]` Unit of time: `bytes`
* `--prefix=<value> | -p=<value>` Conflicts with `--gen-file` (Only one can be used at a time).
---
* `quicktest check | qt check`
**Required Options**
* `-t=<value> | --target-file=<value>`
* `-c=<value> | --checker-file=<value>`
* `-g=<value> | --gen-file=<value>`
**Other Options**
* `--test-cases=<value> | --tc=<value> [default: 1000]`
* `--timeout=<value> | --tout=<value> [default: 2000]` Unit of time: `ms`
* `--memory-limit=<value> | --ml=<value> [default: 1000000000 - 1GB]` Unit of time: `bytes`
* `--prefix=<value> | -p=<value>` Conflicts with `--gen-file` (Only one can be used at a time).
---
* **Flags of the `cmp`, `stress` and `check` subcommands**
* `--break-bad | --break` Stops execution if WA, TLE, or RTE states occur.
* `--run-ac` Runs Accepted test cases.
* `--run-all` Runs all test cases.
* `--run-rte` Runs Run Time Error test cases.
* `--run-tle` Runs Time Limit Exceeded test cases.
* `--run-wa` Runs Wrong Answer test cases.
* `--save-all` Saves all test cases.
* `--save-bad` Saves only bad cases (WA, TLE, or RTE).
---
* `quicktest output | qt output`
**Required Options**
* `-t=<value> | --target-file=<value>`
* `-p=<value> | --prefix=<value>`
**Other Options**
* `--timeout=<value> | --tout=<value> [default: 2000]` Unit of time: `ms`
* `--memory-limit=<value> | --ml=<value> [default: 1000000000 - 1GB]` Unit of time: `bytes`
* `--break-bad | --break` Stops execution if WA, TLE, or RTE states occur.
* `--save-out` Saves the target file output for each test case.
---
* `quicktest setup | qt setup`
**Subcommand**
* `config` Subcommand for modifying C++ configuration settings.
**Options**
* `--label=<value>` The configuration label path to modify.
* `--value=<value>` The new value for the selected label.
---
* `quicktest example | qt example`
**Flags**
* `--check` Shows examples for the check subcommand.
* `--cmp` Shows examples for the cmp subcommand.
* `--stress` Shows examples for the stress subcommand.
* `--output` Shows examples for the output subcommand.
* `--setup` Shows examples for the setup subcommand.
**Note:** Only one flag can be used at a time.
## How to Contribute
If you are interested in contributing to the Quick Test CLI project, please take a look at the [Contribute](./CONTRIBUTING.md) guide
### Bug reports
You can report any bugs [here](https://github.com/LuchoBazz/quicktest/issues).
## Supported Languages
| C++ |
| Java |
| Python |
| Rust Lang |
| Go Lang |
| GNU C |
| Kotlin |
## Compilation and Execution Commands
| C++17 | `g++ -std=c++17 -Wall -DONLINE_JUDGE=1 -o .qt/main main.cpp` | `./.qt/main` |
| Java | `javac -d .qt/ Main.java` | `java -cp .qt/ Main` |
| Python3 | | `python3 main.py` |
| Rust Lang | `cp main.rs ~/.quicktest/rust/src/main.rs && cargo build --release --quiet --manifest-path ~/.quicktest/rust/Cargo.toml && cp ~/.quicktest/rust/target/release/rust .qt/main` | `./.qt/main` |
| Go Lang | `cp main.go ~/.quicktest/go_mod/main.go && go build -buildmode=exe -o ./.qt/main ~/.quicktest/go_mod/main.go` | `./.qt/main` |
| GNU C | `gcc -std=gnu11 -lm main.c -o .qt/main` | `./.qt/main` |
| Kotlin | `kotlinc main.kt -include-runtime -d .qt/main.jar` | `java -jar .qt/main.jar` |
## License
Licensed under either of these:
* MIT license ([LICENSE-MIT](https://github.com/LuchoBazz/quicktest/blob/main/LICENSE) or https://opensource.org/licenses/MIT)
---
## Credits
> <sub>Logo image based on the one made by <a href="https://www.flaticon.com/authors/freepik" id-flaticon="owl_2369306;hexagonal_73861" title="Freepik">Freepik</a> for <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>
> <sub>Documentation was based on <a href="https://searleser97.github.io/cpbooster/" title="CP Booster">cpbooster</a>
> <sub>Installation scripts were based on <a href="https://github.com/denoland/deno_install" title="Flaticon">deno_install</a>
> <sub>Authorship note: portions of this README were generated with assistance from an AI tool and have been reviewed and edited by the project author to ensure technical accuracy and legal compliance.