⭐ star — Speaking Terminal Access Reader
star is an accessible, GUI-first document reader with built-in text-to-speech. It opens PDFs, Word/EPUB/PowerPoint, web pages, spreadsheets, and more, reads them aloud, and highlights each word as it is spoken — with no cloud account and no internet required.
star is built for students with print disabilities — people who work with
dense, heavily formatted documents and need a reading tool that gets out of the
way. The Qt GUI is the primary interface (it launches by default and is where
development is focused), with a keyboard shortcut for every command; a
full-featured, keyboard-driven curses terminal UI remains available with
--tui for headless or text-only environments.
It draws design inspiration from Emacspeak, Kurzweil 1000, Natural Reader, and Central Access Reader.
🚀 Install
On any platform with Python 3.11+:
pipx install star-reader # isolated app install (recommended)
# or
pip install star-reader # into the current environment
Then run it:
star # launch the Qt GUI
star document.pdf # open a file
star --tui # force the terminal UI
star --deps # show which optional features are installed
star --install-optional # fetch optional features from the command line
Optional features
star runs out of the box on nothing but the Python standard library, and grows on demand. On first launch the GUI shows a short optional-features chooser: pick the Thin or All preset, or tick exactly the capabilities you want (OCR, offline dictionary, summarize, translate, knowledge-graph extras, …), and star fetches the Python packages in the background — best-effort, once per machine. Re-open it any time from Tools → Install Optional Features…. The very large packs (speech-to-text dictation, named-entity extraction) stay opt-in, so All never triggers a multi-gigabyte download.
Prefer the command line or a scripted setup? star --install-optional installs
the all preset; star --install-optional thin or
star --install-optional ocr,dictionary install a preset or a comma-separated
list of features; run it with no value to list every feature with its size. You
can also install extras yourself the classic way — pip install "star-reader[all]" (everything except the multi-GB Whisper/Torch dictation
stack, [transcribe]), or groups like star-reader[translate,vocab].
Full instructions (wheel, single-file star.pyz, native engines, per-platform
notes) are in the Installation guide.
✨ Highlights
- Reads aloud with live word highlighting in both the Qt GUI and the terminal TUI — including in-process eSpeak-NG with true audio-position sync.
- Many TTS engines: pyttsx3 (SAPI5 / NSSpeechSynthesizer), macOS
say, eSpeak-NG, Festival, Piper (neural, offline, free), Coqui, and DECtalk. - Opens almost anything: PDF (incl. OCR), DOCX, PPTX, EPUB, HTML, Markdown, spreadsheets, DAISY/DTBook, and dozens more formats.
- Study tools: notes & annotations, a citation manager, summarization, Anki flashcard export, document translation (15 languages, no API key), RSS/Atom feed reading, and a difficult-word overlay.
- Knowledge graph: link annotations across documents with typed relations
(
CONFLICTS_WITH,SUPPORTS,CITES, …), extract concepts, view the graph interactively, and export to SVG/PlantUML/DOT/JSON. - Export: Markdown, HTML, EPUB, PDF (with highlights), BRF braille, TTS audio (WAV/MP3/OGG/MP4), karaoke video (MP4), Anki decks, and synchronized SRT/VTT subtitles.
- Extensible: TTS engines, document formats, and export targets are
discovered through
importlib.metadataentry-points — installing a third-party plugin package adds backends, loaders, or exporters with no changes to star itself. - Accessibility-first: NVDA/JAWS/Orca/VoiceOver compatible, four colorblind-friendly themes + custom CSS themes, dyslexia-friendly font, bionic reading, adjustable spacing (WCAG 1.4.12), and high-DPI support.
- Graceful degradation: every third-party dependency is optional and guarded, so the core runs on the Python standard library alone.
- Runs out of the box, grows on demand: a first-run chooser (or
star --install-optional) fetches only the optional features you pick, in the background — nothing to configure before your first document. - Clear, consistent UI: an all-icon toolbar with descriptive tooltips (vector glyphs drawn programmatically and tinted to your theme — no image files); a readable welcome page that reads aloud like any document; and F1 opens the bundled README as a document on every install.
See the full feature reference for everything.
📚 Documentation
| Guide | What's in it |
|---|---|
| Installation | PyPI / wheel / zipapp install, optional packages, native engines, platform notes |
| Usage Guide | Running star, the quick command reference, full keyboard map, M-x commands, CLI options |
| Features | The complete feature reference |
| Knowledge Graph | Typed relations between annotations, concept extraction, graph view, and export |
| Configuration | Every settings.json key |
| Architecture & Contributing | Package layout, distribution artifacts, contributing, tests |
| Changelog | Full record of changes |
| Build guide | Building the cross-platform wheel (and the deprecated Windows star.exe) |
➡️ Browse all docs in the docs/ directory.
📦 Distribution
The pure-Python wheel (pip install star-reader) is star's primary, stable
distribution and the only artifact produced by automated releases; it works on
macOS, Linux, and Windows alike. A single-file
star.pyz zipapp and the
self-contained Windows star.exe (deprecated) are build-it-yourself —
they are no longer shipped with releases. See
Installation and BUILD.md.
🤝 Contributing
Contributions are welcome — please open an issue before a PR for anything beyond
small fixes. Keep every third-party dependency optional and guarded, target
Python 3.11, and document new keybindings and M-x commands. See
Architecture & Contributing for the full
guidelines and how to run the test suite.
📜 License
star — Speaking Terminal Access Reader
Copyright 2026 Jon Pielaet
Free software under the GNU General Public License version 3 or later. This
program is distributed in the hope that it will be useful, but without any
warranty. See the LICENSE file, or run M-x license in the app, for
the full text.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file star_reader-0.1.19.tar.gz.
File metadata
- Download URL: star_reader-0.1.19.tar.gz
- Upload date:
- Size: 435.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5883b5e5ada3fe60453c81ab00ee9c061563c09d36b2050ca95c594534376263
|
|
| MD5 |
63ede71b5e57299c1d9f908acf519daa
|
|
| BLAKE2b-256 |
80ec9bec44f0a39c081fde24d5234ec842462a4eda0b525abf9eedeaeb62bc87
|
Provenance
The following attestation bundles were made for star_reader-0.1.19.tar.gz:
Publisher:
release.yml on leavesofgrass/star
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
star_reader-0.1.19.tar.gz -
Subject digest:
5883b5e5ada3fe60453c81ab00ee9c061563c09d36b2050ca95c594534376263 - Sigstore transparency entry: 2044048714
- Sigstore integration time:
-
Permalink:
leavesofgrass/star@14dffb12864724919c331401f2e71ecbfe863fb2 -
Branch / Tag:
refs/tags/v0.1.19 - Owner: https://github.com/leavesofgrass
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@14dffb12864724919c331401f2e71ecbfe863fb2 -
Trigger Event:
push
-
Statement type:
File details
Details for the file star_reader-0.1.19-py3-none-any.whl.
File metadata
- Download URL: star_reader-0.1.19-py3-none-any.whl
- Upload date:
- Size: 438.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb4d265b98deaef5c3a5da652563449f739b549fd6fa1014d69c4f7287183e93
|
|
| MD5 |
0cc9c57069d5ae36cba814e047ccc006
|
|
| BLAKE2b-256 |
736cae0467afda1b9a09eba7e6bcfe61dd0bed7ba3c7a73fd232af8076ee49da
|
Provenance
The following attestation bundles were made for star_reader-0.1.19-py3-none-any.whl:
Publisher:
release.yml on leavesofgrass/star
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
star_reader-0.1.19-py3-none-any.whl -
Subject digest:
cb4d265b98deaef5c3a5da652563449f739b549fd6fa1014d69c4f7287183e93 - Sigstore transparency entry: 2044048732
- Sigstore integration time:
-
Permalink:
leavesofgrass/star@14dffb12864724919c331401f2e71ecbfe863fb2 -
Branch / Tag:
refs/tags/v0.1.19 - Owner: https://github.com/leavesofgrass
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@14dffb12864724919c331401f2e71ecbfe863fb2 -
Trigger Event:
push
-
Statement type: