Unofficial community reference. Not affiliated with 37signals or the Omacom Foundation. Download Omarchy only from omarchy.org.
omarchylinux.org Unofficial field manual

omarchy commands

444 commands in v4.0.4, in 75 groups. Type omarchy alone on an Omarchy machine to see the same list; type omarchy <group> --help for a group. Hidden commands are internal helpers the router does not list.

agent AI coding agents, their usage, and subscription accounts

CommandSummaryArgs
omarchy agent Launch the default coding agent in a terminal [--inline] [--pick]
omarchy agent crash Diagnose a crashed process with the default coding agent <pid> [comm] [exe] [signal]
omarchy agent prompt Launch the default coding agent with a prompt [--inline] <prompt...>
omarchy agent usage claude Print the Claude Code usage record as JSON [--force] [--limits-only] hidden
omarchy agent usage codex Print the Codex usage record as JSON [--force] [--limits-only] hidden
omarchy agent usage fireworks Print the Fireworks usage record as JSON [--force] [--limits-only] hidden
omarchy agent usage update Regenerate the AI agent usage data files [--force] [--limits-only] [--except <agent>] [agent...]

apply

CommandSummaryArgs
omarchy apply hardware Apply Omarchy hardware-specific packages and system configuration sudo hidden
omarchy apply lock Configure Quickshell lock screen authentication sudo hidden
omarchy apply system Apply Omarchy system setup in the installed target sudo hidden

audio Audio input and output controls

CommandSummaryArgs
omarchy audio input mute Toggle microphone mute. Drives the hardware mic-mute LED on laptops that expose one.
omarchy audio input set default Set the default audio input and move active streams <node-id> <source-name>
omarchy audio output set default Set the default audio output and move active streams <node-id> <sink-name>
omarchy audio output sink Print the sink whose volume and mute a given output really uses [sink-name]
omarchy audio output switch Switch between audio outputs while preserving the mute status
omarchy audio output volume Adjust output volume and show the Omarchy OSD <raise|lower|mute-toggle|+N|-N>
omarchy audio sink availability Print PulseAudio sink availability for the shell
omarchy audio source switch Cycle to the next media source and transfer playback when the current source is playing [next|previous]
omarchy audio tuning Manage the speaker tuning for this laptop <on|off|status|match|fronted-sink> [--force]

bar Omarchy shell bar layout and settings

CommandSummaryArgs
omarchy bar Configure the bar and its widget layout use <id> | reset | defaults | position <top|bottom|left|right> | transparent <true|false|toggle> | put <id> [placement] | move <id> [placement] | set <id> <key> <value> [--json] [placement]
omarchy bar text color Choose a legible transparent bar text color hidden

battery Battery status helpers

CommandSummaryArgs
omarchy battery low Send the low battery warning notification and run battery-low hooks. <percentage> hidden
omarchy battery present Returns true if a battery is present on the system.
omarchy battery status Returns a formatted battery status string with percentage and power draw/charge. [--shell]

bluetooth Bluetooth device controls

CommandSummaryArgs
omarchy bluetooth device Control a Bluetooth device [pair|connect|disconnect|forget] <address>
omarchy bluetooth power Turn Bluetooth on or off, remembered across reboots <on|off|toggle|is-on>

branding About and screensaver branding

CommandSummaryArgs
omarchy branding about Edit, set, or reset About branding <image|text|reset>
omarchy branding screensaver Edit, set, or reset screensaver branding <image|text|reset>

brightness Display and keyboard brightness

CommandSummaryArgs
omarchy brightness display Show or adjust brightness on the focused display. [--no-osd] [--monitor name] [+N%|N%-|N%|off|on]
omarchy brightness display apple Show or adjust Apple Studio Display and Apple XDR Display brightness using asdcontrol. [--no-osd] [+N%|N%-|N%]
omarchy brightness display ddc Show or adjust DDC/CI display brightness for a Hyprland monitor. <monitor> [+N%|N%-|N%]
omarchy brightness keyboard Adjust keyboard backlight brightness using available steps. [--no-osd] <up|down|cycle|off|restore>
omarchy brightness keyboard mute Set the mic-mute indicator LED on laptops that expose a platform::micmute LED node. <on|off>

capture Screenshots and screen recording

CommandSummaryArgs
omarchy capture qr Decode a QR code from a screenshot region
omarchy capture region Pick a screen region over frozen screen content [region|windows|smart|fullscreen] [--keep-freeze] [--match-monitor] | --take-fullscreen | --take-window | --select-window <next|prev|left|right|up|down> hidden
omarchy capture screenrecording Start or stop screen recording [--fullscreen] [--with-desktop-audio] [--with-microphone-audio] [--with-webcam] [--webcam-device=<device>] [--webcam-size=<small|medium|large>] [--resolution=<size>] [--stop-recording]
omarchy capture screenrecording with webcam Pick a webcam and start a screen recording with it
omarchy capture screenshot Take a screenshot [smart|region|windows|fullscreen] [slurp|copy|save] [--editor=<name>]
omarchy capture text Extract text from a screenshot region with OCR
omarchy capture webcam list List webcam devices that support video capture hidden
omarchy capture webcam resize Resize the active webcam recording overlay <smaller|larger|reset|small|medium|large>

channel Omarchy release channel management

CommandSummaryArgs
omarchy channel current Print the active Omarchy package channel
omarchy channel set Set the Omarchy package channel. <stable|rc|edge|dev> sudo

chromium

CommandSummaryArgs
omarchy chromium copy url host Native messaging host: copy a Chromium tab URL to the clipboard hidden
omarchy chromium ytdlp host Native messaging host: download the URL sent by the yt-dlp Chromium extension hidden

