1hyprctl(1)                    hyprctl User Manual                   hyprctl(1)
2
3
4

NAME

6       hyprctl  -  Utility  for  controlling parts of Hyprland from a CLI or a
7       script
8

SYNOPSIS

10       hyprctl [(opt)flags] [command] [(opt)args]
11

DESCRIPTION

13       hyprctl is a utility for controlling some parts of the compositor  from
14       a CLI or a script.
15

CONTROL COMMANDS

17       dispatch
18
19              Call a dispatcher with an argument.
20
21              An argument must be present.  For dispatchers without parameters
22              it can be anything.
23
24              Returns: ok on success, and an error message on failure.
25
26              Examples:
27                     hyprctl dispatch exec kitty
28
29                     hyprctl dispatch pseudo x
30
31       keyword
32
33              Set a config keyword dynamically.
34
35              Returns: ok on success, and an error message on failure.
36
37              Examples:
38                     hyprctl keyword bind SUPER,0,pseudo
39
40                     hyprctl keyword general:border_size 10
41
42       reload
43
44              Force a reload of the config file.
45
46       kill
47
48              Enter kill mode, where you can kill an app by  clicking  on  it.
49              You can exit by pressing ESCAPE.
50

INFO COMMANDS

52       version
53
54              Prints the Hyprland version, flags, commit and branch of build.
55
56       monitors
57
58              Lists all the outputs with their properties.
59
60       workspaces
61
62              Lists all workspaces with their properties.
63
64       clients
65
66              Lists all windows with their properties.
67
68       devices
69
70              Lists all connected input devices.
71
72       activewindow
73
74              Returns the active window name.
75
76       layers
77
78              Lists all the layers.
79
80       splash
81
82              Returns the current random splash.
83

OPTIONS

85       --batch
86
87              Specify a batch of commands to execute.
88
89              Example:
90                     hyprctl  --batch "keyword general:border_size 2 ; keyword
91                     general:gaps_out 20"
92
93                     ; separates the commands.
94
95       -j
96
97              Outputs information in JSON.
98

BUGS

100       Submit bug reports and request features online at:
101              <https://github.com/hyprwm/Hyprland/issues>
102

SEE ALSO

104       Sources at: <https://github.com/hyprwm/Hyprland>
105

107       Copyright (c) 2022, vaxerski
108

AUTHORS

110       Vaxerski <https://github.com/vaxerski>.
111
112
113
114                                                                    hyprctl(1)
Impressum