bk
| Crates.io | bk |
| lib.rs | bk |
| version | 0.6.0 |
| source | src |
| created_at | 2020-05-18 10:27:45.83728 |
| updated_at | 2023-11-03 05:27:22.123544 |
| description | Terminal Epub reader |
| homepage | |
| repository | https://github.com/aeosynth/bk |
| max_upload_size | |
| id | 242949 |
| size | 51,048 |
James Campos (aeosynth)
documentation
README
bk
bk is a terminal EPUB reader, written in Rust.
Features
- Cross platform - Linux, macOS and Windows support
- Single binary, instant startup
- EPUB 2/3 support
- Vim bindings
- Incremental search
- Bookmarks
Install
Install from crates.io:
cargo install bk
or from github:
git clone https://github.com/aeosynth/bk
cargo install --path bk
Usage
Usage: bk [<path>] [-m] [-t] [-w <width>]
read a book
Options:
--bg background color (eg 282a36)
--fg foreground color (eg f8f8f2)
-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.
Check if your terminal supports italics:
echo -e "\e[3mitalic\e[0m"
Comparison
| bk | epr/epy | |
|---|---|---|
| runtime deps | ❌ | python, curses |
| wide characters | ✔️ | ❌ |
| incremental search | ✔️ | ❌ |
| multi line search | ✔️ | ❌ |
| regex search | ❌ | ✔️ |
| links | ✔️ | ❌ |
| images | ❌ | ✔️ |
| themes | ✔️ | ✔️ |
| choose file from history | ❌ | ✔️ |
| additional formats | ❌ | FictionBook, Mobi, AZW3 |
| external integration | see 1 | dictionary |
1: you can use the --meta switch to use bk as a file previewer with eg nnn