keyb

keyb

Create and view your own custom hotkey cheatsheet in the terminal

Features

• Lightweight and quick
• Fully customizable
• Fuzzy filtering
• Vim key bindings
• Export to stdout for fzf, rofi support

Non-Features

keyb does not support:

• Auto detection of hotkeys
• Command selection

Motivation

I had trouble remembering the various hotkeys that I sometimes use. It got annoying to look them up so I resorted to writing them down on a paper cheatsheet. Then, I thought: maybe there's a tool that does this better. I didn't find one I liked so I built keyb.

With keyb, I can list:

• Hotkeys that I occasionally forget or am new to
• Custom key combinations that I defined for my own workflow
• Short commands that I sometimes use

It is best used as a popup cheatsheet.

Install

keyb supports Linux, MacOS and Windows.

Compiled Binary

Download a compiled binary from the releases page.

Install with Go

$ go install github.com/kencx/keyb@latest

Build from source

$ git clone https://github.com/kencx/keyb
$ cd keyb
$ make build

Usage

usage: keyb [options] [file]

Flags:
  -p, --print           Print to stdout
  -e, --export [file]   Export to file
  -k, --key [file]      Pass custom hotkeys file
  -c, --config [file]   Pass custom config file
  -v, --version         Version info
  -h, --help            help for keyb

Printing

keyb supports printing to stdout for use with other tools:

$ keyb -p | fzf
$ keyb -p | rofi -dmenu

Search

• Enter search mode with / to perform fuzzy filtering on all rows
• Exit search mode again with Esc
• Alt + d clears the current filter

To perform filtering on section headings only, prefix the search with h:. This will return all matching section headings with their respective rows.

keyb File

keyb requires a yaml file with a list of hotkeys to work. A default file is generated in your system's config directory if no other file is specified.

Hotkeys are classified into sections with a name and (optional) prefix field. When displayed, sections are sorted by alphabetical order while the keys themselves are arranged in their defined order.

- name: bspwm
  keybinds:
    - name: terminal
      key: Super + Return

The prefix is a key combination that will be prepended to every hotkey in the section. A key can choose to opt out by including a ignore_prefix: true field. Prefixes are useful for applications with a common leading hotkey like tmux.

- name: tmux
  prefix: ctrl + b
  keybinds:
    - name: Create new window
      key: c
    - name: Prev, next window
      key: Shift + {←, →}
      ignore_prefix: true

Refer to the examples for more examples.

Multiline fields are not supported at the moment.

Configuration

keyb is customized with a config.yml file that is automatically generated in the system's config directory.

By default, the following options are included.

OS-specific keyb directory path:

• Unix: $XDG_CONFIG_HOME/keyb/keyb.yml,
• MacOS or Darwin: $HOME/Library/Application Support/keyb/keyb.yml,
• Windows: %Appdata%\keyb\keyb.yml

Color

Both ANSI and hex color codes are supported.

Hotkeys

Multiple keys may be set for a single binding, separated by commas.

Roadmap

• Ability to customize keyb hotkeys
• Export to additional file formats (json, toml, conf/ini etc.)
• -a, --add flag to quickly add a single hotkey entry from the CLI
• Automatic parsing from online cheatsheet repos (eg. cheat/cheatsheets)

Contributing

keyb requires Go 1.18.

Bug reports, feature requests and PRs are very welcome.

More examples for default keymaps in examples/ are also welcome.

Screenshots

Similar Tools

• showkeys offers a keybinding popup similar to awesomewm
• cheat is a CLI alternative to view cheatsheets for commands and hotkeys for just about any topic
• Refer to shortcut-pages, cheat/cheatsheets for more cheatsheets

License

MIT