Getting Started
Getting Started
Requirements, what the installer changes, and the shortest path to a working ArchEclipse session.
This guide is the short version. It covers what you need before installing, what the installer does to your system, and where to go next. Detailed flags and recovery options live in Installation.
Before you begin#
ArchEclipse is deployed by a Python installer that clones the repository to
~/ArchEclipse and checks the tracked dotfiles out into your home directory.
Treat it as a desktop environment installation, not a portable theme.
| Requirement | Notes |
|---|---|
| Arch Linux or a close Arch derivative | Upstream documentation targets Arch Linux. Other Arch-based distributions may work with varying results. |
| A working Hyprland installation | Install it first and confirm it starts. ArchEclipse replaces its configuration. |
| Python 3 | Used by install.py and the maintenance components. |
git, curl, sudo | The installer checks for and installs core tools. |
| An AUR helper | The installer offers to build yay or paru if neither exists. |
| Network access | Packages, wallpapers and the initial clone are downloaded. |
ArchEclipse installs packages, enables user timers, configures a greetd login
screen and can mask NetworkManager-wait-online.service as a boot-time tweak.
Review the installer steps
before accepting every prompt.
Install#
Run the official one-liner:
python3 <(curl -fsSL https://raw.githubusercontent.com/AymanLyesri/ArchEclipse/refs/heads/master/.config/hypr/maintenance/install.py)The script requests sudo once, clones the master branch, then presents a plan
of optional steps. Select an AUR helper when prompted. A different branch can be
requested with --branch <name> or ARCHECLIPSE_BRANCH=<name>.
When it finishes, reboot and select the Hyprland session from greetd. Continue with First Boot.
Keep it updated#
archeclipse is a Zsh function defined in ~/.config/zsh/40-functions.zsh. It
downloads and runs the current updater, which resets the local checkout and
reinstalls packages from the embedded list.
archeclipseYou can also run the local updater directly:
python3 ~/.config/hypr/maintenance/update.pyWhere to next#
- Installation — installer prompts, branches, updating and removal.
- First Boot — the greetd session and the first five minutes.
- Desktop Overview — bar, launcher, panels and workspace layout.
- Configuration — how the Hyprland and Quickshell configuration is structured.