Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waycrate/swhkd
Sxhkd clone for Wayland (works on TTY and X11 too)
https://github.com/waycrate/swhkd
hotkey hotkey-client hotkey-daemons hotkey-functionality hotkey-server hotkeys linux linux-app rust rust-application rust-apps rust-lang rust-language
Last synced: about 10 hours ago
JSON representation
Sxhkd clone for Wayland (works on TTY and X11 too)
- Host: GitHub
- URL: https://github.com/waycrate/swhkd
- Owner: waycrate
- License: bsd-2-clause
- Created: 2021-12-09T07:15:55.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-21T05:07:14.000Z (4 days ago)
- Last Synced: 2025-01-22T09:02:29.255Z (3 days ago)
- Topics: hotkey, hotkey-client, hotkey-daemons, hotkey-functionality, hotkey-server, hotkeys, linux, linux-app, rust, rust-application, rust-apps, rust-lang, rust-language
- Language: Rust
- Homepage: https://git.sr.ht/~shinyzenith/swhkd
- Size: 5.64 MB
- Stars: 724
- Watchers: 11
- Forks: 53
- Open Issues: 86
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A next-generation hotkey daemon for Wayland/X11 written in Rust.
## SWHKD
**S**imple **W**ayland **H**ot**K**ey **D**aemon
`swhkd` is a display protocol-independent hotkey daemon made in
[Rust](https://www.rust-lang.org). `swhkd` uses an easy-to-use configuration
system inspired by `sxhkd`, so you can easily add or remove hotkeys.
It also attempts to be a drop-in replacement for `sxhkd`, meaning your `sxhkd`
config file is also compatible with `swhkd`.
Because `swhkd` can be used anywhere, the same `swhkd` config can be used across
Xorg or Wayland desktops, and you can even use `swhkd` in a TTY.
## Installation and Building
[Installation and building instructions can be found here.](./INSTALL.md)
## Running
```bash
swhks &
swhkd
```
## Runtime signals
After opening `swhkd`, you can control the program through signals:
- `sudo pkill -USR1 swhkd` — Pause key checking
- `sudo pkill -USR2 swhkd` — Resume key checking
- `sudo pkill -HUP swhkd` — Reload config file
## Configuration
`swhkd` closely follows `sxhkd` syntax, so most existing `sxhkd` configs should
be functional with `swhkd`.
More information about the sxhkd syntax can be found in the official man pages from the [arch wiki](https://man.archlinux.org/man/sxhkd.1).
The default configuration file is in `~/.config/swhkd/swhkdrc` with a fallback to `etc/swhkd/swhkdrc`.
If you use Vim, you can get `swhkd` config syntax highlighting with the
[swhkd-vim](https://github.com/waycrate/swhkd-vim) plugin. Install it in
vim-plug with `Plug 'waycrate/swhkd-vim'`.
All supported key and modifier names are listed in `man 5 swhkd-keys`.
## Environment Variables
The environment variables are now sourced using the SWHKS binary, running in the background which are then supplemented
to the command that is to be run, thus emulating the environment variables in the default shell.
The commands are executed via *SHELL -c 'command'*, hence the environment is sourced from the default shell.
If the user wants to use a different set of environment variables, they can set the environment variables
in the default shell or export the environment variables within a logged in instance of their shell before
running the SWHKS binary.
## Autostart
### To autostart `swhkd` you can do one of two things
1. Add the commands from the ["Running"
section](https://github.com/waycrate/swhkd#running) to your window managers
configuration file.
1. Enable the [service
file](https://github.com/waycrate/swhkd/tree/main/contrib/init) for your
respective init system. Currently, only systemd and OpenRC service files
exist and more will be added soon including Runit.
## Security
We use a server-client model to keep you safe. The daemon (`swhkd` — privileged
process) is responsible for listening to key events and running shell commands.
The server (`swhks` — non-privileged process) is responsible for keeping a track of the
environment variables and sending them to the daemon. The daemon
uses these environment variables while running the shell commands.
The daemon only runs shell commands that have been parsed from the config file and there is no way to
run arbitrary shell commands. The server is responsible for only sending the environment variables to the daemon and nothing else.
This separation of responsibilities ensures security.
So yes, you're safe!
## Support
1. https://matrix.to/#/#waycrate-tools:matrix.org
1. https://discord.gg/KKZRDYrRYW
## Contributors
## Supporters:
1. [@CluelessTechnologist](https://github.com/CluelessTechnologist)