typedeck

command module
v0.0.0-...-7f70b69 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2026 License: MIT Imports: 2 Imported by: 0

README

typedeck

A typing trainer for one typist, forked from typioca.

Install

go install github.com/williavs/typedeck@latest

Installs to $GOBIN ($HOME/go/bin by default). Or from a checkout: go build -o typedeck .

Data lives in ~/.local/share/typedeck/ ($XDG_DATA_HOME/typedeck). Copy that directory to carry your progress to another machine.

What it is

A fork of typioca for one typist who wants to get better over months, built to run on a 53 x 15 terminal (Pi Zero 2 W + 2.2" PiTFT) as well as a desktop. Same look, same keys. What changed:

  • A home screen of its own. One key continues the book at the bookmark. Below it: a 30 s drill on your weak spots (named on the row), symbols, common words, your trend, and typioca's own menu under More. The header counts your days in a row and the minutes typed today.
  • It remembers. Every key of every run goes to keys.csv (expected, typed, milliseconds since the last key); coach.json keeps a fading tally per key and per letter pair; runs.jsonl lists every run. All of it lives in ~/.local/share/typedeck/ - upstream kept its history in ~/.cache.
  • Weak spots. Every result names the worst keys and pairs with the reason (share missed, or how slow). The Weak spots word list deals common words full of them. Code symbols drills digits and punctuation.
  • Find a book. The first run opens on it: Project Gutenberg's whole English catalog (61,748 books, 72 categories, the month's most-read on top), narrowed as you type, enter adds the book. The catalog is fetched once a month (21 MB); typedeck catalog fetches it now. A book starts at its first chapter, not the title page.
  • Books. typedeck import <file | url | gutenberg number> [--start "first words"] [--title T] cleans any plain text into a book. It appears in the timer run's word lists, every run starts at the bookmark, typedeck books and the Progress screen show how far you are.
  • Nothing is lost. Esc backs out one level instead of quitting the program; stopping a timer run early keeps the result, the keys and the bookmark. Files are written beside the target and renamed over it.
  • Bugs fixed: keys arriving in one read were dropped except the last; typing past the end of a timer run's text panicked; the config was rewritten to disk on every message in the menu; WPM was rounded down by integer division; a config path collision (XDG_CACHE_HOME == XDG_CONFIG_HOME) panicked at start.
  • Speed: a frame drew all 300 words to show three lines. On the Pi Zero 2 W: 17.5 ms before, 0.41 ms after (go test ./cmd -bench Frame).

Tests: go test ./.... Pi build: GOOS=linux GOARCH=arm GOARM=7 go build -o execs/typedeck-armv7 .

Custom wordlists

  1. Create your word list in a new line separated manner:
custom
words
are
the
best

or in the same JSON format as the official ones:

{
  "metadata" : {
    "name" : "My words",
    "size" : 5,
    "packagedAt" : "1970-01-01T00:00:00Z",
    "version" : 1
  },
  "words": [ "custom", "words", "are", "the", "best" ]
}
  1. Place your configuration to platform specific location:
Platform User configuration
Windows %APPDATA%\typedeck\typedeck.conf or C:\Users\%USER%\AppData\Roaming\typedeck\typedeck.conf
Linux $XDG_CONFIG_HOME/typedeck/typedeck.conf or $HOME/.config/typedeck/typedeck.conf
macOS $HOME/Library/Application Support/typedeck/typedeck.conf

Config example (it is TOML):

[[words]]
  name      = "Best hits '22"
  enabled   = false
  sentences = false
  path      = "/home/words/best-hits-22.json"
[[words]]
  name      = "Even better hits '23"
  enabled   = true
  sentences = false
  path      = "/home/words/better-hits-23.json"
  1. Use your words! ship it

Note: Notice that custom wordlist controls are greyed-out, personal configuration must be handled via the file only.

Acknowledgments

typioca by Lukas Bloznelis, MIT. Built with bubbletea.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL