{"id":13616361,"url":"https://github.com/maaslalani/typer","last_synced_at":"2025-04-04T18:08:40.442Z","repository":{"id":37762534,"uuid":"347547386","full_name":"maaslalani/typer","owner":"maaslalani","description":"Typing test in your terminal","archived":false,"fork":false,"pushed_at":"2024-05-25T17:30:49.000Z","size":2911,"stargazers_count":481,"open_issues_count":4,"forks_count":26,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-28T17:08:53.372Z","etag":null,"topics":["cli","terminal","typing"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maaslalani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2021-03-14T04:55:18.000Z","updated_at":"2025-03-14T00:29:41.000Z","dependencies_parsed_at":"2024-04-09T18:55:29.938Z","dependency_job_id":"d0e430bf-ff0b-4fa6-b6f9-554c2e7c91b2","html_url":"https://github.com/maaslalani/typer","commit_stats":{"total_commits":56,"total_committers":10,"mean_commits":5.6,"dds":0.375,"last_synced_commit":"0e674b236154b05f89fb4f5bee20c7269fd71477"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maaslalani%2Ftyper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maaslalani%2Ftyper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maaslalani%2Ftyper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maaslalani%2Ftyper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maaslalani","download_url":"https://codeload.github.com/maaslalani/typer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226215,"owners_count":20904465,"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":["cli","terminal","typing"],"created_at":"2024-08-01T20:01:27.485Z","updated_at":"2025-04-04T18:08:40.413Z","avatar_url":"https://github.com/maaslalani.png","language":"Go","funding_links":[],"categories":["Go","CLI/TUI Apps","Applications"],"sub_categories":["Other","Games"],"readme":"# Typer\n\nTyping test in your terminal\n\n![Typer Banner](../assets/banner.png)\n\n### Installation\n\nTo just install `typer` simply use this command:\n```\ngo install github.com/maaslalani/typer@latest\n```\n\n### Usage\nTo begin a typing test simply type `typer`. This will generate random words for you to type and show you your WPM score.\n```\ntyper\n```\n\nTo change the length of the typing test, use the `--length` flag.\n```\ntyper -l 20\n```\n\nTo set min word length, you can use `--min-word-length` flag.\n```\ntyper --min-word-length 5\n```\nThere is no maximum value, but anything below 1 will count as no min length.\n\nYou can use Monkeytype as a source of words, just pass `-m, --monkeytype` flag,\nby default it'll use `english` dictionary, you can change that by adding `--monkeytype-language string` flag.\n```\ntyper -m --monkeytype-language code_go\n```\nsee: [monkeytype/languages/_list.json](https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/languages/_list.json)\n\nIf you want to provide your own text, you can pass in a file name with the `--file` flag. The typing test will use the contents of the specified file.\n```\ntyper -f filename.txt\n```\n\nYou can also pipe data by `stdin`.\n```\necho 'Text from stdin!' | typer\n```\n\n### Themes\n\nThere is basic theme support, theme should be saved in config file (default `$HOME/.typer.yaml`) and should look similar to this default theme:\n\n```yaml\ntheme:\n  #file: /an/absoulute/path/to/the/theme.yaml # if set, it will ignore everything below\n  bar:\n    color: '#4776E6' # basic color of the progressbar\n    #gradient: '#ff0000' # if passed, will generate a gradient from previous color to this one\n  graph:\n    # see: https://pkg.go.dev/github.com/guptarohit/asciigraph#AnsiColor\n    # see: https://github.com/guptarohit/asciigraph/blob/master/color.go#L152-L292\n    color: blue # does not use rgb but rather ANSI codes\n    height: 3   # height of the graph\n  text:\n    error: # color when misspelled\n      background: '#f33'\n      foreground: '#fff'\n    typed: # color when character have been typed\n      foreground: '#fff'\n      #background: '#000' # optional, default theme does not add background\n    untyped: # color when still haven't been typed\n      foreground: '#555'\n      #background: '#000' # optional, default theme does not add background\n\n```\n\n### Demo\n![typer](../assets/typer.png?raw=true)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaaslalani%2Ftyper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaaslalani%2Ftyper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaaslalani%2Ftyper/lists"}