Raamatukogu: A simple and minimalistic terminal-based e-book browser.
Written in Go and using Zathura to display the ebooks.
- Lightweight Terminal UI: Navigate your documents without leaving the terminal
- Vim-style Navigation: Use familiar Vim keybindings to move through files
- Terminal Browsing: Works with the 'devour' utility to replace your terminal with Zathura
- Search Functionality: Filter files by name in real-time as you type
- Go programming environment (for building)
- Zathura document viewer (and the revelant extensions for the file types you're planning to read)
- termbox-go library
- devour (optional, for swallowing terminals)
-
Clone the repository:
git clone cd rmtk -
Build the application:
go build -
Install to your path (optional):
cp rmtk /usr/local/bin/
rmtk [directory]
If no directory is specified, RMTK will open in the current directory.
| Key | Action |
|---|---|
| ↑ or k | Move up one file |
| ↓ or j | Move down one file |
| Enter | Open directory or file |
| gg | Go to first file |
| G | Go to last file |
| Ctrl+U | Move up half a page |
| Ctrl+D | Move down half a page |
| / | Enter search mode |
| Esc | Exit search mode |
| q | Quit RMTK |
- Press
/to enter search mode - Type your search query
- Files will be filtered in real-time as you type
- Press Enter to accept the filtered results or Esc to cancel and return to the full list
RMTK can open the following file types with Zathura:
- PDF (
.pdf) - DJVU (
.djvu) - PostScript (
.ps) - EPUB (
.epub) - Comic Books (
.cb,.cbz,.cbr)
RMTK uses a YAML configuration file located at ~/.config/rmtk/conf.yml
Creating the config directory
mkdir -p ~/.config/rmtk
# RMTK config
defaultPath: /home/username/Books
- Refactor and restructure current code
- Add bookmarks for frequently used directories
- Hotkey to update home directory in config
- Add functionality to toggle the bottom menu bar
- Add additional configuration options to config file