{"id":13607223,"url":"https://github.com/wintermute-cell/ngrrram","last_synced_at":"2025-05-15T13:07:00.938Z","repository":{"id":240931563,"uuid":"803824048","full_name":"wintermute-cell/ngrrram","owner":"wintermute-cell","description":"A TUI tool to help you type faster and learn new layouts. Includes a free cat.","archived":false,"fork":false,"pushed_at":"2024-11-22T21:14:41.000Z","size":2593,"stargazers_count":662,"open_issues_count":2,"forks_count":16,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-15T02:11:17.525Z","etag":null,"topics":["cat","cli","colemak","dvorak","layout","ngram","rust","touchtyping","tui","typing"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wintermute-cell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"winterveil_dev","buy_me_a_coffee":"winterv","custom":["https://www.paypal.me/winterveildev"]}},"created_at":"2024-05-21T12:56:45.000Z","updated_at":"2025-04-09T18:18:20.000Z","dependencies_parsed_at":"2024-05-21T14:01:31.306Z","dependency_job_id":"891b01fc-ce35-468d-aa5c-2692867d50ea","html_url":"https://github.com/wintermute-cell/ngrrram","commit_stats":null,"previous_names":["wintermute-cell/ngrrram"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintermute-cell%2Fngrrram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintermute-cell%2Fngrrram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintermute-cell%2Fngrrram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wintermute-cell%2Fngrrram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wintermute-cell","download_url":"https://codeload.github.com/wintermute-cell/ngrrram/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254346624,"owners_count":22055808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cat","cli","colemak","dvorak","layout","ngram","rust","touchtyping","tui","typing"],"created_at":"2024-08-01T19:01:16.689Z","updated_at":"2025-05-15T13:07:00.295Z","avatar_url":"https://github.com/wintermute-cell.png","language":"Rust","funding_links":["https://ko-fi.com/winterveil_dev","https://buymeacoffee.com/winterv","https://www.paypal.me/winterveildev"],"categories":["Rust"],"sub_categories":[],"readme":"# ngrrram\n\n`ngrrram` is a CLI tool to practice typing ngrams (`n` adjacent symbols in\nparticular order) to improve your typing speed and/or learn new keyboard\nlayouts effectively.\n\n![a showcase of the ngrrram ui](./.github/showcase.gif)\n\nCertain letter combination occur a lot more often than others, thus practicing\nthese in particular makes sense. This type of practice is often recommended for\nexample by [Ben Vallack](https://www.youtube.com/watch?v=sI-a64EVPPU) and Josh\nKaufman, who [learned Colemak in just 20 hours](https://first20hours.com)\nmaking strong use of ngrams.\n\nThere already exists a good tool for this type of practice called\n[ngram-type](https://github.com/ranelpadon/ngram-type). This tool is *heavily*\ninspired by `ngram-type` and I want to thank Ranel Padon for creating it.\n\nHowever, ngram-type does not support emulating different keyboard layouts,\nwhich I found important so I would not have to switch my whole system to a\nlayout I was still learning.\n\nAlso, some people might prefer local/offline CLI based solutions over web based\nones.\n\n## Installation\n\n### Releases\n\nPrecompiled [releases](https://github.com/wintermute-cell/ngrrram/releases) for\nlinux, windows and macos are available.\n\n### AUR (maintained by [JinEnMok](https://github.com/JinEnMok))\n\nUse `yay` or any other AUR helper to install for an Archlinux system:\n\n```bash\nyay -S ngrrram-git\nor\nyay -S ngrrram-bin\n```\n\n### From Source\n\nMake sure you have the rust tooling installed, then simply run:\n\n```bash\ncargo build --release\n```\n\nThe executable will then be located at `./target/release/ngrrram`\n\n### Looking for help packaging!\n\nIf you'd like to help by packaging for your platform, I'd gladly accept!\n\n## Usage\n\n`ngrrram` is not very complex. It offers a few customization options as command\nflags, but starts with the recommended defaults if unconfigured.\n\nOptions:\n```\nUsage: ngrrram [OPTIONS]\n\nOptions:\n  -n, --n \u003c2|3|4|w|file\u003e  use bi-(2), tri-(3), tetragrams(4), (w)ords or comma separated wordlist file. [default: 2]\n  -t, --top \u003c1-200\u003e       use the top X ngrams ordered by usage. [default: 50]\n  -c, --combi \u003c1-200\u003e     how many different ngrams to use in a single lesson. [default: 2]\n  -r, --rep \u003cnumber\u003e      how often to repeat *each* different ngram in a lesson. [default: 3]\n  -w, --wpm \u003cnumber\u003e      the wpm threshold at which the lesson is considered a success. [default: 40]\n  -a, --acc \u003c0-100\u003e       the accuracy in percent at which the lesson is considered a success. [default: 94]\n      --emu-in \u003clayout\u003e   your current keyboard layout. only needed if you want to emulate a different layout. see docs for supported layouts. [default: ]\n      --emu-out \u003clayout\u003e  the layout you want to emulate. only needed if you want to emulate a different layout. see docs for supported layouts. [default: ]\n      --show-ortho        show keyboard in ortholinear format\n      --nokb              pass this flag to disable the keyboard layout display.\n      --cat               the most important flag. don't practice alone.\n  -h, --help              Print help\n```\n\nIf you start `ngrrram` without parameters, it uses these recommended defaults:\n```bash\nngrrram --n 2 --top 50 --combi 2 --rep 3 --wpm 40 --acc 100\n```\n\n## Layout Emulation\n\nTo emulate a different keyboard layout in `ngrrram`, you must pass the flags\n`--emu-in` and `--emu-out`, the first one describing your current layout, and\nthe second one being the one you want to emulate.\n\nAvailable layouts are:\n\n- `qwerty`    (Qwerty)\n- `qwertz`    (Qwertz)\n- `azerty`    (Azerty)\n- `dvorak`    (Dvorak)\n- `colemak`   (Colemak)\n- `colemakdh` (ColemakDH)\n\n\u003e Having to provide an input layout is sub-optimal. I'm not sure how to get\n\u003e layout independent scancodes in rust; Could not get `device_query` to work.\n\u003e If you know a solution, please tell me.\n\n## Random Notes\n- The WPM timer for each lesson only starts once you type the first letter of\n  that lesson; no need to stress.\n- Every 5 non-space characters are considered a \"word\" for the WPM calculation.\n  Otherwise WPM would unnaturally skyrocket with smaller ngrams.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwintermute-cell%2Fngrrram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwintermute-cell%2Fngrrram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwintermute-cell%2Fngrrram/lists"}