# Keycastr

KeyCastr, an open-source keystroke visualizer.

![preview](assets/preview.png)

![display preferences](assets/preferences.png)

## Download

 - [Download latest release](https://github.com/keycastr/keycastr/releases)

## Installation via [homebrew](http://brew.sh/) [cask](https://github.com/caskroom/homebrew-cask)

```console
brew cask install keycastr
```

## Accessibility API access

In order to work, KeyCastr must be included in the list of applications with Accessibility API access, under the Security & Privacy system preferences.

![accessibility](assets/accessibility.png)

To add KeyCastr to the list click the <kbd>&plus;</kbd> button and select KeyCastr from the file system.

## Position on Screen

The default position is on the bottom left of your display. To modify the position of displayed keystrokes, click and drag the text like so:

![reposition](assets/reposition.gif)

## History

 - [sdeken](https://github.com/sdeken/keycastr) wrote the original version.
 - [akitchen](https://github.com/akitchen/keycastr) fixes for more recent OS X releases and other maintenance.
 - [elia](https://github.com/elia/keycastr) created `keycastr` organization and forked into it.
 - [lqez](https://github.com/lqez/keycastr) added a new menu bar icon.


## License

[BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause)
