teepub

A terminal EPUB reader.

teepub book.epub

Supports macOS and Linux. Windows is not currently supported.

Install

npm install -g teepub
# or
pnpm add -g teepub
# or
bun add -g teepub

Or run without installing:

npx teepub book.epub
# or
pnpm dlx teepub book.epub
# or
bunx teepub book.epub

Controls

Scrolling

| Key | Action | |-----|--------| | j / ↓ | Scroll down | | k / ↑ | Scroll up | | d | Half page down | | u | Half page up | | PgDn | Full page down | | PgUp | Full page up | | g | Top of chapter | | G | Bottom of chapter |

Chapters

| Key | Action | |-----|--------| | l / → | Next chapter | | h / ← | Previous chapter | | t | Table of contents |

Search

| Key | Action | |-----|--------| | / | Search | | n | Next match | | N | Previous match |

Searches the current chapter and the entire book simultaneously. The footer shows how many matches are in the current chapter and across the whole book.

Padding

| Key | Action | |-----|--------| | Ctrl+Left | Increase horizontal padding | | Ctrl+Right | Decrease horizontal padding | | Ctrl+Up | Increase vertical padding | | Ctrl+Down | Decrease vertical padding |

Other

| Key | Action | |-----|--------| | ? | Help | | q / Esc | Quit |

Features

• Renders bold, italic, links, lists, blockquotes, tables, and code blocks
• Reading position and padding preferences are saved per file to ~/.local/state/teepub/state.json
• Book-wide search runs in the background across all chapters
• Efficient terminal scrolling using scroll regions

Development

pnpm install
pnpm dev book.epub