Skip to content

yuran1811/yukey

Repository files navigation

yukey

A minimal, blazing fast Tauri application record the key you're typing.

Stars Forks Issues Commits Code Size

Introduction

yukey is an open source keystroke visualizer that enables you to share your keystroke and mouse click actions for presenting, recording, or collaborating with others.

Features

  • Record the key you're typing
  • Record the mouse button you've clicked
  • Pin/Unpin the app to/from the top of the screen
  • Minmize to tray
  • Theme UI changing
  • Setting panel

Tech Stack

Screenshots

Installation

Download the latest release

Development

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed or downloaded on your machine:

Cloning the Repository

git clone https://github.com/yuran1811/yukey.git
cd yukey

Installation

  • Enable pnpm to build and run the project
corepack enable pnpm

Install the project dependencies:

pnpm install

Running the Project

pnpm tauri dev

Open http://localhost:5173 in your browser to view the project.

See more about developing

References

License

BSD 3-Clause

yukey has been freely available for Linux, MacOS and Windows since 2025.