bk is a WIP terminal Epub reader, written in Rust.
- Cross platform - Linux, macOS and Windows support
- Single binary, instant startup
- Epub 2/3 support
- Vim bindings
- Incremental search
- Bookmarks
Install from crates.io:
cargo install bk
or from github:
git clone https://github.com/aeosynth/bk
cargo install --path bk
Usage: bk [<path>] [-m] [-t] [-w <width>]
read a book
Options:
-m, --meta print metadata and exit
-t, --toc start with table of contents open
-w, --width characters per line
--help display usage information
Running bk without a path will load the most recent Epub.
Type any function key (eg F1) to see the keybinds.
- Theming: theme your terminal
- Config file: create an alias with cli options
| bk | epr/epy | |
|---|---|---|
| language | rust | python |
| runtime deps | none | python, curses |
| styled tags | see 1 | ❌ |
| incremental search | ✔️ | ❌ |
| multi line search | ✔️ | ❌ |
| regex search | ❌ | ✔️ |
| links | ❌ | ❌ |
| images | ❌ | ✔️ |
| themes | ❌ | ✔️ |
| choose file from history | ❌ | ✔️ |
| additional formats | ❌ | FictionBook |
| external integration | see 2 | dictionary |
1: headers (h1-h6) are bolded
2: you can use the --meta switch to use bk as a file previewer with eg nnn
