Development Setup

Jump to bottom

Ken Tobias edited this page May 26, 2026 · 1 revision

Development Setup

To build and contribute to retch, ensure you have the following prerequisites installed on your system.

Prerequisites

Rust (latest stable toolchain)
just (command runner for checking format, running tests, and compiling documentation)
pandoc (required for generating the manual pages via just man)
hyperfine (optional, required for local CLI execution speed benchmarking)

Local Setup

Clone the Repository:

git clone https://github.com/l1a/retch.git
cd retch

Build the Project:
```
cargo build --release
```
Run Code Quality Checks: Before committing or opening a pull request, always run:
```
just check
```
This executes code formatting checks and clippy warning lints.

Running Benchmarks

Run Criterion micro-benchmarks:
```
just bench
```
Benchmark the CLI execution speed:
```
just bench-cli
```
Compare retch against other fetchers (e.g. fastfetch, neofetch):
```
just bench-compare
```