clipboard Clipboard helpers

CommandSummaryArgs
omarchy clipboard open Open a clipboard history entry --history-index <index> hidden
omarchy clipboard paste file Copy a file to the clipboard and paste it [--copy-only] <mime-type> <path> hidden
omarchy clipboard paste text Copy text to the clipboard and type or paste it [--shift-insert] [--copy-only] [--history-index <index>|<text>] hidden

cmd Command and shortcut helpers

CommandSummaryArgs
omarchy cmd missing Check whether any required commands are missing
omarchy cmd present Check whether all required commands are available
omarchy cmd terminal cwd Print the current working directory of the active terminal window hidden

crash Crash notification controls

CommandSummaryArgs
omarchy crash watch Watch for process crashes and offer an AI diagnosis hidden

debug Diagnostics and support logs

CommandSummaryArgs
omarchy debug Print debugging information [--no-sudo] [--print] sudo
omarchy debug idle Show idle, screensaver, and lock diagnostics [log-lines]

default Default application selection

CommandSummaryArgs
omarchy default agent Set and launch the default coding agent [pi|omp|opencode|claude|codex|grok|gemini|openclaw|hermes|copilot|crush|cursor-agent|muse]
omarchy default browser Set the default browser for Omarchy and XDG handlers [chromium|chrome|brave|brave-origin|edge|firefox|zen]
omarchy default editor Set the default editor used by omarchy-launch-editor [code|cursor|zed|sublime_text|helix|vim|emacs|nvim]
omarchy default terminal Set the default terminal used by xdg-terminal-exec [alacritty|foot|ghostty|kitty]

dev Omarchy development tools

CommandSummaryArgs
omarchy dev add migration Create a new Omarchy migration in the current source tree. [--no-edit]
omarchy dev benchmark cli Measure Omarchy CLI response times [--repeat=<count>]
omarchy dev benchmark theme switcher Measure theme switcher cache and selector prep times [--repeat=<count>] [--keep-cache]
omarchy dev font Add branded glyphs to the Omarchy icon font [list|add] <name> <svg-file-or-url> [--codepoint U+E9xx] [--font PATH]
omarchy dev install ydoo Install and enable ydotool mouse automation for Omarchy development sudo
omarchy dev link Point Omarchy at a local checkout after reboot <path-to-checkout> [--no-reboot]
omarchy dev pkg test Build and install an Omarchy package from a local checkout [package-name] [path-to-checkout]
omarchy dev status Show the current Omarchy dev-link state
omarchy dev theme preview Preview an Omarchy theme palette in the terminal [theme-name|theme-dir|colors.toml] [--no-color] [--no-osc|--osc]
omarchy dev ui preview Open the omarchy-shell dev gallery (qs.Ui kit preview) [section]
omarchy dev unlink Restore Omarchy to the package install after reboot [--no-reboot]

disk Disk performance helpers

CommandSummaryArgs
omarchy disk speedtest Measure live disk read and write speed [target-dir]

display Display and text scaling

CommandSummaryArgs
omarchy display text size Scale text everywhere — omarchy shell, GTK apps, and terminals [size|reset]

dns DNS resolver configuration

CommandSummaryArgs
omarchy dns Show or configure the system DNS provider [Cloudflare|Google|DHCP|Custom]

done

CommandSummaryArgs
omarchy done Check or mark completed Omarchy setup tasks <check|mark|ensure> <name> hidden

drive Drive selection and encryption

CommandSummaryArgs
omarchy drive info Print drive information such as size, model, and mount details <drive>
omarchy drive password Set a new encryption password for a drive selected. sudo
omarchy drive select Select a drive from a list with info that includes space and brand. Used by omarchy-drive-password.

file File selection helpers

CommandSummaryArgs
omarchy file select Pick files with the desktop file chooser [--title <title>] [--multiple] [--directory] [--extensions "<ext ext...>"]

font Font management

CommandSummaryArgs
omarchy font current Show current monospace font
omarchy font list List available monospace fonts
omarchy font set Set the system monospace font <font-name>

games Game launchers and helpers

CommandSummaryArgs
omarchy games retro cores List installed RetroArch core names
omarchy games retro install Create a desktop launcher for a RetroArch game [core path-to-game]

git

CommandSummaryArgs
omarchy git url check Check that a git URL names a repository, not a transport helper <git-url> hidden

hibernation Hibernation setup and removal

CommandSummaryArgs
omarchy hibernation available Check if hibernation is supported
omarchy hibernation remove Remove hibernation setup including swap and boot resume settings sudo
omarchy hibernation setup Set up hibernation with swap and boot resume configuration [--force] [--no-rebuild] sudo

hook User hook runner

CommandSummaryArgs
omarchy hook Run a named hook from ~/.config/omarchy/hooks/<name> and ~/.config/omarchy/hooks/<name>.d/. [name] [args...]
omarchy hook install Install a hook into ~/.config/omarchy/hooks/<type>.d/ <type> <file>

hw Hardware detection and controls

