Home

Awesome

<h1 align=center> toipe </h1> <p align=center> A trusty terminal typing tester. </p> <p align=center> <a href="https://crates.io/crates/toipe"><img alt="Crates.io badge" src="https://img.shields.io/crates/v/toipe"></a> <a href="https://github.com/Samyak2/toipe/actions/workflows/lints-and-checks.yml"><img src="https://github.com/Samyak2/toipe/actions/workflows/lints-and-checks.yml/badge.svg" alt="Lints and checks badge" /></a> <a href="https://docs.rs/toipe/latest/toipe/"><img alt="docs.rs badge" src="https://img.shields.io/docsrs/toipe"></a> </p> <p align=center> <img src=https://raw.githubusercontent.com/Samyak2/toipe/main/images/toipe.gif> </p>

Usage

Install

From GitHub

Go to the latest release, scroll down to "Assets" and download the correct file for your platform (.zip in case of Mac OS, .tar.gz in case of Linux). Unzip the file and run the toipe binary inside.

From Cargo

Alternatively, if you have the cargo tool (part of the Rust toolchain) installed on your system, you can use:

cargo install toipe

Run typing test

toipe looks best on a nice terminal (such as Alacritty) with color and style support.

If installed through GitHub, run the binary (found inside the zip/tar.gz file after extracting) directly:

./toipe

If installed through cargo, use:

toipe

Keyboard shortcuts

See toipe --help for a list of keyboard shortcuts (the list can also be found here).

Show less or more text

To change the number of words shown in each test, use the -n flag (default: 30):

toipe -n 10
toipe -n 100

Use a different word list

By default, a list of top 250 English words (top250) is used and random words are selected from it. See toipe -h for a list of available built-in word lists.

To use the OS provided word list instead, use:

toipe -w os

Note: the OS word list varies a lot from system to system and usually has more than 100,000 words. This can lead to difficult and esoteric words appearing in the test, reducing your typing speed.

You can provide your own word list too (Note: the word list must meet these assumptions):

toipe -f /path/to/word/list

Add punctuation to test

By default, only lowercase words are shown. To add punctuation and sentence case, use the -p flag:

toipe -p

Platform support

License

MIT