Repository: mulaRahul/keyviz
Stars: 9193
README.md
Keyviz
<div>
<img src="https://img.shields.io/github/v/release/mulaRahul/keyviz?style=flat-square" alt="Releases">
<img src="https://img.shields.io/github/downloads/mulaRahul/keyviz/total?style=flat-square" alt="Downloads">
<img src="https://img.shields.io/github/stars/mulaRahul/keyviz?style=flat-square" alt="Stars">
<img src="https://img.shields.io/github/license/mulaRahul/keyviz?style=flat-square" alt="License">
<img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS-lightgrey?style=flat-square" alt="Platform Support">
</div>
Keyviz is a free and open-source tool that visualizes your keypresses and mouse actions in real-time. Let your audience know what handy shortcuts you're pressing during tutorials, presentations, collaborations, or whenever you need.
⌨️ Keypress & 🖱️ Mouse Actions
Along with normal keys, you can also visualize mouse actions like <kbd>Cmd</kbd> + <kbd>Click</kbd>, <kbd>Alt</kbd> + <kbd>Drag</kbd>, etc.
<img src="previews/visualization.png" alt="Keystroke Visualization" width="450">
Display mouse clicks and scroll wheel movements alongside your cursor.
<img src="previews/mouse-indicator.gif" alt="Mouse Indicator" width="450">
</br>
⚙️ Full Customization
Don't settle for defaults. Every aspect of the visualization is under your control:
- Styling: Change colors (modifier vs. regular keys), size, layout, border, and background.
- Filtering: Control which keys are shown using hotkey or custom filters.
- History: Keep a visual trail of your recent inputs.
- Position: Move the visualization to any part of your screen.
- Animations: Customize how inputs appear and disappear with preset entry and exit animations.
</br>
<img src="previews/settings.png" alt="Settings Panel" width="600">
</br>
📥 Installation
Windows & macOS
You can download the latest version of Keyviz from the GitHub Releases page.
* Windows: Download the .msi installer, run it, and follow the steps.
* macOS: Download the .dmg.
Note: Keyviz requires Input Monitoring and Accessibility permissions. Enable them here:
Settings > Privacy & Security > Input Monitoring & Accessibility
Linux (x11)
Keyviz is compatible with Linux using the X11 protocol. Currently, you can try it out by following the build instructions below.
</br>
🛠️ Build Instructions
If you want to contribute or build the latest features from the source, ensure you have Node.js and Tauri set up on your system.
1. Clone the repository:
git clone https://github.com/mulaRahul/keyviz.git
cd keyviz2. Install dependencies:
npm install3. Build the executable:
npx tauri build<br/>
💖 Support the Project
* Star the Repo: It helps others discover the project!
* GitHub Sponsors: Sponsor @mularahul
* Keyviz Pro: Get access to exclusive features while supporting the development of this open-source project.
👉 Upgrade to Pro at keyviz.org/pro
</br>
---
Built with 🦀 and ❤️ using <a href="https://v2.tauri.app/">Tauri</a>.