Skip to content

new-er/keyboard-cheatsheet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

keyboard-cheatsheet

A small Go CLI tool that prints a live keyboard cheatsheet in your terminal. It watches your current key presses and active window (via showmethekey and hyprctl) and prioritizes relevant shortcuts, so you always see what matters right now.

Features

  • Shows active keyboard shortcuts based on current keys and application
  • Orders shortcuts by context using showmethekey and hyprctl
  • Works in Hyprland Wayland environments
  • Lightweight terminal UI

Prerequisites

Before installing, make sure you have:

Installation

You can install the latest release with:

go install github.com/new-er/keyboard-cheatsheet@latest

Usage

keyboard-cheatsheet

Customization

Key mapping

You can change how key codes map to key names by editing keymap.json.

Shortcuts

You can define or adjust shortcuts in shortcuts.json.

This lets you personalize the cheatsheet to your workflow.

Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request.

About

A lightweight Go TUI that displays a live, context-aware keyboard cheatsheet in your terminal by watching your key presses and active application.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages