owl-spell 0.4.5

quick spellcheck TUI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# owl-spell

<img src="docs/owl.svg" width=128 height=128>

🦉 quick spellcheck TUI 🦀

## features

- fast hunspell/spellbook spell check
- per-project & global ignore files
- suggest changes & replace in all files
- quick context view to see where a word appears
- automatically download dictionaries if needed
- quick word check CLI option

## demo

Just run `owl` to get an overview of all spelling issues in the current directory.

Keyboard-driven interface for making fast fixes & ignores.

![](docs/tui-demo.gif)


## Usage

```sh
Arguments:
  [PATH]  File or directory to spellcheck (defaults to current directory)

Options:
  -r, --recursive               Recursively search directories for files
  -c, --check                   Check a file or directory non-interactively
  -t, --extension <extensions>  Extensions to check (overrides config)
  -w, --word <word>             Check a word non-interactively
      --init <init>             Download a dictionary
      --show-ignores            Show ignored words
  -h, --help                    Print help
  -V, --version                 Print versionUsage: owl [OPTIONS] [PATH]
```

## project status

This project was written to gain more exposure to Rust & shave a yak.

Use at your own risk, the interface isn't at all stable yet.

## Credits

Heavy-lifting done by [spellbook](https://github.com/helix-editor/spellbook), thanks to Helix team.

Dictionaries from [wooorm/dictionaries](https://github.com/wooorm/dictionaries/).

Logo from licensed Noun Project resources:

- [owl by Oksana Latysheva](https://thenounproject.com/icon/owl-1313864/)
- [pencil by Oksana Latysheva](https://thenounproject.com/icon/pencil-7979264/)