CommandSummaryArgs
omarchy hw asus expertbook b9406 Detect ASUS ExpertBook B9406 series laptops on Intel Panther Lake.
omarchy hw asus rog Detect whether the computer is an Asus ROG machine.
omarchy hw asus zenbook ux5406aa Detect ASUS Zenbook UX5406AA series laptops on Intel Panther Lake.
omarchy hw clamshell Returns true when clamshell mode is active hidden
omarchy hw dell xps haptic touchpad Match Dell XPS systems with the Synaptics haptic touchpad.
omarchy hw dell xps oled Match Dell XPS systems with LG OLED panel on Intel Panther Lake (Xe3) GPU.
omarchy hw display Print the most likely display backlight device.
omarchy hw external monitors Returns true when an external monitor is physically connected.
omarchy hw fingerprint Returns true when a fingerprint reader is present hidden
omarchy hw framework16 Detect whether the computer is a Framework Laptop 16.
omarchy hw hybrid gpu Detect whether the system has an active hybrid GPU configuration
omarchy hw intel Detect whether the computer has an Intel CPU.
omarchy hw intel ptl Detect whether the computer has an Intel Panther Lake GPU.
omarchy hw intel sof Detect an Intel SOF-capable audio DSP
omarchy hw laptop Returns true when running on a laptop (has a lid or laptop chassis).
omarchy hw laptop closed Returns true when the laptop lid is closed hidden
omarchy hw match Match against the computer's DMI product name or product family (case-insensitive). <pattern>
omarchy hw nvidia Detect whether the computer has an NVIDIA GPU.
omarchy hw nvidia gsp Detect whether the computer has an NVIDIA GPU with GSP firmware (Turing or newer).
omarchy hw nvidia without gsp Detect whether the computer has an NVIDIA GPU without GSP firmware (Maxwell/Pascal/Volta).
omarchy hw recover internal monitor Clear the internal-monitor-disable toggle if no external display is connected.
omarchy hw surface Detect whether the computer is a Microsoft Surface device.
omarchy hw touchpad Print the detected Hyprland touchpad or trackpad device name
omarchy hw touchscreen Print the detected Hyprland touchscreen or tablet device name
omarchy hw vulkan Detect whether Vulkan is available.
omarchy hw webcam Check whether a webcam is available

hyprland Hyprland window, monitor, and toggle controls

CommandSummaryArgs
omarchy hyprland focus app Focus a Hyprland window by application identity <app-name>
omarchy hyprland monitor clamshell Apply clamshell display state to Hyprland monitors hidden
omarchy hyprland monitor external active Returns true when Hyprland has an active external monitor hidden
omarchy hyprland monitor focused Print the name of the currently focused Hyprland monitor.
omarchy hyprland monitor focused apple Return success if the focused or named Hyprland monitor is an Apple display. [monitor]
omarchy hyprland monitor internal Enable, disable, toggle, or recover the internal laptop display <on|off|toggle|recover>
omarchy hyprland monitor internal mirror Enable, disable, toggle, or recover mirroring the internal display to an external monitor <on|off|toggle|recover>
omarchy hyprland monitor laptop Print the name of the built-in laptop display, including disabled outputs.
omarchy hyprland monitor modeless Returns true when Hyprland has an enabled monitor with no mode hidden
omarchy hyprland monitor scaling Show, set, or adjust focused Hyprland monitor scaling [up|down|SCALE]
omarchy hyprland monitor watch Watch Hyprland monitor events and recover monitor toggles when a monitor is removed
omarchy hyprland reload guard Pause or resume Hyprland config auto-reload around package transactions. hidden
omarchy hyprland session locked Returns true when the compositor holds a session lock hidden
omarchy hyprland toggle Toggle permanent Hyprland flags by copying them into a directory that's sourced entirely. <flag-name> [on|off|toggle]
omarchy hyprland toggle disabled Check if a Hyprland toggle is currently disabled (missing). <flag-name>
omarchy hyprland toggle enabled Check if a Hyprland toggle is currently enabled. <flag-name>
omarchy hyprland window close all Close all open windows
omarchy hyprland window gaps toggle Toggles the window gaps globally between no gaps and the default.
omarchy hyprland window pop Toggle to pop-out a tile to stay fixed on a display basis. [width height x y]
omarchy hyprland window single square aspect toggle Toggle single-window square aspect ratio.
omarchy hyprland window tiled fullscreen toggle Toggle tiled fullscreen for the focused Hyprland window
omarchy hyprland window transparency toggle Toggles transparency for the currently focused window.
omarchy hyprland window width Save or restore the focused Hyprland window width <save|restore>
omarchy hyprland workspace layout toggle Toggle the layout on the current active workspace between dwindle and scrolling

install Optional software installers

