aeosynth/bk


Terminal Epub reader

License: MIT

Language: Rust

Keywords: cli, console, ebook, epub, rust, terminal


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

Inspiration

https://github.com/wustho/epr

Project Statistics

Sourcerank 5
Repository Size 160 KB
Stars 209
Forks 13
Watchers 6
Open issues 9
Dependencies 7
Contributors 2
Tags 10
Created
Last updated
Last pushed

Top Contributors See all

James Campos Roman Frołow

Packages Referencing this Repo

bk
Terminal Epub reader
Latest release 0.6.0 - Updated - 209 stars
bk
Terminal EPUB Reader
Latest release 0.5.3 - Published - 209 stars

Recent Tags See all

v0.5.3 March 27, 2021
0.5.2 January 05, 2021
v0.5.1 November 29, 2020
v0.5.0 September 25, 2020
v0.4.2 July 14, 2020
v0.4.1 July 14, 2020
v0.4.0 July 14, 2020
v0.3.0 July 12, 2020
v0.2.0 June 17, 2020
v0.1.1 May 18, 2020

Something wrong with this page? Make a suggestion

Last synced: 2023-11-03 05:30:06 UTC

Login to resync this repository