https://github.com/maledorak/dmenu-hotkeys
View for your hotkeys in rofi/dmenu style
https://github.com/maledorak/dmenu-hotkeys
bspwm dmenu hotkeys i3 openbox python rofi tiling-window-manager
Last synced: about 16 hours ago
JSON representation
View for your hotkeys in rofi/dmenu style
- Host: GitHub
- URL: https://github.com/maledorak/dmenu-hotkeys
- Owner: maledorak
- License: mit
- Created: 2019-03-08T21:12:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T20:47:09.000Z (almost 3 years ago)
- Last Synced: 2025-09-05T07:37:06.986Z (30 days ago)
- Topics: bspwm, dmenu, hotkeys, i3, openbox, python, rofi, tiling-window-manager
- Language: Python
- Homepage:
- Size: 188 KB
- Stars: 62
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
dmenu-hotkeys
=============
[](https://pypi.python.org/pypi/dmenu_hotkeys)
[](https://travis-ci.org/maledorak/dmenu-hotkeys)
[](https://codecov.io/gh/maledorak/dmenu-hotkeys)
[](https://dmenu-hotkeys.readthedocs.io/en/latest/?badge=latest)
Your hotkeys for various apps in 'dmenu' style.
Features
--------
This app allows you to prepare cheat sheet of hotkeys from your apps in simple menu with search.
Supported
---------
### Menus
* [dmenu](https://tools.suckless.org/dmenu/)
* [rofi](https://github.com/davatorium/rofi)
### Apps
* [bspwm](https://github.com/baskerville/bspwm)
* [i3](https://i3wm.org/)
* [openbox](http://openbox.org/wiki/Main_Page)
Requirements
------------
This app needs below apps as a GUI, so install one of these first.
* dmenu
* rofi
Install
-------
### From pip
This app works on Python 2.7, 3.4, 3.5, 3.6, 3.7, so the best choice is installation using pip
```
pip install --user dmenu-hotkeys
```
then you could run it by typing in console
```
dmenu_hotkeys
```
### From git repo
Clone repository
```
git clone git@github.com:maledorak/dmenu-hotkeys.git .
```
and run script in bin dir like this
```
./dmenu-hotkeys/bin/dmenu_hotkeys
```
How to use
----------
### Run menu with hotkeys
1. Add the following comment line before hotkey line which you want to use in your app config file.
eg:
* bspwm: `# %%hotkey: Some description of the following hotkey %%`
* i3: `# %%hotkey: Some description of the following hotkey %%`
* openbox: `<-- %%hotkey: Some description of the following hotkey %% -->`
Notice: For full configuration file examples check [test/fixtures](./tests/fixtures) directory
2. Run the dmenu-hotkeys
```
dmenu_hotkeys run --menu [dmenu|rofi] --app [bspwm|i3|openbox]
```
3. Check help if you want to know more
```
dmenu_hotkeys run --help
```
### Override dmenu-hotkeys configuration file
If you want to change default configuration paths for apps (i3, openbox, etc)
you should override dmenu-hotkeys config file.
```
dmenu_hotkeys copy-config
```
The default path for the overridden configuration file is
```
$HOME/.config/dmenu_hotkeys/config.cfg
```
You could change it
```
dmenu_hotkeys copy-config --dest some/path/config.cfg
```
But since then you always should run dmenu-hotkeys with this new path
```
dmenu_hotkeys run --menu [dmenu|rofi] --app [i3|openbox] --config-path some/path/config.cfg
```