✨ sleek typing tui with visualized results and historical logging

thokr-plus is an enhanced fork of thokr. On top of the original it adds continuous timed mode, color themes, a death mode, and punctuation/numbers — while staying a drop-in thokr command. See the Usage section for the new flags.

$ cargo install thokr-plus

The installed command is thokr.

For detailed usage run thokr -h.

sleek typing tui with visualized results and historical logging

Usage: thokr [OPTIONS]

Options:
  -w, --number-of-words <NUMBER_OF_WORDS>
          number of words to use in test (initial buffer only when timed) [default: 15]
  -f, --full-sentences <NUMBER_OF_SENTENCES>
          number of sentences to use in test
  -s, --number-of-secs <NUMBER_OF_SECS>
          run a timed test for this many seconds; words stream continuously until the clock stops (unless -p or -f fixes the text)
  -p, --prompt <PROMPT>
          custom prompt to use
  -l, --supported-language <SUPPORTED_LANGUAGE>
          language to pull words from [default: english] [possible values: english, english1k, english10k]
      --pace <PACE>
          ghost caret pacing at this WPM to race against
      --theme <THEME>
          color theme; a `theme.json` in the config dir can override any color [default: default] [possible values: default, matrix, dracula, ocean, mono]
  -h, --help
          Print help
  -V, --version
          Print version

During a test you can press ← to start over or → to see a new prompt (assuming you didn't supply a custom one)

Passing -s <seconds> on its own runs a continuous test: fresh words stream in as you type and the test only ends when the clock hits zero — a long prompt scrolls a few lines at a time so the layout stays put. -w then just sets the size of the initial on-screen buffer. Combining -s with a custom prompt (-p) or sentences (-f) keeps the text fixed, so the test still ends when you finish it or the timer expires, whichever comes first.

Pick a built-in palette with --theme:

$ thokr --theme dracula
$ thokr -s 30 --theme matrix

Available presets: default (the classic look), matrix, dracula, ocean, and mono.

For full control, drop a theme.json into thokr's config directory (the same folder as log.csv — see Logging). Any color you set overrides the selected preset; anything you omit falls back to it. Colors accept either a named terminal color or a #rrggbb hex value:

{
  "preset": "dracula",
  "correct": "#50fa7b",
  "incorrect": "red",
  "pending": "#6272a4",
  "graph": "lightmagenta",
  "timer": "#f1fa8c",
  "text": "white"
}

An unrecognized color is ignored in favor of the preset, so a typo never leaves the interface unreadable.

The following languages are available by default:

Upon completion of a test, a row outlining your results is appended to the log.csv file found in the following platform-specific folders. This way you can easily track your progress over time.

• ⚡️ Performance
  • Right now there are known performance issues surrounding the rendering of the tui at each tick interval and/or key press. Ideally each render uses the prior render as a base and only makes the necessary adjustments (possibly using StatefulWidget), but I haven't been able to figure that out yet.
• 🔠 Multi-language support
  • I decided not to launch thokr with languages besides english because of some odd rendering issues I was experiencing when trying to input characters with accents. It's as though I'm not able to properly input the character in raw mode. I'd love to have that figure out before shipping other languages because I personally felt the experience was a bit jarring. I'll open an bug report for it with more details and replication steps -- would love more eyes on that problem!
• 🧪 Tests
  • I've only written a small amount of tests at this point. I haven't sat down to really think through what tests look like when the output is dependent on the users terminal size, font size, etc. If you have any ideas for this please open up an issue and start the discussion!

All contributions are greatly appreciated.

If you have a suggestion that would make thokr better, please fork the repo and create a pull request. You can also simply open an issue and select Feature Request

1. Fork the repo
2. Create your feature branch (git checkout -b [your_username]/xyz)
3. Commit your changes (git commit -m 'add some xyz')
4. Rebase off main (git fetch --all && git rebase origin/main)
5. Push to your branch (git push origin [your_username]/xyz)
6. Fill out pull request template

See the open issues for a full list of proposed features (and known issues).

Distributed under the MIT License. See LICENSE.md for more information.

Check out these amazing projects that inspired thokr!

• monkeytype
• tui-rs
• ttyper