Omarchy bar
This is the Quickshell implementation of the Omarchy status bar. It is
shipped as a first-party plugin of omarchy-shell, the
long-running shell host. The bar is mounted at startup and lives inside
the shell for its whole session.
manifest.jsondeclares the plugin (id: omarchy.bar,kind: bar) and points atBar.qmlas the entry point.Bar.qmlis Omarchy-owned bar engine code, loaded by the omarchy-shell host. Users should not edit it directly.widgets/holds simple first-party bar widgets with sibling manifests.- Feature plugins such as
../audio/,../network/, and../power/provide richer popup bar widgets. - The bar receives its config from the host shell as a
barConfigproperty; the host loads it from~/.config/omarchy/shell.json(orconfig/omarchy/shell.jsonwhen the user has no file). omarchy-style-bar-positionupdates only the user shell.json file.
Customizing
The bar config lives under the bar: key of ~/.config/omarchy/shell.json. Out of the box the shell uses config/omarchy/shell.json. Once you customize anything via omarchy launch bar settings or by editing shell.json directly, your file is canonical — there is no deep-merge.
Launch the visual editor with omarchy launch bar settings / omarchy plugin bar edit (or run omarchy-launch-bar-settings) to reorder widgets, add/remove them, and tweak per-widget options without editing JSON by hand. For scriptable changes, use omarchy plugin bar list, omarchy plugin bar add, omarchy plugin bar move, omarchy plugin bar remove, and omarchy plugin bar set. You can also right-click empty space to the left or right of the centered clock module to open it; double-left-click the same empty space to toggle bar transparency.
Example shell.json (bar subtree only shown):
{
"version": 1,
"bar": {
"position": "top",
"transparent": false,
"centerAnchor": "omarchy.clock",
"layout": {
"left": [
{ "id": "omarchy.menu" },
{ "id": "omarchy.spacer", "size": 12 },
{ "id": "omarchy.workspaces" }
],
"center": [
{ "id": "omarchy.media" },
{ "id": "omarchy.clock", "format": "HH:mm" }
],
"right": [
{ "id": "omarchy.audio" },
{ "id": "omarchy.power" }
]
}
}
}
centerAnchor pins one center module to the exact horizontal/vertical center and flanks others around it. Set to an empty string to disable anchoring (the center list is centered as a group).
Module catalogue
First-party interactive widgets
| Name | What it does | Interactions |
|---|---|---|
omarchy.menu |
Omarchy menu launcher | left = menu · right = terminal |
omarchy.workspaces |
Hyprland workspace switcher | left = focus workspace |
omarchy.clock |
Date/time label | left = alternate format · right = timezone selector |
omarchy.media |
MPRIS now-playing — scrolling track + artist, cover-art popup | left = play/pause · middle = next · scroll = prev/next · right = popup |
omarchy.indicators |
Manual state indicators | left = indicator action |
omarchy.notifications |
Bell with badge + popup with recent notifications, DND toggle | left = popup · right = toggle DND |
omarchy.system-update |
Available update indicator | left = update |
omarchy.system-stats |
Inline CPU + memory sparklines, popup with detail | left = popup · right = terminal |
omarchy.tray |
System tray | hover = reveal drawer · right on chevron = manage |
omarchy.weather |
Weather icon + popup with forecast | left = popup · right = full notification |
omarchy.microphone |
Mic icon + scroll volume | left = mute toggle · middle = audio panel · scroll = source volume |
| omarchy.audio | Volume icon + popup with master slider, output-device picker, per-app mixer | left = popup · right = mute · middle = popup · scroll = volume |
| omarchy.network | Wi-Fi/Ethernet icon + popup with Wi-Fi scan, signal, connect, DNS provider selection | left = popup · right = nmtui |
| omarchy.power | Battery/AC icon + popup with battery stats, power profiles, and system info | left = popup |
| omarchy.bluetooth | Bluetooth icon + popup with device list, connect/disconnect, battery | left = popup · right = toggle radio · middle = bluetoothctl TUI |
| omarchy.monitor | Brightness and laptop display controls | left = popup |
The omarchy.indicators widget loads individual bar indicators from indicators/. Omit items (or set it to an empty array) to show all indicators in the default order, or set items to a subset such as ["Dnd", "Reminder", "NightLight"]. Set alwaysShow to true to keep inactive indicators visible instead of revealing them only on hover. Multiple omarchy.indicators instances are allowed, so different sections can show different subsets.
Orientation
All widgets work in top, bottom, left, and right positions. Popups anchor on the side opposite the bar edge, sliding into the workspace. Vertical bars use 28px width; widgets that show text fall back to compact icon-only forms (e.g. media hides its scrolling label).
Custom user modules
The schema accepts arbitrary module ids that you provide. Set type to command for shell-driven output or qml for a custom QML widget. Both still go under bar.layout.<section> in shell.json.
Command module:
{
"version": 1,
"bar": {
"layout": {
"right": [
{ "id": "omarchy.tray" },
{ "id": "vpn", "type": "command", "exec": "~/.config/omarchy/bar/scripts/vpn-status", "interval": 5, "tooltip": "VPN", "onClick": "nm-connection-editor" },
{ "id": "omarchy.audio" }
]
}
}
}
The command may print plain text or Waybar-style JSON, for example:
{"text":"","tooltip":"Work VPN","class":"active"}
QML module:
{
"version": 1,
"bar": {
"layout": {
"right": [
{ "id": "gpu", "type": "qml" },
{ "id": "omarchy.audio" }
]
}
}
}
Then create ~/.config/omarchy/bar/modules/gpu.qml. If you want to store it elsewhere, add a source path.
Custom QML modules should be an Item with implicitWidth and implicitHeight. They may optionally define these properties, which the bar fills after loading:
import QtQuick
Item {
property var bar
property string moduleName
property var settings
implicitWidth: 28
implicitHeight: bar ? bar.barSize : 26
Text {
anchors.centerIn: parent
text: "GPU"
color: bar ? bar.foreground : "white"
font.family: bar ? bar.fontFamily : "monospace"
font.pixelSize: 12
}
MouseArea {
anchors.fill: parent
onClicked: if (bar) bar.run("omarchy-launch-or-focus-tui btop")
}
}
Bar properties available to widgets
Widgets receive bar (the shell root), moduleName (string), and settings (object) injected at load time. The bar exposes:
bar.foreground,bar.background,bar.urgent— theme colors (live-updated)bar.fontFamily— current monospace familybar.position—"top" | "bottom" | "left" | "right"bar.vertical— boolean shortcutbar.barSize— 26 horizontal / 28 verticalbar.run(command)— fire-and-forget bash execbar.shellQuote(value)— safe shell-quote a stringbar.showTooltip(target, text)/bar.hideTooltip(target)— shared tooltip popupbar.requestPopout(owner)/bar.releasePopout(owner)— one-popup-at-a-time coordinator
First-party bar widgets are manifest-backed just like third-party widgets.
Simple widgets carry sibling manifests such as widgets/Clock.manifest.json;
richer popup widgets live in feature directories such as ../audio/ and
../network/; and feature plugins such as omarchy.menu, omarchy.media, and
omarchy.notifications declare their bar-widget entry points in their own
manifest.json. Bar layout ids are namespaced, e.g. omarchy.audio,
omarchy.network, and omarchy.clock. Older UpperCamelCase ids such as
AudioPanel and Clock are migrated forward; new configs should use the
namespaced ids.
Third-party widgets ship as separate plugins under
~/.config/omarchy/plugins/<plugin-id>/ with their own manifest.json
declaring kinds: ["bar-widget"] and a barWidget entry point. See
../../README.md for the manifest schema. Enable,
rescan, and place third-party plugins with omarchy plugin enable,
omarchy plugin rescan, and omarchy plugin bar add.