Lector

Lector is a terminal screen reader. It speaks what appears in your terminal and lets you review what’s on screen without disrupting the running program.

What Lector does

• Reads new terminal output automatically as it appears.
• Lets you review lines, words, and characters independently of the app cursor.
• Helps navigate tables in terminal output.
• Provides a clipboard history for quick copy/paste.
• Can be customized with a simple Lua config file.

Get started

Build a release from a fresh clone with the standard Cargo command:

cargo build --locked --release

Run Lector with your shell:

cargo run -- --shell /bin/zsh

Or use the SHELL environment variable:

SHELL=/bin/zsh cargo run

In key names, M- means Alt (or Option) and C- means Control. Lector uses native speech by default. Press M-x to pause or resume speech, M-r to review output, and F1 to hear what a key does.

The build guide lists prerequisites, supported targets, and offline packaging. The [documentation…