Start Here: Requirements and Installation

Welcome to Omarchy’s bootstrapping and installation guide. This section covers everything you need to get started on a fresh Arch Linux x86_64 system: from prerequisites and environment variables to cloning the repository and running the installer.

Index

• Requirements
• Environment Variables
• Bootstrap Script
• Installer Orchestrator
• Installation Flow Diagram
• Next Steps

Requirements

Before bootstrapping Omarchy, ensure your system meets these prerequisites:

• Operating System: Arch Linux x86_64 (vanilla install)
• Privileges: A user with sudo access
• Network: Active internet connection for package downloads
• Disk: Minimum 20 GB free space for packages and configs
• Console: Bash shell (default in Arch)

Environment Variables

Omarchy bootstrap and installer rely on a few key environment variables. You can override defaults to customize the installation source and branch.

• Override any of these via export before running the bootstrap.

Bootstrap Script

The bootstrap script installs Git, clones the Omarchy repository into ~/.local/share/omarchy, checks out the requested ref, and launches the installer.

#!/usr/bin/env bash
# Install Git if missing
sudo pacman -Syu --noconfirm --needed git

# Determine repository and branch (can be overridden)
OMARCHY_REPO="${OMARCHY_REPO:-basecamp/omarchy}"
OMARCHY_REF="${OMARCHY_REF:-master}"

echo -e "\nCloning Omarchy from https://github.com/${OMARCHY_REPO}.git"
rm -rf ~/.local/share/omarchy/
git clone "https://github.com/${OMARCHY_REPO}.git" ~/.local/share/omarchy >/dev/null

# Checkout custom ref if specified
if [[ $OMARCHY_REF != "master" ]]; then
  echo -e "\nUsing branch: $OMARCHY_REF"
  cd ~/.local/share/omarchy
  git fetch origin "$OMARCHY_REF" && git checkout "$OMARCHY_REF"
  cd -
fi

echo -e "\nInstallation starting."
source ~/.local/share/omarchy/install.sh

• Installs Git via Pacman
• Clones Omarchy into $HOME/.local/share/omarchy
• Checks out a non-master ref if set
• Sources the main installer (install.sh) to begin the process

Installer Orchestrator

Once sourced, install.sh orchestrates the full setup in five phases:

#!/usr/bin/env bash
set -eE

OMARCHY_PATH="$HOME/.local/share/omarchy"
OMARCHY_INSTALL="$OMARCHY_PATH/install"
export PATH="$OMARCHY_PATH/bin:$PATH"

# 1. Preflight checks
source $OMARCHY_INSTALL/preflight/show-env.sh
source $OMARCHY_INSTALL/preflight/trap-errors.sh
source $OMARCHY_INSTALL/preflight/guard.sh
source $OMARCHY_INSTALL/preflight/chroot.sh
source $OMARCHY_INSTALL/preflight/pacman.sh
source $OMARCHY_INSTALL/preflight/migrations.sh
source $OMARCHY_INSTALL/preflight/first-run-mode.sh

# 2. Packaging
source $OMARCHY_INSTALL/packages.sh
source $OMARCHY_INSTALL/packaging/fonts.sh
source $OMARCHY_INSTALL/packaging/lazyvim.sh
source $OMARCHY_INSTALL/packaging/pins.sh
source $OMARCHY_INSTALL/packaging/tuis.sh
source $OMARCHY_INSTALL/packaging/webapps.sh

# 3. Configuration
source $OMARCHY_INSTALL/config/config.sh
source $OMARCHY_INSTALL/config/theme.sh
source $OMARCHY_INSTALL/config/branding.sh
# ... (many more config scripts)

# 4. Login preparation
source $OMARCHY_INSTALL/login/plymouth.sh
source $OMARCHY_INSTALL/login/limine-snapper.sh
source $OMARCHY_INSTALL/login/alt-bootloaders.sh

# 5. Finishing
source $OMARCHY_INSTALL/reboot.sh

• Preflight: Validates environment, configures Pacman, applies migrations
• Packaging: Installs curated system and AUR packages
• Configuration: Deploys dotfiles, theming, hardware tweaks
• Login Prep: Integrates splash screens, snapshots, bootloader entries
• Finish: Cleans up and reboots into your new Hyprland desktop

Installation Flow Diagram

flowchart TD
  A[Start: Bootstrap Script] --> B[Clone & Checkout Omarchy]
  B --> C[Source install.sh]
  C --> D[Preflight Checks]
  D --> E[Package Installation]
  E --> F[System Configuration]
  F --> G[Login Preparation]
  G --> H[Finalization & Reboot]

This flowchart visualizes how the bootstrap hands off to install.sh, which then runs through each phased stage.

Next Steps

1. After reboot, log in to your new Hyprland session.
2. Explore Omarchy commands via omarchy-menu (Super + Space).
3. Consult the Omarchy Manual for advanced customization:
   ~/.local/share/omarchy/manual

You’re now ready to enjoy a fully automated, curated Arch Linux desktop powered by Hyprland. Happy computing!