hyprlock

GPU-accelerated screen locker for Hyprland

TLDR

Lock using the default config search path

$ hyprlock

Lock with an explicit config file

$ hyprlock -c [path/to/hyprlock.conf]

Skip the grace period and require a password immediately

$ hyprlock --grace 0

Disable the fade-in animation

$ hyprlock --no-fade-in

Unlock from another TTY (SIGUSR1)

$ pkill -USR1 hyprlock

hyprlock is Hyprland's multi-threaded, GPU-accelerated session lock. Layout is entirely widget-based (background, input-field, label, image, shape) in hyprlock.conf. Authentication uses PAM (`auth:pam:module`, default hyprlock, falling back to su) and optionally fprintd fingerprints.Config is loaded from the first match of `$XDGCONFIGHOME/hypr/hyprlock.conf`, `~/.config/hypr/hyprlock.conf`, `$XDGCONFIGDIRS/hypr/hyprlock.conf`, then `/etc/xdg/hypr/hyprlock.conf`.ESC, Ctrl+u, and Ctrl+Backspace clear the password buffer. Hyprland binds with flag l still work while locked (volume, brightness). SIGUSR1 unlocks; SIGUSR2 refreshes labels and images.

PARAMETERS

-c, --config file

Config file to use.

--display name

Wayland display to connect to.

--grace seconds

Seconds during which moving the mouse or typing unlocks without a password.

--immediate-render

Draw the background immediately (same as `general:immediate_render`).

--no-fade-in

Skip the fade-in animation.

-v, --verbose

Verbose logging.

-q, --quiet

Disable logging.

-V, --version

Print version and exit.

-h, --help

Show help.

INSTALL

sudo pacman -S hyprlock

sudo zypper install hyprlock

nix profile install nixpkgs#hyprlock

CAVEATS

If no config file is found, hyprlock exits with an error and does not lock. Keep an example config in place. PAM faillock on Arch can impose a 10-minute lockout after three failures (`/etc/security/faillock.conf`). Fingerprint auth needs fprintd. At least one auth method must be enabled.

HISTORY

Part of the Hyprland ecosystem (hyprwm).

RESOURCES

Source code · Documentation