https://github.com/callum-oakley/gotta-go-fast

A command line utility for practicing typing and measuring your WPM and accuracy.
https://github.com/callum-oakley/gotta-go-fast

Last synced: 14 days ago
JSON representation

A command line utility for practicing typing and measuring your WPM and accuracy.

• Host: GitHub
• URL: https://github.com/callum-oakley/gotta-go-fast
• Owner: callum-oakley
• License: bsd-3-clause
• Created: 2017-07-20T22:35:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T21:17:54.000Z (over 1 year ago)
• Last Synced: 2024-10-01T13:50:17.858Z (about 1 month ago)
• Language: Haskell
• Homepage:
• Size: 5.93 MB
• Stars: 277
• Watchers: 7
• Forks: 16
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gotta Go Fast

A command line utility for practicing typing and measuring your WPM and

accuracy. Written with [brick](https://github.com/jtdaugherty/brick).

## Installation

From source using [Stack](https://docs.haskellstack.org):

    $ stack install gotta-go-fast

Download binary (macOS):

    $ DEST=~/.local/bin/gotta-go-fast

    $ curl https://github.com/callum-oakley/gotta-go-fast/releases/download/0.3.0.6/macos -fLo $DEST

Where `DEST` is somewhere in your `PATH`.

## Usage

`gotta-go-fast` has three modes of operation. In all three modes, type through the presented text and then submit with ENTER. You **must** correct your mistakes before you can submit. Press ESC at any time to restart. Exit with CTRL-C.

### 1. Nonsense mode

Run with no file inputs, it will generate nonsense which is statistically similar to English text. Words appear in the nonsense with the same frequency that they appear in actual English. The length of the nonsense can be specified with `--nonsense-len` (`-l`) (in characters).

    $ gotta-go-fast -w 60

![screenshot](img/nonsense.png)

### 2. Chunk mode

Run with files to sample from, it will sample a random chunk from a random file as input. This works well for code or other text without a clear paragraph structure. Specify the height of the chunk in lines with `--height` (`-h`).

    $ gotta-go-fast src/*

![screenshot](img/chunk.png)

### 3. Paragraph mode

Run with files to sample from, and `--paragraph` (`-p`), it will sample a random paragraph (empty line delimited) from a random file. This works well for prose such as Project Gutenberg books. Reflow text to the target width with `--reflow` (`-r`). Specify the maximum and minimum length for a paragraph with `--max-paragraph-len` and `--min-paragraph-len` (in characters).

    $ gotta-go-fast -prw 60 README.md

![screenshot](img/paragraph.png)

In all three modes the width of the text can be set with `--width` (`-w`), the tab width can be set with `--tab` (`-t`) and the colour of empty (not yet typed) text and of errors can be set with `--fg-empty` and `--fg-error` (ANSI colour codes).

Run with `--help` for details.