Omahub
← All plugins
S

Keyboard Shortcuts

by Sahzudin

A settings-style editor for Omarchy and Hyprland keyboard shortcuts.

GitHub Homepage

Security review

No obvious issues detected

Deterministic scan — not a security guarantee

None
Risk level
None
Analyzed commit
cf4f299
Scanned
1 month ago

No potentially dangerous behavior detected in the analyzed commit.

Automated analysis only — not a security guarantee.

AI advisory review

No obvious issues detected

Language-model assessment · ~deepseek/deepseek-v4-flash-latest — advisory only

Low
AI risk level
Low
Recommendation
install
Model
~deepseek/deepseek-v4-flash-latest
Analyzed commit
cf4f299
Reviewed
1 month ago

The plugin is a legitimate keyboard shortcut editor that modifies user-level Hyprland configuration files with clear documentation and reversible operations. The deterministic scan found no issues)Skip. The main risk is that the installer modifies user configuration files and runs commands, but these actions are transparent and user-initiated.

  • The installer modifies user configuration files (bindings.lua, shell.json, menu) and runs hyprctl commands, which could disrupt the user's setup if not properly tested, though the code includes backups and rollback mechanisms.
  • The plugin executes Python scripts and shell commands with user permissions, and while no malicious behavior is evident, the broad file modifications warrant a quick manual review of the install/uninstall scripts.
How this check works

This review combines the deterministic scan (the rule-based results above) with an independent look at the plugin's code by a language model. The model reads a trimmed sample of the repository's files, the manifest, and the README, then gives a plain-language risk level and a recommendation: install (no notable danger), review (look closer first), or avoid (clearly dangerous).

It runs on the same analyzed commit as the deterministic scan and is strictly advisory — it is not a security guarantee and never blocks a plugin by itself. A human moderator still reviews plugins before they are listed.

AI advisory only — automated analysis, not a security guarantee.

Install
$ omarchy plugin add https://github.com/sahzudin/omarchy-keymap --enable
System #Hyprland #quickshell #system

Omarchy Keyboard Shortcuts

A native Omarchy settings panel for viewing and changing Hyprland keyboard shortcuts. It applies changes immediately while keeping handwritten Lua and Omarchy's packaged defaults untouched.

Keyboard Shortcuts panel

Features

  • Search all effective Omarchy and user shortcut groups by name, typed shortcut, or by pressing the shortcut chord.
  • Display physical code:N bindings as familiar keys using the active XKB keymap, while preserving their layout-independent representation internally.
  • Capture a new shortcut directly from the keyboard.
  • Suspend Hyprland actions while capturing, then restore them immediately; Super+Esc is an emergency reset if capture is ever interrupted.
  • Detect conflicts and explicitly replace an existing assignment.
  • Disable one shortcut, reset one shortcut, or restore all defaults.
  • Validate every generated Lua change with hyprctl reload and hyprctl configerrors, rolling back automatically on failure.
  • Open from Setup > Keyboard > Keyboard Shortcuts with an optional bar icon.
  • Preserve advanced callback-based Lua bindings as visible, read-only entries.

Install

Requirements

  • Omarchy Quattro with its Hyprland Lua configuration and Omarchy shell.
  • Python 3, hyprctl, and omarchy-shell, all provided by Omarchy.
  • xkbcli is optional and improves labels for physical code:N bindings.

Install the public repository through Omarchy, then explicitly run its integration step:

omarchy plugin add https://github.com/sahzudin/omarchy-keymap.git --yes
~/.config/omarchy/plugins/io.github.sahzudin.keymap/install.sh

The integration step adds marked, reversible entries to the user's Hyprland, Omarchy menu, and shell configuration. It runs entirely with user permissions and leaves packaged files under /usr/share/omarchy untouched.

The panel is installed without a bar icon by default. To start with one:

~/.config/omarchy/plugins/io.github.sahzudin.keymap/install.sh --with-bar

When the icon is hidden, omarchy plugin list reports this mixed panel,bar-widget plugin as disabled; for mixed plugins that column describes bar placement. The panel remains enabled through shell.json and continues to open from the Omarchy menu.

For development, place or symlink this directory at ~/.config/omarchy/plugins/io.github.sahzudin.keymap, rescan plugins, and run ./install.sh.

How persistence works

The installer adds one marked require("hypr.keymap") block to ~/.config/hypr/bindings.lua. The settings panel owns only these files:

  • ~/.config/hypr/keymap.lua — generated hl.unbind and o.bind calls.
  • ~/.config/omarchy-keymap/overrides.json — the editable shortcut model.
  • ~/.local/state/omarchy-keymap/backups/ — timestamped backups.

The generated file first unbinds every affected source and destination chord, then recreates the selected actions. Removing an override therefore exposes the current Omarchy default again instead of freezing an old copy.

Command-line backend

python3 scripts/keymap.py list
python3 scripts/keymap.py set <group-id> "SUPER + SHIFT + R"
python3 scripts/keymap.py disable <group-id>
python3 scripts/keymap.py reset <group-id>
python3 scripts/keymap.py reset-all
python3 scripts/keymap.py set-bar true

Remove

Run the cleanup before deleting the plugin directory:

~/.config/omarchy/plugins/io.github.sahzudin.keymap/uninstall.sh
omarchy plugin remove io.github.sahzudin.keymap

Use uninstall.sh --purge to also remove the generated keymap and saved overrides. Without --purge, those inactive files remain available for a future reinstall.

Development checks

python3 -m unittest discover -s tests -v
python3 -m py_compile scripts/keymap.py