grimmoire

A small terminal spellbook for Library Genesis: search, stream a book to a temp cache, open it in zathura for a quick read, then either keep it in a persistent collection folder or discard it.

• Type-to-filter TUI for picking from search results.
• Books stream to a temp cache first; only kept on explicit confirmation.
• Two-tier storage: ephemeral cache + persistent collection (XDG-compliant).
• Top-level menu: search / browse / delete.

Requirements

• Python 3.10+
• zathura installed at the system level (via your package manager)

Installation

pipx keeps grimmoire in an isolated venv but exposes the grimmoire command on your PATH:

pipx install grimmoire

Or with pip:

pip install --user grimmoire

To install from a working copy of this repo (e.g. for development), see DEVELOPING.md.

Usage

grimmoire

Then choose what to do from the menu:

1. Search Library — search, pick a book (preferring EPUB), download, open in zathura. After reading, choose Keep (default) or Discard.
2. Browse my collection — pick a saved book, open in zathura. After reading, choose Delete (default: keep).
3. Delete from collection — pick a saved book, confirm, delete. (No zathura; for batch pruning without re-reading each one.)

Ctrl+C cancels any prompt.

Storage

Storage follows the XDG Base Directory Specification:

• Cache (in-flight downloads): $XDG_CACHE_HOME/grimmoire/tmp/ (default ~/.cache/grimmoire/tmp/)
• Collection (kept books): $XDG_DATA_HOME/grimmoire/library/ (default ~/.local/share/grimmoire/library/)

The collection folder is created automatically on first use.

License

GPLv3