Project Layout

bin/ — CLI Utilities

This directory houses all command-line tools that drive Omarchy’s functionality. Each script implements a discrete operation—from self-updates and migrations to package management, theme control, app installers, and desktop utilities. These commands are invoked via the omarchy- prefix and live in the user’s PATH once Omarchy is installed.

Index

Update Commands

Automate fetching, installing, and applying updates to Omarchy and the system.

Command Description Usage Example
omarchy-update Full update workflow: snapshot → Git pull → migrations → package updates → restart services omarchy-update
omarchy-update-available Check for newer Omarchy release tags in the remote repo omarchy-update-available
omarchy-update-git Pull latest Omarchy code and reset on conflicts omarchy-update-git
omarchy-update-system-pkgs Refresh Pacman & AUR packages, respecting ignored pins omarchy-update-system-pkgs
omarchy-update-restart Prompt & perform reboots or service restarts as needed omarchy-update-restart

Migration

Runs pending migrations to adjust configurations or dependencies when Omarchy updates introduce breaking changes.

Command Description Usage Example
omarchy-migrate Executes each install/migrations/*.sh once, tracking successes/failures omarchy-migrate

Package Helpers

Simplify package installation, removal, and checks via Pacman and AUR.

Command Description Usage Example
omarchy-pkg-add Install packages if missing via Pacman omarchy-pkg-add git
omarchy-pkg-remove Remove AUR or Pacman packages interactively via yay omarchy-pkg-remove
omarchy-pkg-install Fuzzy-find & batch install from official repos omarchy-pkg-install
omarchy-pkg-aur-install Fuzzy-find & install AUR packages via yay omarchy-pkg-aur-install
omarchy-pkg-missing Exit 0 if any given package is not installed omarchy-pkg-missing curl wget
omarchy-pkg-present Exit 1 if any given package is missing omarchy-pkg-present git
omarchy-pkg-pinned List pinned packages from install/packages.pinned omarchy-pkg-pinned
omarchy-pkg-aur-accessible Check AUR RPC availability omarchy-pkg-aur-accessible

Theme Management

Manage Hyprland/desktop themes stored under ~/.config/omarchy/themes.

Command Description Usage Example
omarchy-theme-list List installed themes (human-readable) omarchy-theme-list
omarchy-theme-current Print the current theme name omarchy-theme-current
omarchy-theme-next Cycle to the next theme and notify omarchy-theme-next
omarchy-theme-bg-next Cycle wallpaper backgrounds within current theme omarchy-theme-bg-next
omarchy-theme-set Set theme by name, update symlinks, GTK & Chromium colors, reload components omarchy-theme-set catppuccin-latte
omarchy-theme-install Clone theme repo into themes directory & apply it omarchy-theme-install https://github.com/…”
omarchy-theme-update Pull updates for all Git-installed themes omarchy-theme-update
omarchy-theme-remove Remove extra or specified theme, advancing if it’s active omarchy-theme-remove rose-pine

App Installers

One-off installers for popular applications, handling dependencies and launch.

Command Description Usage Example
omarchy-install-steam Enable multilib, install Steam & launch it omarchy-install-steam
omarchy-install-dropbox Install Dropbox CLI & start service omarchy-install-dropbox
omarchy-install-tailscale Install Tailscale + tsui, configure sudoers, add web console icon omarchy-install-tailscale
omarchy-install-dev-env Scaffold dev stacks: Ruby, Node, Go, PHP, Python, Rust, etc. omarchy-install-dev-env node
omarchy-install-docker-dbs Run Docker containers for MySQL, PostgreSQL, Redis, MongoDB, MariaDB omarchy-install-docker-dbs

Desktop Utilities

Helper scripts for window management, notifications, and configuration sync.

Command Description Usage Example
omarchy-launch-browser Launch default browser in Wayland app mode omarchy-launch-browser https://example.com
omarchy-launch-webapp Create & launch a desktop web-app with custom icon omarchy-launch-webapp "Mail" https://mail.example.com …
omarchy-launch-floating-terminal-with-presentation Open a floating Alacritty for demos with logo splash omarchy-launch-floating-terminal-with-presentation htop
omarchy-lock-screen Lock via Hyprlock and ensure 1Password locks omarchy-lock-screen
omarchy-toggle-idle Enable/disable idle locking daemon omarchy-toggle-idle
omarchy-toggle-nightlight Toggle Hyprland sunset plugin temperature omarchy-toggle-nightlight
omarchy-toggle-screensaver Enable/disable Alacritty screensaver sessions omarchy-toggle-screensaver
omarchy-powerprofiles-list List available power profiles via powerprofilesctl omarchy-powerprofiles-list
omarchy-refresh-config Deploy a default config from ~/.local/share/omarchy/config to ~/.config omarchy-refresh-config hypr/hyprland.conf
omarchy-refresh-applications Sync .desktop files & icons to user applications folder omarchy-refresh-applications
omarchy-state Manage marker files for reboot/relaunch requirements omarchy-state set reboot-required
omarchy-show-logo Display Omarchy ASCII logo omarchy-show-logo
omarchy-show-done Show a “Done” spinner until keypress omarchy-show-done
omarchy-snapshot Create or restore system snapshots via Snapper omarchy-snapshot create

This layout ensures each utility has a clear responsibility and is discoverable via omarchy-<command> in bin/. The modular design simplifies extending Omarchy with new CLI tools as needed.