3.8 KiB
hyprctl is a utility for controlling some parts of the compositor from a CLI
or a script. If you install with make install, or any package, it should
automatically be installed.
To check if hyprctl is installed, simply execute it by issuing hyprctl in
the terminal.
If it's not, go to the repo root and /hyprctl. Issue a make all and then
sudo cp ./hyprctl /usr/bin.
Using Hyprctl
{{< hint type=warning >}}
hyprctl calls will be dispatched by the compositor synchronously,
meaning any spam of the utility will cause slowdowns.
It's recommended to use --batch for many control calls, and
limiting the amount of info calls.
For live event handling, see the socket2.
{{< /hint >}}
Commands
Dispatch
issue a dispatch to call a keybind dispatcher with an arg.
An arg has to be present, for dispatchers without parameters it can be anything.
To pass an argument starting with - or --, such as command line options to
exec programs, pass -- as an option. This will disable any subsequent
parsing of options by hyprctl.
Examples:
hyprctl dispatch exec kitty
hyprctl dispatch -- exec kitty --single-instance
hyprctl dispatch pseudo x
Returns: ok on success, an error message on fail.
See Dispatchers for a list of dispatchers.
Keyword
issue a keyword to call a config keyword dynamically.
Examples:
hyprctl keyword bind SUPER,O,pseudo
hyprctl keyword general:border_size 10
Returns: ok on success, an error message on fail.
Reload
issue a reload to force reload the config.
kill
issue a kill to get into a kill mode, where you can kill an app by clicking on
it. You can exit it with ESCAPE.
Kind of like xkill.
setcursor
Sets the cursor theme and reloads the cursor manager. Will set the theme for everything except GTK, because GTK.
params: theme and size
e.g.:
hyprctl setcursor Bibata-Modern-Classic 24
output
Allows you to add and remove fake outputs to your preferred backend.
params: create or remove and backend or name respectively.
For create:
pass a backend name: wayland, x11, headless or auto. On a real hyprland
session, if you're looking for a VNC / RDP type thing, it's 99% going to be headless.
For remove:
pass the output's name, as found in hyprctl monitors. Please be aware you are not
allowed to remove real displays with this command.
e.g.:
# will create a 1920x1080 headless display, for example to use with RDP.
hyprctl output create headless
# will remove the above display, provided its name was HEADLESS-1
hyprctl output remove HEADLESS-1
Info
version - prints the hyprland version, meaning flags, commit and branch of build.
monitors - lists all the outputs with their properties
workspaces - lists all workspaces with their properties
clients - lists all windows with their properties
devices - lists all connected keyboards and mice
activewindow - gets the active window name
layers - lists all the layers
splash - prints the current random splash
getoption [option] - gets the config option status (values)
cursorpos - gets the current cursor pos in global layout coordinates
For the getoption command, the option name should be written as section:option,
e.g.:
hyprctl getoption general:border_size
# For nested sections:
hyprctl getoption input:touchpad:disable_while_typing
See Variables for section and options you can use.
Batch
You can also use --batch to specify a batch of commands to execute
e.g.
hyprctl --batch "keyword general:border_size 2 ; keyword general:gaps_out 20"
; separates the commands
Flags
You can specify flags for the request like this:
hyprctl -j monitors
flag list:
j -> output in JSON