Skip to content

d7omdev/keyvis

Repository files navigation

KeyVis

A lightweight tool for visualizing keystrokes in a clean GTK window. Built using GJS with GObject and Gtk libraries, it provides a simple, responsive way to display keyboard inputs in real-time.

KeyVis Screenshot

Features

  • Monitors key events and displays them in a window
  • Supports visualizing multiple simultaneous key presses
  • Automatically hides the window after a configurable timeout

Installation

Prerequisites

  • GJS (GObject JavaScript) runtime environment
  • GTK 4 library
  • The keyd utility for capturing keyboard events
  • Bun for building the application

Install from AUR

KeyVis is available in the Arch User Repository (AUR). You can install it using an AUR helper like yay or paru:

yay -S keyvis

Manual Installation

If you prefer to install KeyVis manually, follow these steps:

Step 1: Clone the Repository

git clone https://github.com/d7omdev/keyvis
cd keyvis

Step 2: Make the Installation Script Executable

Before running the installation script, ensure it is executable:

chmod +x install.sh

Step 3: Run the Installation script

./install.sh

This script will:

  • Create necessary directories.
  • Build the application.
  • Copy the compiled JavaScript file to the appropriate location.
  • Create an executable script for running KeyVis.

Usage

Running KeyVis

You can run KeyVis using the following command:

keyvis

Killing KeyVis

To kill an existing instance of KeyVis, you can use:

keyvis --kill # or -k

This command will find and terminate any running instance of KeyVis.

Command-Line Options

Use --help to display the available command-line options:

keyvis --help

Uninstallation

To uninstall KeyVis, run the uninstall script

./uninstall.sh

Contributions

Contributions and feedback are welcome! If you encounter any issues or have suggestions for improvements, please submit an issue or create a pull request.

License

This project is licensed under the MIT License.