Bookokrat is a terminal-based EPUB/PDF/DJVU reader that prioritizes speed and smooth navigation. With features like Vim-style workflows, split layouts, inline comments, and persistent storage, it enhances the reading experience for those who value efficiency and simplicity in their digital library.
Bookokrat is a powerful terminal-based reader designed for EPUB, PDF, and DJVU formats. It emphasizes speed and smooth navigation while adopting Vim-style workflows, offering a unique reading experience to users who prefer command-line interfaces.
Key Features
- Multi-format Support: Read EPUB, PDF, and DJVU files seamlessly within a single Terminal User Interface (TUI) application.
- Split Layout: Enjoy a user-friendly split layout with the library and Table of Contents on the left and the reading pane on the right.
- Fast Rendering: Benefit from a swift PDF/DJVU pipeline enhanced by Kitty SHM image transfer for optimal performance in supported terminals.
- Advanced Functionality: Utilize features like search capabilities, bookmarks, jump lists, and reading statistics.
- Annotations: Add inline comments and annotations with persistent storage and export them in Markdown format.
- Customization Options: Choose from various themes, adjust margins, and enter zen mode for a distraction-free reading experience.
- Vi-like Keybindings: Navigate through literature efficiently with familiar Vim-style keybindings and the normal mode.
Getting Started
To begin using Bookokrat, simply run the following command in your terminal:
bookokrat
For opening a specific file, use:
bookokrat path/to/book.epub
bookokrat path/to/book.pdf
bookokrat path/to/book.djvu
Explore the built-in help by pressing ? within the application for additional guidance.
Data Management
Bookokrat is designed to keep project directories clean by storing its state in XDG-compliant locations, ensuring that bookmarks, comments, cached images, and settings are organized and easy to manage.
| Data | Location |
|---|---|
| Bookmarks | <data_dir>/bookokrat/libraries/<library>/bookmarks.json |
| Comments | <data_dir>/bookokrat/libraries/<library>/comments/ |
| Image Cache | <cache_dir>/bookokrat/libraries/<library>/temp_images/ |
| Log File | <state_dir>/bookokrat/bookokrat.log |
| Settings | ~/.bookokrat_settings.yaml |
Bookokrat is built with versatility in mind, suitable for those who desire an efficient and comfortable reading experience within their terminal. For more detailed instructions on usage and setup, refer to the included documentation.
No comments yet.
Sign in to be the first to comment.