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
../panels/audio/,../panels/network/,../panels/power/, and../agents/provide richer popup bar plugins. - 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 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 the bar gestures, omarchy bar ..., or by editing shell.json directly, your file is canonical — there is no deep-merge.
The bar is configured directly on the bar itself: drag empty bar space (or click-and-hold) to move the bar to another screen edge, double-left-click empty center-bar space to cycle the bar background from clear to glassy to opaque, and drag widgets to reorder them. The omarchy bar position, omarchy bar background, omarchy bar move, and omarchy bar set commands do the same from scripts. Enable or disable widgets with omarchy plugin enable and omarchy plugin disable (widget ids come from omarchy plugin list).
Example shell.json (bar subtree only shown):
{
"version": 1,
"bar": {
"position": "top",
"background": "opaque",
"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; the focused workspace shows its layout | left = focus workspace, or cycle the focused one's layout |
omarchy.clock |
Date/time label + popup with a month grid, ISO week numbers, and month stepping | left = popup · right = cycle label format · middle = 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.system-update |
Available update indicator | left = update |
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 |
| omarchy.tailscale | Tailscale status, connection switcher, machine browser, and copy actions | left = popup · right = toggle · middle = refresh |
| omarchy.agents | AI coding agent limits with pace, today, last week, and all-time model breakdown | left = panel · right = launch agent · middle = next subscription |
| omarchy.power | Battery/AC icon + popup with battery stats, power profiles, and system info | left = popup · right = toggle percentage |
| omarchy.bluetooth | Bluetooth icon + popup with device list, connect/disconnect, battery | left = popup · right = toggle radio |
| 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).
Icon geometry
Use BarIconButton from qs.Ui for bar icons. It fits the visible glyph bounds to Style.bar.iconSize and centers them on both axes. It preserves each glyph's aspect ratio. Set labelText for an adjacent text label, such as the battery percentage.
The [bar] section of a theme's shell.toml supplies the shared dimensions. icon-size sets the visual target, with a default of 12 logical pixels. icon-canvas sets the canvas, with a default of 16 logical pixels. icon-slot and status-slot set the button extent. These dimensions follow the font scale unless scale-with-font is false.
Custom iconComponent content also fits the shared target. Its source dimensions can be 15px or another size. The bar measures its glyph, image, or vector bounds and applies one scale without changing its aspect ratio. A source iconSize override does not change the rendered target. Image padding remains part of an application's tray asset.
WidgetButton also uses the shared renderer for a single icon glyph. This covers custom command widgets and existing plugins that use WidgetButton with a different fontSize. Text labels retain their text size. Custom widgets must use WidgetButton or BarIconButton for this icon contract.
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 exec (quote arguments withUtil.shellQuotefromqs.Commons)bar.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/Workspaces.manifest.json;
richer popup plugins live in feature directories such as ../panels/audio/,
../panels/network/, and ../agents/; and feature plugins such as
omarchy.menu and omarchy.media 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.
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 the shell reference for the manifest schema. Rescan, enable, and place third-party plugins with omarchy-shell shell rescanPlugins, omarchy plugin enable, and omarchy bar move.