polybar-msg - Send IPC messages to polybar
Contents
Copyright
2016-2025, Michael Carlberg & contributors
3.7.2 Jan 23, 2025 POLYBAR-MSG(1)
Description
Polybar allows external control through actions and commands. Actions control individual modules and
commands control the bar itself.
The full IPC documentation is linked at the end of this document.
The available actions depend on the target module. For actions, the payload is either a single action
string or the module name, the action name, and the optional data string specified separately.
In order for polybar-msg being able to send a message to a running polybar process, the bar must have IPC
enabled and both polybar-msg and polybar must run under the same user.
Examples
polybar-msgcmdquit
Terminate all running polybar instances.
polybar-msgactionmymodulemodule_hidepolybar-msgaction "#mymodule.module_hide"
Hide the module named mymodule. The first variant specifies the module and action names
separately, the second uses an action string.
Name
polybar-msg - Send IPC messages to polybar
Options
-h,--help
Display help text and exit
-pPID Send message only to polybar process running under the given process ID. If not specified, the
message is sent to all running polybar processes.
Reporting Bugs
Report issues on GitHub <https://github.com/polybar/polybar>
See Also
polybar(1), polybar(5) IPC documentation: <https://polybar.rtfd.org/en/stable/user/ipc.html>
Synopsis
polybar-msg [OPTIONS] actionaction-stringpolybar-msg [OPTIONS] actionmoduleaction [data]
polybar-msg [OPTIONS] cmdcommand