MCPcopy Index your code
hub / github.com/aeosynth/bk

github.com/aeosynth/bk @v0.6.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.6.0 ↗ · + Follow
52 symbols 108 edges 3 files 2 documented · 4%
What it actually does AI analysis from the code graph — generated when you open this
loading…
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

Inspiration

https://github.com/wustho/epr

Extension points exported contracts — how you extend this code

View (Interface)
(no doc) [7 implementers]
src/view.rs

Core symbols most depended-on inside this repo

next
called by 13
src/view.rs
mark
called by 8
src/main.rs
render
called by 7
src/epub.rs
get_text
called by 5
src/epub.rs
render
called by 5
src/epub.rs
render_text
called by 5
src/epub.rs
prev
called by 5
src/view.rs
jump_byte
called by 4
src/main.rs

Shape

Method 29
Class 15
Function 6
Enum 1
Interface 1

Languages

Rust100%

Modules by API surface

src/view.rs23 symbols
src/main.rs18 symbols
src/epub.rs11 symbols

For agents

$ claude mcp add bk \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact