Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

kruseio/hygg

Repository files navigation

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. Supports scanned documents 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
  • 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
  • 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 books and progress
  • Minimal build feature flag, for only basic converters, no server integration and no ai
  • Image to ascii art converter
  • Natural sounding ai voice model for text to speech narration
  • Run all inference directly in rust no external runtime deps
  • Support more ebook and document formats
  • AI-powered document summarization
  • Reading statistics and insights

Documentation

Visit the Documentation

Community

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

Star History

Contributors

Made with contrib.rocks.

Packages

Contributors