Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lgug2z/whkd
A simple hotkey daemon for Windows
https://github.com/lgug2z/whkd
hotkey-daemons hotkeys keyboard-shortcuts rust windows
Last synced: 3 days ago
JSON representation
A simple hotkey daemon for Windows
- Host: GitHub
- URL: https://github.com/lgug2z/whkd
- Owner: LGUG2Z
- License: mit
- Created: 2023-01-20T22:19:42.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-24T17:57:58.000Z (12 days ago)
- Last Synced: 2025-01-26T04:03:49.768Z (11 days ago)
- Topics: hotkey-daemons, hotkeys, keyboard-shortcuts, rust, windows
- Language: Rust
- Homepage:
- Size: 57.6 KB
- Stars: 581
- Watchers: 7
- Forks: 16
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# whkd
_whkd_ is a simple hotkey daemon for Windows that reacts to input events by executing commands.
Its configuration file (`whkdrc`) is a series of bindings which define the associations between the input events and the commands.
By default, this file should be located in `~/.config/`, or an alternative can be set using the environment variable `WHKD_CONFIG_HOME`.
If you are compiling from the `master` branch, a `--config` flag is also available, which, when used, overrides
the `WHKD_CONFIG_HOME` environment variable. This flag will be made available in v0.1.3+.
The format of the configuration file (and this project itself) is heavily inspired by `skhd` and `sxhkd`.
## Example
```
.shell pwsh # can be one of cmd | pwsh | powershell
# Specify different behaviour depending on the app
# These "app : command" style bindings MUST come immediately below the .shell directive
alt + n [
# ProcessName as shown by `Get-Process`
Firefox : echo "hello firefox"
# Spaces are fine, no quotes required
Google Chrome : echo "hello chrome"
]
alt + q [
# Default is a keyword which will apply to all apps
# If you only have Default, this is the same as doing "alt + q : komorebic close"
Default : komorebic close
# Ignore is a keyword which will skip running the hotkey for the given process
Google Chrome : Ignore
]
# focus windows with komorebi
alt + h : komorebic focus left
alt + j : komorebic focus down
alt + k : komorebic focus up
alt + l : komorebic focus right
```