CommandSummaryArgs
omarchy install ai chatgpt Install the ChatGPT desktop app sudo
omarchy install ai hermes Install the Hermes desktop app sudo
omarchy install ai openclaw Install the OpenClaw agent platform and its Control UI web app sudo
omarchy install ai t3 code Install T3 Code and point it at the Omarchy palette sudo
omarchy install and launch Install a packaged app and launch it once it finishes <display-name> <packages> <desktop-id>
omarchy install app Install a packaged app, surfacing the install in a floating terminal <display-name> <packages>
omarchy install browser Install a supported browser <chrome|brave|brave-origin|edge|firefox|zen>
omarchy install chromium copy url Install the native messaging host for the Copy URL Chromium extension
omarchy install chromium google account Allow Chromium to sign in to Google accounts by adding the required OAuth credentials
omarchy install chromium ytdlp Install the native messaging host for the yt-dlp Chromium extension
omarchy install dev-env Install a supported development environment <ruby|node|bun|deno|go|laravel|symfony|php|python|elixir|phoenix|rust|java|zig|ocaml|dotnet|clojure|scala> sudo
omarchy install docker dbs Install one of the supported databases in a Docker container with the suitable development options. sudo
omarchy install editor emacs Install Emacs with Omarchy theme and font integration via the omarchy-emacs AUR package
omarchy install editor helix Install Helix and configure it to use the current Omarchy theme
omarchy install editor vscode Install VS Code and configure Omarchy defaults for secrets, updates, and theme
omarchy install editor zed Install Zed Editor and configure it with the current Omarchy theme
omarchy install font Install a Nerd Font package and switch the system to it <display-name> <package> <family>
omarchy install gaming battlenet Install Battle.net standalone via umu-launcher + GE-Proton (no Steam, no Lutris, no Heroic). sudo
omarchy install gaming geforce-now Install and launch Geforce Now.
omarchy install gaming gpu-lib32 Install lib32 graphics drivers (Vulkan + NVIDIA) for any detected GPUs. sudo
omarchy install gaming heroic Install Heroic Games Launcher (Epic, GOG, Amazon Prime Gaming) with graphics drivers. sudo
omarchy install gaming lutris Install Lutris with Wine + DXVK for running Windows games (Battle.net, EA, Ubisoft Connect, etc.) sudo
omarchy install gaming retroarch Install RetroArch with the full libretro core set plus FBNeo and a ~/Games ROM directory.
omarchy install gaming steam Install Steam and graphics drivers selected for this system sudo
omarchy install gaming xbox-cloud Install Xbox Cloud Gaming as a web app and launch it.
omarchy install gaming xbox-controllers Install support for using Xbox controllers with Steam/RetroArch/etc. sudo
omarchy install hermes cli Install the Hermes CLI as a mise-backed wrapper in ~/.local/bin [--check|--now|--owns|--remove]
omarchy install openclaw cli Ensure the OpenClaw CLI is installed for the default agent [--check|--now] sudo
omarchy install preinstalls Restore the preinstalled Omarchy applications (web apps, TUIs, and selected packages). sudo
omarchy install service 1password Install 1Password and its Chromium extension. sudo
omarchy install service dropbox Install and start the Dropbox service. Must then be authenticated via the web.
omarchy install service nordvpn Install the NordVPN service with optional GUI. sudo
omarchy install service once Install the ONCE service, enable its background service, and launch the TUI. sudo
omarchy install service signal Install Signal and launch it. sudo
omarchy install service spotify Install Spotify. sudo
omarchy install service sunshine Install Sunshine and open Moonlight streaming ports for LAN and Tailscale. sudo
omarchy install service tailscale Install the Tailscale mesh VPN service and a web app for the Tailscale Admin Console. sudo
omarchy install terminal Install one of the approved terminals and set it as the default for Omarchy (Super + Return etc). <alacritty|foot|ghostty|kitty> sudo

installed Installed optional service checks

CommandSummaryArgs
omarchy installed service dropbox Check whether Dropbox is installed and running hidden
omarchy installed service tailscale Check whether Tailscale is installed and running hidden

launch Application launchers

CommandSummaryArgs
omarchy launch 1password Launch 1Password or start its installer when missing.
omarchy launch about Launch the fastfetch TUI that gives information about the current system.
omarchy launch battlenet Launch the installed Battle.net client via umu-launcher + GE-Proton. [--with-mangohud]
omarchy launch browser Launch the default browser as determined by xdg-settings. [url]
omarchy launch config editor Open a config file in the user's editor and surface a toast <path>
omarchy launch discord community Open the Omarchy Discord community in the Discord app or a browser.
omarchy launch docker tui Open the Docker TUI (lazydocker) with access to the Docker daemon hidden
omarchy launch editor Launch the default editor selected via Omarchy defaults. [--inline] <path>
omarchy launch floating terminal with presentation Launch a floating terminal with the Omarchy presentation wrapper <command>
omarchy launch nautilus Launch Files
omarchy launch nautilus cwd Launch Files in the active terminal's current directory
omarchy launch openclaw Open the OpenClaw Control UI (or its terminal UI with --tui), onboarding or starting the gateway first when needed. [--tui [--message <text>]]
omarchy launch or focus Launch an app or focus an existing window matching a pattern <window-pattern> <launch-command>
omarchy launch or focus tui Launch a TUI or focus an existing terminal window for it [--app-id=<app-id>] <command> [args...]
omarchy launch or focus webapp Launch or focus on a given web app identified by the window-pattern. <window-pattern> <url-and-flags...>
omarchy launch screensaver Launch the Omarchy screensaver in the default terminal on the system with the correct font configuration.
omarchy launch shell Launch the Omarchy shell with its log kept in the journal hidden
omarchy launch signal Launch Signal or start its installer when missing.
omarchy launch spotify Launch Spotify or start its installer when missing.
omarchy launch terminal Launch a terminal in the active terminal's current directory [command...]
omarchy launch terminal herdr Launch or attach to the persistent herdr session in a terminal
omarchy launch terminal tmux Launch or attach to the Work tmux session in a terminal
omarchy launch tui Launch a TUI command in the default terminal with Omarchy styling [--app-id=<app-id>] <command> [args...]
omarchy launch webapp Launch a URL as a web app in the default supported browser <url>
CommandSummaryArgs
omarchy menu Control the Omarchy menu (toggle / summon / close / refresh) [toggle|summon|close|refresh|ping] [route]
omarchy menu clipboard Launch the clipboard manager
omarchy menu emoji Launch emojis
omarchy menu emoji insert Insert an emoji into the focused application <emoji> hidden
omarchy menu file Pick a file from a menu label paths formats [menu args...]
omarchy menu herdr keybindings Display annotated Herdr keybindings using an interactive search menu. [--print|-p] [--config <path>]
omarchy menu images Open a generic image selector menu [--selected <image>] [--print-name] [--show-labels] [--filterable] [--lazy-thumbnails] [--preload] [--cache-only] <image-dir>...
omarchy menu input Prompt for text input from a menu prompt [menu args...]
omarchy menu keybindings Display Hyprland keybindings defined in your configuration using an interactive search menu.
omarchy menu plugin Pick a shell plugin to enable, disable, clone, or remove <enable|disable|clone|remove>
omarchy menu select Pick one option from a menu prompt [option...] [-- menu args...]
omarchy menu timezone Select and set the system timezone
omarchy menu tmux keybindings Display annotated Tmux keybindings using an interactive search menu. [--print|-p] [--config <path>]

