wkey

wkey.mp4

wkey is a terminal-first cheatsheet for keyboard shortcuts and working notes.

It combines:

• a TUI for browsing shortcuts and notes
• plain-text configuration files built on TOML
• CLI commands for managing groups, shortcuts, and notes
• JSON output for automation
• optional fzf preselection before opening the TUI

wkey keeps the workflow simple: your data lives in files, the UI runs in the terminal, and the CLI stays scriptable.

Installation

Install via script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/greasycat/wkey/releases/download/v0.1.0/wkey-installer.sh | sh

Install via AUR for archlinux user

yay -S wkey

Build from source:

cargo build --release

Install from this repository:

cargo install --path .

Runtime notes:

• a terminal with standard ANSI support is required
• fzf is optional but highly recommended.
• if fzf is missing, wkey --search falls back to an internal selector

Quick Start

Initialize the default config:

wkey init --yes

Add a shortcut:

wkey shortcut create --group shell copy --key Ctrl+C --desc "Copy selection"

Add a note:

wkey note create --group shell prompt-tip --desc "Use !! to repeat the previous command"

Open the TUI:

wkey

Open the TUI after preselecting an item:

wkey --search

More Docs

• Getting started
• Configuration
• TUI guide
• CLI reference
• Development

License

wkey is released under the terms of the MIT License.