hygg

📚 Simplifying the way you read.
Minimalistic Vim-like TUI document reader.

Why hygg?

• Universal document support - PDF, EPUB, DOCX, and many more formats via pandoc. PDF output can include inline truecolor image art, and scanned documents are supported with OCR
• Lightning-fast keyboard based navigation - Vim-inspired keybindings
• Powerful search - Find anything instantly, highlight important passages, add bookmarks
• Never lose your place - Automatic progress saving
• Extensible workflows - Execute commands directly from copied text
• Respects your privacy - Run locally without server, or selfhost the sync server

Quick start guide

cargo install --locked hygg
hygg doc.pdf

For further install instructions read the Getting started page

Features

Core Reading Experience

• Minimalist interface - Nothing between you and your content
• Smart text justification - Perfectly formatted for your terminal width
• Inline PDF images - Render embedded PDF raster images as colored terminal art alongside extracted text
• Vim keybindings - Navigate with the efficiency you already know
• Visual selection - Select, copy, highlight text
• Bookmarks - Set bookmark points and jump between them instantly
• Persistent - Progress and bookmarks persist

Advanced Workflows

• Command execution - Run shell commands from copied text, also works for previous command output
• Split view - View command output alongside your document
• Interactive tutorial - Learn everything in under 5 minutes
• Cross-platform - Works on Linux, macOS, and Windows

Roadmap

• Plain text format support
• PDF format support
• Inline colored PDF image rendering
• EPUB format support
• Convert scanned documents and images to plain text with ocrmypdf
• Auto saving progress
• Integrated command line with vim like commands
• Text selection and yanking
• Execute commands from yanked text
• Text highlighting
• Bookmarks
• Interactive tutorial
• Self hosted sync server for docs, progress, bookmarks, highlights and notes
• Offline PWA web client
• Start screen to show overview of documents and progress
• Natural sounding ai voice model for text to speech narration
• Reading statistics and insights
• Minimal build feature flag, for only basic converters, no server integration and no ai
• Run all inference directly in rust no external runtime deps
• Support more ebook and document formats
• AI-powered document summarization

Documentation

Visit the Documentation

Community

hygg is built by readers, for readers. Join our growing community:

• Report issues
• Request features
• Contribute code

Star History

Contributors

Made with contrib.rocks.

Licensing

hygg is a multi-license workspace — each crate declares its own license, and there is no single project-wide license see LICENSING.md.

Contributions are accepted under the project's Contributor License Agreement (implicit on submission); see CONTRIBUTING.