migrate Migration runner

CommandSummaryArgs
omarchy migrate Run pending Omarchy migrations. [--pending]
omarchy migrate notify Notify the user when Omarchy has pending migrations

mise Mise tool wrappers

CommandSummaryArgs
omarchy mise install Install a small mise-backed wrapper for a given tool. <package> [command-name [bin-name]]

monitor Monitor status helpers

CommandSummaryArgs
omarchy monitor state Print monitor panel state for the shell

network Network status helpers

CommandSummaryArgs
omarchy network band Show or pin the Wi-Fi band for the active connection [auto|2.4|5|6]
omarchy network password Print the active Wi-Fi connection's password <interface>
omarchy network qr Generate a Wi-Fi QR matrix for the shell [--meta] [interface]
omarchy network speedtest Measure live internet speed for one direction [down|up]
omarchy network status Print active network status for the shell [--verbose]

notification Notification helpers

CommandSummaryArgs
omarchy notification battery Show the current battery status notification
omarchy notification dismiss Dismiss a notification by summary substring. Used by the first-run notifications to dismiss them after clicking for action. <summary>
omarchy notification send Send an Omarchy desktop notification [--app-name <app-name>] [-g <glyph>] [-u <low|normal|critical>] [-i <icon>] [-t <ms>] [-r <id>] [-p] [--image <path-or-uri>] <headline> [description] [--exec <program> [args...]]
omarchy notification time Show the current time and date notification
omarchy notification wait Wait for the desktop notification server to accept notifications [timeout-seconds] hidden
omarchy notification weather Toggle the current weather panel

omarchy

CommandSummaryArgs
omarchy Omarchy command center

openclaw OpenClaw agent platform setup

CommandSummaryArgs
omarchy openclaw onboard Run OpenClaw's setup wizard the way Omarchy needs it: in the terminal, installing the gateway as a user service, and returning when it is done.

osd On-screen display status helpers

CommandSummaryArgs
omarchy osd Show the Omarchy Quickshell on-screen display [-i|--icon <icon>] [-m|--message <text>] [-p|--progress <0-100>] [-d|--duration <ms>]

pkg Package management helpers

