bk

bk is a WIP 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
• Inline styles (bold/italic)

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:
  -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 | | - | - | - | | language | rust | python | | runtime deps | :x: | python, curses | | inline styles | :heavycheckmark: | :x: | | incremental search | :heavycheckmark: | :x: | | multi line search | :heavycheckmark: | :x: | | regex search | :x: | :heavycheckmark: | | links | :x: | :x: | | images | :x: | :heavycheckmark: | | themes | :x: | :heavycheckmark: | | choose file from history | :x: | :heavycheckmark: | | additional formats | :x: | FictionBook | | external integration | see 1 | dictionary |

1: you can use the --meta switch to use bk as a file previewer with eg nnn

Inspiration

https://github.com/wustho/epr