https://github.com/aeosynth/bk

Terminal Epub reader
https://github.com/aeosynth/bk

cli console ebook epub rust terminal

Last synced: about 1 year ago
JSON representation

Terminal Epub reader

• Host: GitHub
• URL: https://github.com/aeosynth/bk
• Owner: aeosynth
• License: mit
• Created: 2020-04-19T05:01:00.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-09T10:49:32.000Z (almost 2 years ago)
• Last Synced: 2025-04-04T04:39:49.340Z (about 1 year ago)
• Topics: cli, console, ebook, epub, rust, terminal
• Language: Rust
• Homepage:
• Size: 163 KB
• Stars: 292
• Watchers: 6
• Forks: 24
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

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 [] [-m] [-t] [-w ]

    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](https://github.com/jarun/nnn/)

# Inspiration