https://github.com/harentius/grammifyai

AI grammar checker for macOS that works with any application and with any language.
https://github.com/harentius/grammifyai

grammar grammar-checker macos openai swift

Last synced: 2 months ago
JSON representation

AI grammar checker for macOS that works with any application and with any language.

• Host: GitHub
• URL: https://github.com/harentius/grammifyai
• Owner: harentius
• License: mit
• Created: 2024-08-11T12:57:21.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-25T10:10:23.000Z (4 months ago)
• Last Synced: 2024-10-03T07:09:10.722Z (3 months ago)
• Topics: grammar, grammar-checker, macos, openai, swift
• Language: Swift
• Homepage: https://harentius.github.io/GrammifyAI/
• Size: 528 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GrammifyAI

AI grammar checker for macOS that works with any application and with any language.

The usage of GrammifyAI is as simple as selecting the text and pressing a shortcut (⌘ + U or custom).  

This will bring you the improvement suggestion popup and will copy the suggestion to the clipboard.

Thanks to the macOS accessibility API, GrammifyAI can work with text in any **web** or **native** application.  

Thanks to **OpenAI**, GrammifyAI also improves your writting and language style.  



GrammifyAI utilizes your OpenAI API key, so there are no quotas or limits from the GrammifyAI side. Usage will be according to OpenAI's billing.

## Installation

  1. Download the latest [release](https://github.com/harentius/GrammifyAI/releases) and move it to the Applications folder on your Mac.

  2. To run the application, right-click on the GrammifyAI app name and select "Open," then grant permission to open it.

  3. To add accessibility permissions for the application, open "System Settings," navigate to "Privacy & Security," select "Accessibility," and add GrammifyAI to the list.

  4. Add your OpenAI API key in the GrammifyAI settings.

  5. Select the text in any application and press ⌘ + U or your custom shortcut.

## Update

  1. After installing a new version, you must remove GrammifyAI from Accessibility permissions and grant them again.

  2. You may need to perform step 2 of the installation process again.

## Usage

  1. Select the text you want to enhance.

  2. Press ⌘ + U or your custom combination if you have changed it.

  3. You may close the window if you want by pressing the cross symbol or ⌘ + W.

  4. You can insert the corrected text using ⌘ + V.

     

## Known successful use cases

I use the GrammifyAI application in *Slack*, *Chrome*, *Notion*, *Messenger*, and any standard web form.  

## Known limitations

  * It doesn't work in *Google Docs*

  * As it uses OpenAI API, suggestion on sensitive topics can differ from original meaning

## Demo

https://github.com/user-attachments/assets/0ce6d724-68ee-4fa7-a468-54584888e801

## Appendix

 1. **Motivation for implementing this applications**  

I am learning German, and it is challenging.  

My thinking patterns differ from those of typical native speakers.  

I am trying to receive feedback on my writing as quickly and easily as possible, so I have implemented a one-shortcut tool to check it.

I also want to understand corrections quickly, without long explanations from ChatGPT, and without the need to go to the ChatGPT window at all. 

There are great applications like Grammarly that do a similar job, but unfortunately, they only support English,  

and their AI capabilities can be a bit expensive and not as good as OpenAI or ChatGPT.  

2. Your OpenAI API key is used solely to connect with OpenAI for the purpose of GrammifyAI functionality and is not shared with anyone else.  

Feel free to review the code and build the app on your machine if you have any concerns. ;)  

It is stored locally on your device in an unencrypted manner, so use it at your own risk.