-
-
Notifications
You must be signed in to change notification settings - Fork 6
Features Hotkeys
Tuck edited this page Jun 28, 2026
·
1 revision
Register and unregister global keyboard shortcuts. When a registered hotkey is pressed, the daemon emits an event to all subscribed clients.
Register a global hotkey combination.
| Parameter | Type | Description |
|---|---|---|
hotkey_id |
string | Unique identifier for this hotkey binding |
keys |
string[] | Key combination (e.g., ["Ctrl", "Shift", "A"]) |
deskbrid hotkeys.register '{"hotkey_id": "screenshot-tool", "keys": ["Ctrl", "Shift", "S"]}'{
"type": "hotkeys.register",
"hotkey_id": "screenshot-tool",
"keys": ["Ctrl", "Shift", "S"]
}When the hotkey is pressed, subscribers receive:
{
"type": "event",
"event": "hotkey.pressed",
"data": {
"hotkey_id": "screenshot-tool",
"keys": ["Ctrl", "Shift", "S"]
}
}Unregister a previously registered hotkey.
| Parameter | Type | Description |
|---|---|---|
hotkey_id |
string | ID of the hotkey to unregister |
deskbrid hotkeys.unregister '{"hotkey_id": "screenshot-tool"}'{"type": "hotkeys.unregister", "hotkey_id": "screenshot-tool"}from deskbrid import Deskbrid
client = Deskbrid()
# Register a hotkey
client.hotkeys_register(
hotkey_id="screenshot-tool",
keys=["Ctrl", "Shift", "S"],
)
# Subscribe to hotkey events
client.connection_subscribe(events=["hotkey.*"])
# Later, unregister
client.hotkeys_unregister(hotkey_id="screenshot-tool")- Global hotkeys require a Wayland session with Portal support, or X11 (XGrabKey)
- Some desktop environments may restrict certain key combinations
- Not all DEs support programmatic hotkey registration
Stable — hotkey registration and unregistration supported.
- Accessibility
- Apps
- Audio
- Backlight (LED driver)
- Bluetooth
- Clipboard
- Color Picker
- Desktop Portal
- Desktop Settings
- Files
- Hotkeys
- Input
- Keyboard Layouts
- Media (MPRIS)
- Monitors
- Network
- Notifications
- Print (CUPS)
- Screenshots
- Screen Recording
- Screencast
- Self-Update
- System
- System Tray
- Systemd Units & Timers
- Terminals (PTY)
- Windows & Workspaces