A hotkey aggregator. All your hotkeys in one place.
Project description
hag
A Hotkey AGgregator.
hag
is a hotkey aggregator, it tries its best to extract the hotkeys of your software and display them.
It does so by parsing the config files, man pages, command outputs, ... depending on the software.
Hotkey parsers
Bellow is a list of implemented hotkey parsers:
- Alacritty
- Lf
- Mpv
- Neovim
- Qutebrowser
- Rofi
- Sxhkd
- Sxiv
- Termite
- Vim
- Vimiv
- Zathura
- Zsh
Installation
hag
is meant to be relatively minimal, as such it doesn't have any dependencies.
pip install hag
If you just want to use the CLI interface, consider using pipx
.
pipx install hag
Usage
$ hag -h
usage: hag [-h] [-lp | -ld] [-d {json,text}] [-m MODE] [-v]
[{alacritty,lf,mpv,neovim,qutebrowser,rofi,sxhkd,sxiv,termite,vim,vimiv,zathura,zsh}]
Hotkey aggregator. All your hotkeys in one place.
positional arguments:
{alacritty,lf,mpv,neovim,qutebrowser,rofi,sxhkd,sxiv,termite,vim,vimiv,zathura,zsh}
Extract hotkeys using parser.
optional arguments:
-h, --help show this help message and exit
-lp, --list-parsers List available hotkey parsers.
-ld, --list-displays List available display methods.
-d {json,text}, --display {json,text}
Display method.
-m MODE, --modes MODE
Filter by mode, if supported by parser.
-v, --version Show hag version and exit.
Examples
A few example uses:
- List
sxhkd
hotkeys:hag sxhkd
- Display
sxhkd
hotkeys in json format and format withjq
:hag sxhkd -d json | jq
- Show
vim
Normal and Visual mode hotkeys inrofi
:hag vim -m Normal -m Visual | rofi -dmenu
- Use
rofi
to select hotkey parser and show hotkeys:parser="$(hag -le | rofi -dmenu)" && hag "$parser" | rofi -dmenu
Contributing
If you want to add support for your favourite software, feel free to open issues/PRs!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
hag-0.2.3.tar.gz
(11.1 kB
view hashes)
Built Distribution
hag-0.2.3-py3-none-any.whl
(17.2 kB
view hashes)