nell
Read and manage the person's e-book library with Nell, the Omarchy EPUB and PDF reader. Use when asked about their books, what they're reading, their highlights, notes, bookmarks, or looked-up words,
Files73
View on GitHub- hyphen/11 files
- i18n/6 files
- AccentButton.qml811 B
- AppearancePanel.qml13 KB
- BookCover.qml4.3 KB
- catalog.cpp20 KB
- catalog.h5.0 KB
- CatalogView.qml16 KB
- cli.cpp15 KB
- cli.h512 B
- ContentsPanel.qml18 KB
- ContinueCard.qml2.7 KB
- DefinitionCard.qml4.5 KB
- dictionary.cpp4.1 KB
- dictionary.h1.4 KB
- epub.cpp9.8 KB
- epub.h1.4 KB
- filepicker.h641 B
- FocusRing.qml695 B
- FootnotePopup.qml2.7 KB
- GoToDialog.qml3.0 KB
- HelpOverlay.qml4.7 KB
- hyphenator.cpp6.5 KB
- hyphenator.h1.8 KB
- Icon.qml2.2 KB
- IconButton.qml1.5 KB
- library.cpp25 KB
- library.h6.8 KB
- LibraryView.qml18 KB
- Lightbox.qml3.6 KB
- main.cpp4.6 KB
- Main.qml11 KB
- NoteEditor.qml3.4 KB
- pageview.cpp4.7 KB
- pageview.h2.5 KB
- portalfilepicker.cpp11 KB
- portalfilepicker.h1.1 KB
- preferences.cpp9.5 KB
- preferences.h6.3 KB
- qmldir32 B
- reader.cpp97 KB
- reader.h18 KB
- ReaderView.qml37 KB
- record.cpp8.8 KB
- record.h2.3 KB
- resources.qrc2.6 KB
- SearchPanel.qml5.1 KB
- Segmented.qml2.1 KB
- SelectionMenu.qml4.3 KB
- Sidebar.qml7.5 KB
- skill.md2.2 KB
- StatsPanel.qml14 KB
- theme.cpp5.0 KB
- theme.h1.4 KB
- Toast.qml4.0 KB
- Tokens.qml4.6 KB
- translator.cpp6.7 KB
- translator.h1.5 KB
SKILL.mdsrc/skill.md
GitHubNell
Nell is a desktop e-book reader for EPUB and PDF. Its library lives in
~/.local/share/nell/; books stay where they are on disk and are never
modified. The nell command reads and adds to the library without a display.
Commands
Every command takes --json, exits 0 on success and 1 on failure, and writes
errors to stderr.
nell list— the library, most recently read first: id, progress, title, author.--jsonadds path, format, cover, added and opened times, and whether the file is missing.nell add <file>...— add EPUB or PDF files. Adding a book that's already there (even moved) finds it again by content, so it is safe to repeat.nell info <book>— title, author, format, and table of contents of a file or a library id. Works on files not in the library.nell notes <book>— highlights with their notes and colors, grouped by chapter, plus bookmarks and looked-up words with definitions. Prints Markdown by default;--jsongives the versioned export: each highlight'stext,note,color,section, andlocation(an EPUB's Kindle-style location, a PDF's page; PDFs also havepage). Works from the saved notes when the book file is missing.nell import <file>— read back anell notes --jsonexport, merged with any notes already saved for that book. Only when the person asks to restore notes.nell open [book]— open the reader for the person. It needs their desktop, so do not wait on it.
Working with the person
- Their highlights and notes are their own reading; quote them faithfully and don't rewrite them.
- To answer "what was I reading", use
nell list --jsonand look atopenedandprogress. - Nell never edits book files, and neither should you on its behalf.