stava

CLI tool to perform spell checking.

Rust implementation of Peter Norvig's Spell Corrector.

``` USAGE: stava [FLAGS] [FILES]...

FLAGS: -d, --default Include default set of words (default: false) -o, --exit-code-only Only return exit code and not corrected word (default: false) -e, --exit-code Exit with 1 if word is not spelled correctly, otherwise 0 (default: false) -h, --help Prints help information -V, --version Prints version information

ARGS: Word to correct ... Files to learn words from ```

• The default file contains ~30k unique words and is included in the crate
• If needed you can pass in one or many of your own files
• The files doesn't require any certain formatting (except whitespace separated words) and special characters are allowed, stava knows how to ignore them

Currently stava only supports the English alphabet.

Installation

bash $ cargo install stava

Usage

Use the default set of words bash $ stava bycycle bicycle

Use your own files bash $ echo "bicycle" > words.txt $ echo "some other words" > words2.txt $ stava bycycle words.txt words2.txt bicycle

Use your own files and the default set of words bash $ echo "some words" > words.txt $ stava --default mankey words.txt monkey

With exit code bash $ stava --exit-code bycycle # Word is corrected so exit code = 1 bicycle $ echo $? 1

bash $ stava --exit-code-only bycycle # Word is corrected so exit code = 1 $ echo $? 1

• If multiple candidates are found, the one occurring the most in the provided files are returned
• If no candidate is found the input word is returned