{"id":13897733,"url":"https://github.com/PlankCipher/et","last_synced_at":"2025-07-17T14:32:48.359Z","repository":{"id":114076877,"uuid":"362974521","full_name":"PlankCipher/et","owner":"PlankCipher","description":"A CLI/rofi/dmenu script with various features to aid you with English (spellchecking, definitions, synonyms, antonyms, abbreviations, and pronunciation)","archived":false,"fork":false,"pushed_at":"2024-06-05T01:18:35.000Z","size":26075,"stargazers_count":43,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-25T03:33:09.623Z","etag":null,"topics":["define","dmenu","dmenu-scripts","english","english-language","rofi","rofi-scripts","spellcheck"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/PlankCipher.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-04-29T23:38:37.000Z","updated_at":"2024-08-10T02:33:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"b1263214-6d1a-4183-a96b-c7849fc2f11b","html_url":"https://github.com/PlankCipher/et","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PlankCipher/et","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlankCipher%2Fet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlankCipher%2Fet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlankCipher%2Fet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlankCipher%2Fet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PlankCipher","download_url":"https://codeload.github.com/PlankCipher/et/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlankCipher%2Fet/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265616872,"owners_count":23798913,"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":["define","dmenu","dmenu-scripts","english","english-language","rofi","rofi-scripts","spellcheck"],"created_at":"2024-08-06T18:03:50.480Z","updated_at":"2025-07-17T14:32:47.526Z","avatar_url":"https://github.com/PlankCipher.png","language":"Shell","readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eet\u003c/h1\u003e\n\n  \u003ca href=\"https://ko-fi.com/Y8Y4HZ5S3\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://ko-fi.com/img/githubbutton_sm.svg\" alt=\"Buy Me a Coffee at ko-fi.com\" /\u003e\n  \u003c/a\u003e\n\n  \u003cbr\u003e\n  \u003cbr\u003e\n\nA CLI/rofi/dmenu script with features to aid you with English.\n\n\u003c/div\u003e\n\n## Preview\n\n### rofi_et\n\n![rofi_et](./assets/rofi_et.gif)\n\n### dmenu_et\n\n![dmenu_et](./assets/dmenu_et.gif)\n\n## Features\n\n- [x] Spellcheck and suggestions (offline, based on a wordlist)\n- [x] Define (online, based on [wordnik.com](https://wordnik.com))\n- [x] Synonyms (online, based on [bighugelabs.com](https://bighugelabs.com))\n- [x] Antonyms (online, based on [bighugelabs.com](https://bighugelabs.com))\n- [x] Abbreviations (online, based on [abbreviations.com](https://abbreviations.com))\n- [x] Pronunciation (online, based on [wordnik.com](https://wordnik.com) and [dictionaryapi.dev](https://dictionaryapi.dev))\n\n## Dependencies\n\n\u003e The installation script won't install the dependencies for you because I don't know the package names on distros other than Arch\n\n- `rofi` or `dmenu`\n- `xclip` from the `xclip` package (X) or `wl-copy` from the `wl-clipboard` (Wayland) package on Arch =\u003e to copy selected spelling suggestion to clipboard\n- `notify-send` from `libnotify` package on Arch =\u003e to notify you on copying a spelling suggestion to clipboard\n- `agrep` from `tre` package on Arch =\u003e to do fuzzy searching in the wordlist to get spelling suggestions\n- `sox` from `sox` package on Arch =\u003e to play pronunciation\n\n## Installation\n\n1. clone this repo =\u003e `git clone https://github.com/PlankCipher/et.git`\n2. cd into the cloned repo directory\n3. run `install.sh` =\u003e `./install.sh`\n4. Voila 🎉\n\n\u003e You will be asked to enter your password for sudo to move the executables to `/sbin/` so that they're accessible from anywhere\n\n## Included\n\n- et (simple underlying cli tool, run `et -h` for help)\n- rofi_et (a rofi menu for et, run `rofi_et` then `help` for help)\n- rofi_et_mode (a rofi custom mode for et, run `rofi -modes 'et:rofi_et_mode,drun,window' -show et` then `help` for help)\n- dmenu_et (a dmenu script for et, run `dmenu_et` and then `help` for help)\n\n## Usage\n\n### et\n\n```man\nUsage: et OPTION...\n\nOptions:\n  -abr, --abbreviations \u003cabr\u003e\n    Print what \u003cabr\u003e might stand for from abbreviations.com.\n\n  -ant, --antonyms \u003cword\u003e\n    Print antonyms for \u003cword\u003e from bighugelabs.com.\n\n  -def, --define \u003cword\u003e\n    Print definitions for \u003cword\u003e from wordnik.com if correctly spelled, otherwise print spell suggestions.\n\n  -pro, --pronounce \u003cword\u003e\n    Play pronunciation of \u003cword\u003e.\n\n    Defaults to American English pronunciation (listed as macmillan in sources list) from wordnik.com (which in turn depends on macmillandictionary). Other pronunciation sources/accents (from dictionaryapi.dev) can be listed with -lst|--list-sources and specified with -src|--source (must come after -pro|--pronounce).\n\n  -lst, --list-sources \u003cword\u003e\n    List available pronunciation sources/accents for \u003cword\u003e.\n\n  -src, --source \u003csource\u003e\n    Specify the \u003csource\u003e to use for pronunciation. This option must come after -pro|--pronounce.\n\n  -spl, --spell \u003cword\u003e\n    Print spell suggestions for \u003cword\u003e from wordlist if not spelled correctly (exits with 1 as exit code), otherwise print a message indicating that \u003cword\u003e is spelled correctly.\n\n  -syn, --synonyms \u003cword\u003e\n    Print synonyms for \u003cword\u003e from bighugelabs.com.\n\n  -h, --help\n    Print this help message and exit\n```\n\n### rofi_et, rofi_et_mode, or dmenu_et\n\n![usage](./assets/usage.png)\n\n## Credits\n\n- I got `words_alpha` wordlist from [this](https://github.com/dwyl/english-words) repo.\n- [wordnik.com](https://www.wordnik.com) is used to get definitions and pronunciations.\n- [abbreviations.com](https://www.abbreviations.com) is used to get what abbreviations stand for.\n- [bighugelabs.com](https://words.bighugelabs.com) is used to get synonyms and antonyms.\n- [dictionaryapi.dev](https://dictionaryapi.dev) is used to get pronunciations.\n\n## Contributions\n\nContributions are very welcome.\n","funding_links":["https://ko-fi.com/Y8Y4HZ5S3"],"categories":["Shell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPlankCipher%2Fet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPlankCipher%2Fet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPlankCipher%2Fet/lists"}