CommandSummaryArgs
omarchy pkg add Install Arch packages if they are missing <packages...> sudo
omarchy pkg aur accessible Returns true if the AUR is up and available.
omarchy pkg aur add Add the named packages to the system from the AUR if they're missing. Returns false if it couldn't be done. <packages...>
omarchy pkg aur install Show a fuzzy-finder TUI for picking new AUR packages to install. sudo
omarchy pkg drop Remove all the named packages from the system if they're installed (otherwise ignore). <packages...> sudo
omarchy pkg install Show a fuzzy-finder TUI for picking new Arch and OPR packages to install. sudo
omarchy pkg missing Returns true if any of the named packages are missing from the system (or false if they're all there). <packages...>
omarchy pkg present Returns true if all of the named packages are installed on the system (or false if any of them are missing). <packages...>
omarchy pkg remove Show a fuzzy-finder TUI for picking packages installed on the system to be removed. sudo

plugin Omarchy shell plugin and bar widget management

CommandSummaryArgs
omarchy plugin add Add a shell plugin from git [git-url] [--enable] [--yes]
omarchy plugin catalog Emit every first-party and user plugin manifest as JSON hidden
omarchy plugin clone Clone a built-in Omarchy shell plugin into your own config <source-id> [--edit]
omarchy plugin disable Disable a shell plugin <id>
omarchy plugin enable Enable a shell plugin <id> [placement]
omarchy plugin list List discovered shell plugins [--json]
omarchy plugin remove Remove an installed shell plugin [id] [--yes]
omarchy plugin update Update installed git-managed plugins [id] [--yes]
omarchy plugin validate Validate a plugin folder against the Omarchy plugin manifest schema <plugin-folder>

plymouth Plymouth boot theme management

CommandSummaryArgs
omarchy plymouth current Show which theme is styling the Plymouth boot screen
omarchy plymouth list List themes that can style the Plymouth boot screen
omarchy plymouth preview Preview a Plymouth boot screen with custom colors and logo <background-hex> <text-hex> <path-to-logo.png> <output-path>
omarchy plymouth reset Restore the default Omarchy Plymouth boot theme and SDDM login screen sudo
omarchy plymouth set Set the Plymouth boot theme colors and logo <background-hex> <text-hex> <path-to-logo.png> sudo
omarchy plymouth set by theme Set the Plymouth boot theme from an Omarchy theme <theme-name> sudo
omarchy plymouth switcher Open the Plymouth unlock screen switcher

power Power supply detection

CommandSummaryArgs
omarchy power present Returns true if external power is connected.

powerprofiles Power profile management

CommandSummaryArgs
omarchy powerprofiles init Set the correct power profile on boot based on current AC/battery state.
omarchy powerprofiles list Returns a list of all the available power profiles on the system. [--active-state]
omarchy powerprofiles set Set and remember the power profile for AC or battery use [autodetect|ac|battery] [power-saver|balanced|performance]

provision

CommandSummaryArgs
omarchy provision first run Finish first-login setup for Omarchy. [--force] hidden
omarchy provision owner First-boot provisioning: create the user on a machine installed in deferred provisioning sudo hidden
omarchy provision user Finalize Omarchy user setup (runtime tweaks /etc/skel can't do) hidden

refresh Reset config to defaults

CommandSummaryArgs
omarchy refresh applications Ensure default application launchers and mise wrappers are installed.
omarchy refresh chromium Refresh the ~/.config/chromium-flags.conf file from the Omarchy defaults.
omarchy refresh config Copy a shipped user config from $OMARCHY_PATH/config into ~/.config (backs up your version). <config-path>
omarchy refresh herdr Overwrite the user herdr config with the Omarchy default and reload herdr.
omarchy refresh hyprland Overwrite all the user Hyprland Lua configs in ~/.config/hypr with the Omarchy defaults.
omarchy refresh hyprsunset Overwrite the user config for hyprsunset with the Omarchy default and restart the service.
omarchy refresh limine Overwrite the user config for the Limine bootloader and rebuild it. sudo
omarchy refresh pacman Overwrite the package configuration for /etc/pacman with the Omarchy default of using its dedicated mirrors and repositories, then update all packages. sudo
omarchy refresh plymouth Overwrite the user config for the Plymouth drive decryption and boot sequence with the Omarchy default and rebuild it. sudo
omarchy refresh sddm Refresh the SDDM theme from default sudo
omarchy refresh shell Reset shell.json to Omarchy defaults
omarchy refresh tmux Overwrite the user tmux config with the Omarchy default and reload tmux.

reinstall Reinstall and reset workflows

CommandSummaryArgs
omarchy reinstall Reinstall Omarchy packages and reset default configs sudo
omarchy reinstall configs Reset Omarchy user configs and shipped defaults in $HOME (destructive)
omarchy reinstall pkgs Reinstall all default Omarchy packages from the stable channel sudo

reminder Desktop notification reminders

CommandSummaryArgs
omarchy reminder Set and show lightweight desktop notification reminders [-i|--interactive] | <minutes> [message] | show [-j|--json] | clear

remove Removal workflows

CommandSummaryArgs
omarchy remove ai hermes Remove the Hermes desktop app along with the Hermes runtime it installed. sudo
omarchy remove ai openclaw Remove the OpenClaw agent platform along with its gateway service and web app. sudo
omarchy remove ai perplexity Remove the Perplexity desktop app along with its runtime caches. sudo
omarchy remove ai t3 code Remove T3 Code along with its configuration and workspaces. sudo
omarchy remove browser Remove a supported browser and clean up Omarchy browser defaults <chrome|brave|brave-origin|edge|firefox|zen> sudo
omarchy remove dev env Remove a development environment that was previously installed via omarchy-install-dev-env. <ruby|node|bun|deno|go|php|laravel|symfony|python|elixir|phoenix|zig|rust|java|dotnet|ocaml|clojure|scala> sudo
omarchy remove gaming battlenet Remove Battle.net, its Proton prefix, installed games, and desktop entry.
omarchy remove gaming geforce-now Remove the GeForce NOW Flatpak app and its data.
omarchy remove gaming heroic Remove Heroic Games Launcher and its game libraries, configs, and caches. sudo
omarchy remove gaming lutris Remove Lutris, Wine, umu-launcher, and all their configs and caches. sudo
omarchy remove gaming minecraft Remove the Minecraft launcher along with its worlds, mods, and caches. sudo
omarchy remove gaming retroarch Remove RetroArch, all libretro cores, and its config/saves. Leaves ~/Games/roms and ~/Games/bios alone. sudo
omarchy remove gaming steam Remove Steam and all of its game libraries, configs, and caches. sudo
omarchy remove gaming xbox cloud Remove the Xbox Cloud Gaming web app.
omarchy remove gaming xbox-controllers Remove the xpadneo Xbox controller driver and undo its module/blacklist config. sudo
omarchy remove launcher entry Remove or uninstall the selected launcher entry <desktop-id> <name> sudo hidden
omarchy remove preinstalls Remove preinstalled Omarchy applications (web apps, TUIs, and selected packages).
omarchy remove security fido2 Remove FIDO2 authentication from sudo and polkit sudo
omarchy remove security fingerprint Remove fingerprint authentication from sudo, polkit, and lock screen sudo
omarchy remove security sshd Disable the OpenSSH server, close the firewall port, and optionally remove authorized keys sudo
omarchy remove security sudoless docker Disable sudoless Docker by removing your user from the docker group sudo
omarchy remove service 1password Remove 1Password and its Chromium extension. sudo
omarchy remove service dropbox Remove Dropbox and its bar plugin. sudo
omarchy remove service sunshine Remove Sunshine and close Omarchy-managed Moonlight streaming ports. sudo
omarchy remove service tailscale Remove Tailscale and its bar plugin. sudo

restart Restart Omarchy components

CommandSummaryArgs
omarchy restart app Restart an application by killing it and relaunching via uwsm. <application-name> [application-args...]
omarchy restart audio Restart audio services and recover stuck USB audio devices.
omarchy restart bluetooth Unblock and restart the bluetooth service.
omarchy restart btop Reload btop configuration (used by the Omarchy theme switching).
omarchy restart gum Export the current theme's gum styling into the environment hidden
omarchy restart helix Reload Helix configuration
omarchy restart herdr Reload herdr if running with the latest configuration
omarchy restart hyprctl Reload hyprland configuration (used by the Omarchy theme switching).
omarchy restart hyprsunset Restart the hyprsunset service (used for blue light filtering/night light).
omarchy restart opencode Reload opencode configuration (used by the Omarchy theme switching).
omarchy restart shell Restart the Omarchy shell
omarchy restart terminal Reload supported terminal emulators after config changes
omarchy restart tmux Restart tmux if running with the latest configuration
omarchy restart trackpad Reset the trackpad by unbinding and rebinding its driver. sudo
omarchy restart wifi Unblock and restart the Wi-Fi service.
omarchy restart xcompose Restart the XCompose input method service (fcitx5) to apply new compose key settings.

screensaver Screensaver branding and animation

CommandSummaryArgs
omarchy screensaver Run the Omarchy screensaver using random effects from TTE.

setup Interactive setup wizards

CommandSummaryArgs
omarchy setup direct boot Add or remove an EFI boot entry for the Omarchy UKI, allowing the system to boot directly sudo
omarchy setup security fido2 Set up FIDO2 authentication for sudo and polkit sudo
omarchy setup security fingerprint Set up fingerprint authentication for sudo, polkit, and lock screen sudo
omarchy setup security sshd Set up the OpenSSH server, open the firewall, and authorize an SSH key [--key=<public-key>] sudo
omarchy setup security sudoless docker Enable sudoless Docker by adding your user to the docker group (root-equivalent!) sudo
omarchy setup factory reset Factory-reset this machine back to its freshly-installed state sudo

share

CommandSummaryArgs
omarchy share Share clipboard, files, or folders with LocalSend <clipboard|file|folder> [path...]

shell Omarchy shell IPC helpers

CommandSummaryArgs
omarchy shell Send an IPC call to the running Omarchy shell [-q] <target> <method> [args...]
omarchy shell config Shared helpers for editing ~/.config/omarchy/shell.json (source this, don't run it). hidden

show

CommandSummaryArgs
omarchy show done Display a "Done!" message and wait for user to press any key.
omarchy show logo Display the Omarchy logo in the terminal using green color.

snapshot System snapshots

CommandSummaryArgs
omarchy snapshot Create or restore system snapshots with snapper <create|restore> sudo

state

CommandSummaryArgs
omarchy state Manage persistent state files for Omarchy toggles and settings. <set|clear> <state-name-or-pattern> hidden

sudo Sudo configuration helpers

CommandSummaryArgs
omarchy sudo docker Succeed when Docker needs sudo, fail when it can be used directly [--configured] hidden
omarchy sudo keepalive Prompt for sudo once and keep the credential alive in the background. sudo
omarchy sudo passwordless Toggle passwordless sudo for the current user. [MINUTES] sudo

system System status, reboot, shutdown, logout, and lock

CommandSummaryArgs
omarchy system factory reset finish First-boot worker that finishes an omarchy-system-factory-reset reset sudo hidden
omarchy system lid close Lock and reconcile displays when the laptop lid closes hidden
omarchy system lock Lock the computer and turn off the display
omarchy system logout Log out after closing application windows
omarchy system reboot Reboot after closing application windows
omarchy system shutdown Shut down after closing application windows
omarchy system sleep lock Lock before suspend and wait for the session lock to become secure hidden
omarchy system sleep monitor Monitor sleep preparation and lock before suspend hidden
omarchy system stats Print CPU and memory stats for the shell [--bar-widget]
omarchy system wake Wake displays and restore brightness after idle

tailscale Tailscale helpers

CommandSummaryArgs
omarchy tailscale receive Save incoming Taildrop files and announce them [--once] [directory]
omarchy tailscale send Send files to a machine on your tailnet with Taildrop <machine> [file...]

theme Theme management

CommandSummaryArgs
omarchy theme bg cache Cache background switcher thumbnails for the current theme
omarchy theme bg current Show current background
omarchy theme bg install Open the current theme's user background folder
omarchy theme bg next Cycle to the next background for the current theme
omarchy theme bg set Set the current background image <path-to-image>
omarchy theme bg-switcher Open the Omarchy background switcher
omarchy theme color Resolve semantic colors from an Omarchy theme colors.toml [--file <colors.toml>] (--all | --raw | <key> [fallback]) hidden
omarchy theme colors from alacritty Generate a theme's colors.toml from its alacritty.toml palette <theme-dir> hidden
omarchy theme current Show current theme
omarchy theme dir Print the directory holding a theme, preferring a user-installed copy <theme-name>
omarchy theme extras List the user-installed themes that came from a git clone
omarchy theme install Install a theme from a git repository [git-repo-url]
omarchy theme list List available themes
omarchy theme osc Print OSC sequences for an Omarchy color theme hidden
omarchy theme refresh Refresh the current theme from its templates.
omarchy theme remove Remove a user-installed theme [theme-name]
omarchy theme set Apply an Omarchy theme <theme-name>
omarchy theme set browser Apply the current theme color to Chromium, Chrome, Edge, and Brave hidden
omarchy theme set browser policy Write the current theme color into the browser policy directories <rrggbb> hidden
omarchy theme set claude Sync the generated Omarchy theme to Claude Code [--activate] hidden
omarchy theme set foot Apply current Omarchy theme colors to running Foot terminals hidden
omarchy theme set gnome Apply the current theme to GNOME color mode and icon settings hidden
omarchy theme set hermes Sync the generated Omarchy theme to Hermes as a skin [--activate] [--wait] hidden
omarchy theme set keyboard Apply the current theme keyboard color to supported keyboards hidden
omarchy theme set keyboard asus rog Apply the current theme keyboard color to ASUS ROG keyboards hidden
omarchy theme set keyboard f16 Apply the current theme keyboard color to Framework Laptop 16 keyboards hidden
omarchy theme set obsidian Sync Omarchy theme to all Obsidian vaults hidden
omarchy theme set pi Sync the generated Omarchy Pi theme [--activate] hidden
omarchy theme set t3code Sync the generated Omarchy theme to T3 Code hidden
omarchy theme set templates Generate themed config files from Omarchy templates hidden
omarchy theme set tmux Sync current Omarchy theme environment into tmux hidden
omarchy theme set vscode Sync Omarchy theme to VS Code, VSCodium, and Cursor hidden
omarchy theme switcher Open the Omarchy theme switcher
omarchy theme update Update user-installed git themes

toggle Toggle Omarchy features

CommandSummaryArgs
omarchy toggle Toggle Omarchy features between enabled and disabled <flag-name> [toggle|on|off]
omarchy toggle bar Toggle bar visibility without killing the Omarchy shell [toggle|on|off]
omarchy toggle crash capture Toggle crash capture notifications
omarchy toggle enabled Check if a toggle is enabled (flag file exists) <flag-name>
omarchy toggle hybrid gpu Toggle dedicated vs integrated GPU mode via supergfxd (for hybrid gpu laptops, like Asus G14). sudo
omarchy toggle idle Toggle idle behavior so the system either idles normally or stays awake [toggle|stay-awake|allow-idle|status]
omarchy toggle input device Enable, disable, or toggle a Hyprland input device <touchpad|touchscreen> [on|off|toggle] hidden
omarchy toggle nightlight Toggle nightlight screen temperature [--status]
omarchy toggle notification silencing Toggle notification do-not-disturb mode
omarchy toggle screensaver Toggle screensaver availability
omarchy toggle suspend Toggle suspend availability in the system menu
omarchy toggle touchpad Enable, disable, or toggle the touchpad [on|off|toggle]
omarchy toggle touchscreen Enable, disable, or toggle the touch functionality of the screen [on|off|toggle]

transcode Image and video transcoding

CommandSummaryArgs
omarchy transcode Transcode pictures and videos for sharing [--path path] [input] [format] [resolution]
omarchy transcode ascii Transcode an image into ASCII/Unicode art text <input-image.svg|png> <output-path> [--width <columns>] [--height <rows>] [--mode <braille|block>] [--threshold <percent>] [--invert]

tui Terminal UI launchers

CommandSummaryArgs
omarchy tui install Create a desktop launcher for a terminal UI app [name command window-style icon-url-or-name]
omarchy tui remove Remove a terminal UI desktop launcher [name]
omarchy tui remove all Remove all TUIs installed via omarchy-tui-install.

update Omarchy and system updates

CommandSummaryArgs
omarchy update Update Omarchy and system packages [-y] sudo
omarchy update analyze logs Check the update log for known failure conditions
omarchy update aur pkgs Update AUR packages if any are installed
omarchy update available Check whether Omarchy updates are available.
omarchy update confirm Prompt for confirmation before starting an update
omarchy update dev Update the active Omarchy dev checkout
omarchy update firmware Update system firmware using fwupd. Ensures the fwupd EFI binary is installed sudo
omarchy update keyring Ensure the Omarchy and Arch keyring packages are installed and populated sudo
omarchy update lock Run a command while holding the Omarchy update lock <held|run> [command] [args...] hidden
omarchy update mise Update mise-managed tools
omarchy update orphan pkgs Review and optionally remove orphaned system packages after updates sudo
omarchy update pacman guard Prevent direct pacman system upgrades from bypassing omarchy update. hidden
omarchy update pkg prune Prune superseded versions from the pacman package cache sudo
omarchy update requires free space Check free disk space required for an update hidden
omarchy update restart Prompt for required reboot or service restarts after updates
omarchy update status Refresh the shell update status hidden
omarchy update stay awake Manage sleep and idle inhibition during an update <start|stop> hidden
omarchy update system pkgs Update system packages with pacman sudo
omarchy update system pkgs when conflicted Retry a system package update that hit a conflict hidden
omarchy update time Restart system time synchronization sudo
omarchy update user notify Compatibility wrapper for omarchy-migrate-notify. hidden

upgrade

CommandSummaryArgs
omarchy upgrade to quattro Upgrade a legacy Omarchy install to the package-backed Omarchy quattro layout. [--yes] [--reboot] [--dev] [--channel stable|rc|edge] [--user USER] sudo

upload

CommandSummaryArgs
omarchy upload log Upload logs to logs.omarchy.org <log-file> hidden

version Version and channel information

CommandSummaryArgs
omarchy version Print the installed Omarchy version
omarchy version branch Print the active Omarchy dev-link git branch hidden
omarchy version channel Print the active Omarchy mirror and package channel
omarchy version pkgs Print when system packages were last upgraded

voxtype Voxtype dictation

CommandSummaryArgs
omarchy voxtype config Open Voxtype configuration
omarchy voxtype install Install and configure Voxtype dictation sudo
omarchy voxtype model Open Voxtype AI model setup
omarchy voxtype remove Remove Voxtype dictation and its configuration sudo
omarchy voxtype status Stream voxtype --follow status as bar-friendly JSON

weather Weather status

CommandSummaryArgs
omarchy weather icon Returns a weather condition icon, adjusted for live sunrise and sunset.
omarchy weather location Show or set the location used for weather reports
omarchy weather status Returns a formatted weather status string with temperature and wind speed.

webapp Web app launchers

CommandSummaryArgs
omarchy webapp handler hey Open HEY webmail and translate mailto links [url]
omarchy webapp handler zoom Open Zoom web meetings from browser protocol links [url]
omarchy webapp install Create a desktop launcher for a web app [name url icon-url-or-name [custom-exec] [mime-types]]
omarchy webapp remove Remove a web app desktop launcher [name]
omarchy webapp remove all Remove all web apps installed via omarchy-webapp-install.

windows Windows VM management

CommandSummaryArgs
omarchy windows vm Install, launch, stop, inspect, or remove the Windows VM <install|remove|launch|stop|status> [options] sudo