PlankCipher Et Save

A CLI/rofi/dmenu script with various features to aid you with English (spellchecking, definitions, synonyms, antonyms, abbreviations, and pronunciation)

Project README

et

Buy Me a Coffee at ko-fi.com

A CLI/rofi/dmenu script with features to aid you with English.

Preview

rofi_et

rofi_et

dmenu_et

dmenu_et

Features

  • Spellcheck and suggestions (offline, based on a wordlist)
  • Define (online, based on wordnik.com)
  • Synonyms (online, based on bighugelabs.com)
  • Antonyms (online, based on bighugelabs.com)
  • Abbreviations (online, based on Abbreviations.com)
  • Pronunciation (online, based on macmillandictionary.com)

Dependencies

The installation script won't install the dependencies for you because I don't know the package names on distros other than Arch

  • rofi or dmenu
  • xclip from the xclip package (X) or wl-copy from the wl-clipboard (Wayland) package on Arch => to copy selected spelling suggestion to clipboard
  • notify-send from libnotify package on Arch => to notify you on copying a spelling suggestion to clipboard
  • agrep from tre package on Arch => to do fuzzy searching in the wordlist to get spelling suggestions
  • sox from sox package on Arch => to play pronunciation

Installation

  1. clone this repo => git clone https://github.com/PlankCipher/et.git
  2. cd into the cloned repo directory
  3. run install.sh => ./install.sh
  4. Voila 🎉

You will be asked to enter your password for sudo to move the executables to /sbin/ so that they're accessible from anywhere

Included

  • et (simple underlying cli tool, run et -h for help)
  • rofi_et (a rofi menu for et, run rofi_et then help for help)
  • rofi_et_mode (a rofi custom mode for et, run rofi -modes 'et:rofi_et_mode,drun,window' -show et then help for help)
  • dmenu_et (a dmenu script for et, run dmenu_et and then help for help)

Usage

et

Usage: et OPTION [WORD]

Options:
  -abr or --abbreviations
    print what WORD might stand for from abbreviations.com. (WORD is required for this option)

  -ant or --antonyms
    print antonyms for WORD from bighugelabs.com. (WORD is required for this option)

  -def or --define
    print definitions for WORD from wordnik.com if correctly spelled, otherwise print spell suggestions. (WORD is required for this option)

  -pro or --pronounce
    play American English pronunciation of WORD from macmillandictionary.com. (WORD is required for this option)

  -spl or --spell
    print spell suggestions for WORD from wordlist if not spelled correctly (exits with 1 as exit code), otherwise print a message indicating that WORD is spelled correctly. (WORD is required for this option)

  -syn or --synonyms
    print synonyms for WORD from bighugelabs.com. (WORD is required for this option)

  -h or --help
    print this help message and exit

rofi_et, rofi_et_mode, or dmenu_et

usage

Credits

Contributions

Contributions are very welcome.

Open Source Agenda is not affiliated with "PlankCipher Et" Project. README Source: PlankCipher/et
Stars
42
Open Issues
1
Last Commit
1 week ago
Repository
License

Open Source Agenda Badge

Open Source Agenda Rating