keycastr README

The project's README from github.com/keycastr/keycastr. As one markdown file: README.md.

KeyCastr

KeyCastr, an open source keystroke visualizer.

header image

KeyCastr enables you to share your keystrokes when creating screencasts, presenting, or collaborating with others. You can choose to display command keys, all modified keys, or all keystrokes, and there is also an option to include mouse clicks.

It is also possible to develop your own visualizer on top of KeyCastr -- pull requests are welcome!

display preferences

Installation

Download the latest release from GitHub

Or, install using homebrew

brew install --cask keycastr

Granting Permissions

KeyCastr requires your permission to receive events from macOS in order to broadcast your keystrokes and mouse clicks.

On newer versions of macOS (10.15+) there is an Input Monitoring menu under Security & Privacy within the System Preferences app, and KeyCastr will appear there automatically the first time you run it. Simply unlock this menu and check the box next to KeyCastr to enable it.

input_monitoring

On older versions of macOS, or if for some reason the app doesn't appear under the Input Monitoring menu (or if you want to pre-enable it) then you may manually add it to the list of apps in the Accessibility menu.

accessibility

To add KeyCastr to the list click the + button and select KeyCastr from the file system, or drag it in using Finder.

If KeyCastr is already in the list you can remove it with the − button and add it again in order to be certain that the right copy of the application is specified.

Troubleshooting permissions

There are two likely causes for the app seeming not to work:

  1. Not receiving keystroke events from macOS due to security settings
  2. The window being offscreen.

Sometimes switching from the Default to the Svelte visualizer can help you figure out which problem it is.

To troubleshoot, We recommend that you:

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

Security Concerns

Any application in the Accessibility or Input Monitoring sections of the Security & Privacy pane in macOS's Preferences.app is capable of receiving all your input events. We encourage you to inspect these lists carefully, remove applications which you don't believe need to monitor your input, and ask tough questions of the companies which produce the software you use.

KeyCastr is completely free and open source, and does not employ any networking mechanisms other than that included with the ubiquitous Sparkle framework for managing application updates. KeyCastr will never receive or display your passwords, so long as the website or application you are using treats password entry as secure, e.g. <input type="password"> or equivalent.

History and Credits

License

BSD 3-Clause

KeyCastr has been freely available for the Mac since 2009.

keycastr (keycastr/keycastr)

Searching Database…

15.2K ·GitHub
Keycastr
What is this?KeyCastr is an open-source keystroke visualizer for macOS that displays your keystrokes and mouse clicks on screen, useful for screencasts, presentations, or pair programming.
Is this a standalone app or a library I add to a project?It's a standalone macOS desktop app that sits as an overlay, not a library or plugin for another program.
Do I need to grant any special macOS permissions?Yes, you must enable KeyCastr under Input Monitoring (or Accessibility on older macOS) in Security & Privacy preferences so it can receive your keystroke events.
What should I do if it seems broken after install?Two common issues are macOS blocking event access due to permission settings, or the display window being offscreen; the README suggests quitting the app, removing and re-adding it under Input Monitoring, and restarting it.
Does it work on older macOS versions too, or only the newest?It supports both: on macOS 10.15+ you use the Input Monitoring panel, and on older versions you add it manually to the Accessibility list instead.
Is it safe to give KeyCastr input-monitoring access to my Mac?The README argues it's safe since KeyCastr is fully open source, doesn't use networking except for Sparkle's update checks, and will never display secure password fields.
Can I customize what gets shown, like just modifier keys versus all keystrokes?Yes, you can choose to display only command keys, all modified keys, or every keystroke, and optionally include mouse clicks too.
Can I move the keystroke display around on screen?Yes, by default it appears at the bottom left of the display, but you can click and drag the text to reposition it anywhere.
Can I build my own custom visualizer style for KeyCastr?Yes, the README explicitly invites developers to create their own visualizer on top of KeyCastr and welcomes pull requests for it.
How long has this project been around?KeyCastr has been freely available for Mac since 2009, originally written by sdeken and later maintained by several contributors.
What are similar projects?mac-mouse-fix, rumps, Mouser, codenotch, tendedero, dimble, forel, rooms
Which topics is it in?screen-recording, presentation, menu-bar, objective-c, macos-app, bsd, utility, productivity, gui, privacy, desktop-app, macos
Creator
keycastr
Size
60.1 MB
Stars
15.2K
Updated
CommitSep 07Releasev0.11.1Sep 07
Age
17y
Commits · 90 Days