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: about 2 months 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 (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-17T21:36:51.000Z (5 months ago)
• Last Synced: 2024-06-08T19:32:30.397Z (3 months ago)
• Topics: hotkey-daemons, hotkeys, keyboard-shortcuts, rust, windows
• Language: Rust
• Homepage:
• Size: 43.9 KB
• Stars: 387
• Watchers: 6
• Forks: 11
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-github-stars - LGUG2Z/whkd - A simple hotkey daemon for Windows (Rust)
• awesome-rainmana - LGUG2Z/whkd - A simple hotkey daemon for Windows (Rust)

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

alt + n [

    # ProcessName as shown by `Get-Process`

    Firefox       : echo "hello firefox"

    

    # Spaces are fine, no quotes required

    Google Chrome : echo "hello chrome"

]

# reload configuration

alt + o : taskkill /f /im whkd.exe && Start-Process whkd -WindowStyle hidden

# app shortcuts

alt + f : if ($wshell.AppActivate('Firefox') -eq $False) { start firefox }

# focus windows with komorebi

alt + h : komorebic focus left

alt + j : komorebic focus down

alt + k : komorebic focus up

alt + l : komorebic focus right

```