base on A TUI tool to help you type faster and learn new layouts. Includes a free cat. # ngrrram `ngrrram` is a CLI tool to practice typing ngrams (`n` adjacent symbols in particular order) to improve your typing speed and/or learn new keyboard layouts effectively.  Certain letter combination occur a lot more often than others, thus practicing these in particular makes sense. This type of practice is often recommended for example by [Ben Vallack](https://www.youtube.com/watch?v=sI-a64EVPPU) and Josh Kaufman, who [learned Colemak in just 20 hours](https://first20hours.com) making strong use of ngrams. There already exists a good tool for this type of practice called [ngram-type](https://github.com/ranelpadon/ngram-type). This tool is *heavily* inspired by `ngram-type` and I want to thank Ranel Padon for creating it. However, ngram-type does not support emulating different keyboard layouts, which I found important so I would not have to switch my whole system to a layout I was still learning. Also, some people might prefer local/offline CLI based solutions over web based ones. ## Installation ### Releases Precompiled [releases](https://github.com/wintermute-cell/ngrrram/releases) for linux, windows and macos are available. ### AUR (maintained by [JinEnMok](https://github.com/JinEnMok)) Use `yay` or any other AUR helper to install for an Archlinux system: ```bash yay -S ngrrram-git or yay -S ngrrram-bin ``` ### From Source Make sure you have the rust tooling installed, then simply run: ```bash cargo build --release ``` The executable will then be located at `./target/release/ngrrram` ### Looking for help packaging! If you'd like to help by packaging for your platform, I'd gladly accept! ## Usage `ngrrram` is not very complex. It offers a few customization options as command flags, but starts with the recommended defaults if unconfigured. Options: ``` Usage: ngrrram [OPTIONS] Options: -n, --n <2|3|4|w|file> use bi-(2), tri-(3), tetragrams(4), (w)ords or comma separated wordlist file. [default: 2] -t, --top <1-200> use the top X ngrams ordered by usage. [default: 50] -c, --combi <1-200> how many different ngrams to use in a single lesson. [default: 2] -r, --rep <number> how often to repeat *each* different ngram in a lesson. [default: 3] -w, --wpm <number> the wpm threshold at which the lesson is considered a success. [default: 40] -a, --acc <0-100> the accuracy in percent at which the lesson is considered a success. [default: 94] --emu-in <layout> your current keyboard layout. only needed if you want to emulate a different layout. see docs for supported layouts. [default: ] --emu-out <layout> the layout you want to emulate. only needed if you want to emulate a different layout. see docs for supported layouts. [default: ] --show-ortho show keyboard in ortholinear format --nokb pass this flag to disable the keyboard layout display. --cat the most important flag. don't practice alone. -h, --help Print help ``` If you start `ngrrram` without parameters, it uses these recommended defaults: ```bash ngrrram --n 2 --top 50 --combi 2 --rep 3 --wpm 40 --acc 100 ``` ## Layout Emulation To emulate a different keyboard layout in `ngrrram`, you must pass the flags `--emu-in` and `--emu-out`, the first one describing your current layout, and the second one being the one you want to emulate. Available layouts are: - `qwerty` (Qwerty) - `qwertz` (Qwertz) - `azerty` (Azerty) - `dvorak` (Dvorak) - `colemak` (Colemak) - `colemakdh` (ColemakDH) > Having to provide an input layout is sub-optimal. I'm not sure how to get > layout independent scancodes in rust; Could not get `device_query` to work. > If you know a solution, please tell me. ## Random Notes - The WPM timer for each lesson only starts once you type the first letter of that lesson; no need to stress. - Every 5 non-space characters are considered a "word" for the WPM calculation. Otherwise WPM would unnaturally skyrocket with smaller ngrams. ", Assign "at most 3 tags" to the expected json: {"id":"10416","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"