Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gltchitm/keyboard-cleaner

KeyboardCleaner is a macOS app for temporarily disabling input devices.
https://github.com/gltchitm/keyboard-cleaner

Last synced: about 2 months ago
JSON representation

KeyboardCleaner is a macOS app for temporarily disabling input devices.

Awesome Lists containing this project

README

        

# KeyboardCleaner
KeyboardCleaner is a macOS app for disabling your input devices temporarily — perfect for cleaning your keyboard without having to shut down!

## Usage
Once you start KeyboardCleaner, your screen will turn blank and display a message showing that the keyboard and mouse have been disabled. To re-enable them and close KeyboardCleaner, hold down right click for one second and release.

## Accessibility Access
If you are running KeyboardCleaner for the first time, you may need to grant it accessibility access. Usually, macOS will show a system dialog with instructions to do so. If it does not, go to System Preferences > Security & Privacy > Privacy > Accessibility and grant KeyboardCleaner access.

## Event Taps
KeyboardCleaner creates an event tap to disable input. If you are running software that detects (and possibly terminates) programs doing this, you might need to whitelist KeyboardCleaner.

## AutoKill
While working on KeyboardCleaner, you should keep the AutoKill script running in the background. To do so, run:
```
./util/auto-kill.sh
```
The script will check for the KeyboardCleaner process every 2 seconds and send `SIGKILL` if its running time exceeds the `` argument (seconds). This is useful to avoid needing to force restart your device if you make a change that prevents you from deactivating KeyboardCleaner normally.

## Note
This program does not automatically clean your keyboard. It only assists in the process of doing so.

## License
[MIT](LICENSE)