bloznelis / typioca

Cozy typing speed tester in terminal
MIT License
746 stars 20 forks source link
cli golang terminal tui typing typingspeedtest typingtest

typioca

Minimal, terminal based typing speed tester.

GitHub release (latest SemVer) GitHub Workflow Status

Tapioca (/ˌtæpiˈoʊkə/) is a starch extracted from the storage roots of the cassava plant. Pearl tapioca is a common ingredient in Asian desserts...and sweet drinks such as bubble tea.

Features

Installation

AUR

yay -S typioca-git

Go

go install github.com/bloznelis/typioca@latest

Note: This will install typioca in $GOBIN, which defaults to $GOPATH/bin or $HOME/go/bin if the GOPATH environment variable is not set.

Homebrew

brew tap bloznelis/tap
brew install typioca

Nix

nix-shell -p typioca

openSUSE Tumbleweed

zypper install typioca

Scoop

scoop bucket add extras
scoop install typioca

Void Linux

xbps-install typioca

Winget

winget install bloznelis.typioca

Building from source

  1. Checkout the code
  2. make build
  3. ./execs/typioca

Prerequisites

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" ]
    }
  2. Place your configuration to platform specific location:
Platform User configuration
Windows %APPDATA%\typioca\typioca.conf or C:\Users\%USER%\AppData\Roaming\typioca\typioca.conf
Linux $XDG_CONFIG_HOME/typioca/typioca.conf or $HOME/.config/typioca/typioca.conf
macOS $HOME/Library/Application Support/typioca/typioca.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.


1 3 2 4

Acknowledgments

Built with bubbletea

🧋