clavirio

www.clavir.io

From Latin clavis (key) — a terminal typing tutor.

A terminal typing tutor built with Rust and ratatui. Practice with built-in lessons or any text file while a virtual keyboard tracks your keystrokes in real time.

Features

• 15 built-in lessons — progressive drills from home row basics to full paragraphs and code, ordered by difficulty
• Live stats — WPM, accuracy %, elapsed time, keystrokes, and line progress update as you type
• Keyboard layouts — supports QWERTY, Dvorak, and Colemak; switch with l on the main menu
• Virtual keyboard — highlights the expected next key (including Shift) with a finger hint (Pinky, Ring, Middle, Index, Thumb) on the top border; adapts to macOS and PC layouts
• Error feedback — wrong keystrokes are shown inline and block progress until corrected with Backspace
• Completion summary — final WPM, accuracy percentage, and your weakest keys
• Session history — results saved to ~/.clavirio/history.json with per-lesson tracking, scrollable history view, and averages across completed sessions
• Display settings — toggle fingers, hints, keyboard, and dark/light theme from the main menu (1–4); all preferences saved to ~/.clavirio/settings.toml
• Progress tracking — the menu cursor remembers your last built-in lesson: points to it if unfinished, advances to the next if completed
• Custom text — load any text file via Ctrl-F or as a CLI argument
• Graceful shutdown — in-progress sessions are saved on SIGTERM/SIGHUP

Lessons

Build & Run

cargo build --release
cargo run

Optionally pass a file directly:

cargo run -- sample.txt

Terminal Size

clavirio is a terminal UI application — your terminal window should be large enough to display all elements (text panel, keyboard, stats). On a laptop screen this usually means a maximized terminal window.

Controls

Settings

Preferences are stored in ~/.clavirio/settings.toml and saved automatically.

[keyboard]
layout = "qwerty"      # qwerty, dvorak, colemak

[display]
show_keyboard = true
show_hints = true
show_fingers = true
theme = "dark"          # dark, light