hyprpm

hyprpm [flags] command [arguments]

hyprpm is the plugin manager shipped with Hyprland, a dynamic tiling Wayland compositor. It clones plugin repositories from Git, fetches Hyprland headers matching the running compositor, compiles each plugin against them, and loads the enabled ones into the live session.Hyprland ships no plugins of its own, so a repository has to be added first with hyprpm add. Plugins in an added repository are inactive until enabled; hyprpm reload then hands the built `.so` files to the running compositor, the same mechanism as `hyprctl plugin load`.Building requires `cpio`, `cmake`, `git`, `meson` and `gcc`, plus the development packages of Hyprland's dependencies on distributions that split headers from binaries. State, headers and built plugins live under `/var/cache/hyprpm/<username>`, so several operations ask for root privileges.

add URL [git rev]

Install a new plugin repository from Git. The revision is optional; when set, commit locks are ignored.

Remove an installed plugin repository.

Enable a plugin.

Disable a plugin.

Check and update all plugins if needed, rebuilding them against current headers.

Reload hyprpm state and ensure all enabled plugins are loaded into the running Hyprland instance.

List all installed plugins.

Remove the entire hyprpm cache, built plugins, hyprpm settings and headers.

Show the help menu.

Enable verbose logging.

Force an operation, ignoring checks (for example `hyprpm update -f`).

Send a Hyprland notification confirming a successful plugin load. Warnings and errors are notified regardless of this flag.

Disable shallow cloning of the Hyprland sources.

Disable `nix develop` for build commands, even when Hyprland is a Nix build.

Use a custom Hyprland source URL when fetching headers.

hyprpm has no config file of its own. To load plugins automatically at compositor startup, add an autostart entry to the Hyprland config, optionally with `-n` for a confirmation notification:

$ exec-once = hyprpm reload -n

$ hl.permission("/usr/(bin|local/bin)/hyprpm", "plugin", "allow")

Plugins are C++ code that runs inside the compositor process. A malicious or broken plugin has the same power as Hyprland itself, so read the source of anything you install and never load `.so` files from untrusted sources.Plugins are compiled against a specific Hyprland ABI. After upgrading Hyprland the headers go stale and hyprpm add refuses to run with "Headers outdated"; run hyprpm update first to refetch headers and rebuild every plugin.If a plugin makes Hyprland crash on startup, disable it with hyprpm disable from a TTY. When Hyprland's permission system is in use, `hyprpm` needs an explicit `plugin` permission entry or it prompts on every load.

hyprpm was added to the Hyprland tree in December 2023 and first shipped in Hyprland v0.34.0 (January 2024), replacing manual `hyprctl plugin load` workflows as the recommended way to install plugins.

hyprctl(1), hyprland(1), hyprpaper(1), hyprshot(1), cmake(1), meson(1)

Source code · Homepage · Documentation