Skip to content

Installation

Pearl requires Aqueous: packages depend on aqueous>0.7, and the settings integration needs aqueous-config 0.8.2 or newer. The shell package bundles pearl, pearlctl, pearl-lock, pearl-settings, pearl-themes, pearl-agent, the desktop portal backend, and the Phyto, Dome, and Coral companion applications. The login greeter is a separate package that runs on ordinary Aqueous and is independent of the shell.

The seafoam-labs repository publishes the Git shell and greeter, the optional Qt style package, and the matching Aqueous Git desktop stack.

Add it to Shelly or pacman by following the repository setup instructions. The key import, repository entry and sync commands there are generated from the repository’s published address and current signing key.

Then install:

Pearl shell (Git)

Terminal window
shelly -Is pearl-git

Install the Aqueous Git desktop alongside it if you do not already run Aqueous: aqueous-core-git, aqueous-git, aqueous-session-git, aqueous-integration-pearl-git, aqueous-shell-pearl-git, and xdg-desktop-portal-aqueous-git. The repository also publishes the stable Aqueous stack (aqueous, aqueous-session, aqueous-integration-pearl, aqueous-shell-pearl); the stable Pearl package is not published there yet.

Optional packages in the same repository:

  • pearl-greeter-git: the greetd login screen. Installing it selects Pearl Greeter as the display manager for the next boot and backs up an existing /etc/greetd/config.toml. Nothing is restarted; reboot when ready. See the greeter documentation.
  • pearl-darkly-style with qtengine: Darkly application styles for shared Qt 5/6 appearance management.

You can browse the full catalog at repo.seafoam-labs.org.

Recipe Packages Purpose
packaging/arch pearl Stable shell built from the published release tag.
packaging/arch-git pearl-git, pearl-greeter-git Split Git build from upstream; co-installable with the stable package.
packaging/arch-darkly-style* pearl-darkly-style variants Optional Qt Darkly application styles.
packaging/Devario pearl, pearl-greeter, pearl-git, pearl-greeter-git, devario-desktop Stable and Git recipes used to build the Devario desktop.

Building requires Zig 0.16.0 exactly, plus git, pkgconf, gcc, qt5-base, qt6-base, Python, rust, rust-wasm, and librsvg; makepkg -s resolves these together with the GTK 4 runtime libraries.

Build the Git shell and greeter:

Terminal window
git clone https://github.com/Seafoam-Labs/pearl.git
cd pearl/packaging/arch-git
makepkg -s
sudo pacman -U ./pearl-git-*.pkg.tar.zst ./pearl-greeter-git-*.pkg.tar.zst

Install only the greeter by passing its archive alone to pacman -U. The Git package suffixes its binaries (pearl-git, pearlctl-git, and so on), so it can coexist with a stable installation. The stable recipe in packaging/arch fetches the release tag, which must be published before the build succeeds.

A plain development build without packaging:

Terminal window
ZIG_GLOBAL_CACHE_DIR="$PWD/.cache/zig" zig build -Doptimize=ReleaseSafe

Enable the desktop services you want; Pearl degrades gracefully without them:

Package Enables
networkmanager Wi-Fi controls and saved profiles.
bluez Bluetooth pairing and discovery.
upower Battery status.
power-profiles-daemon Power profile switching.
qtengine Shared Qt 5/6 appearance management.
pearl-assistant-runtime or llama-cpp Local model runtime for the launcher assistant.
foot, kitty, alacritty, konsole or xterm Terminal for the assistant’s interactive runtime setup; Arch also needs sudo.
gvfs, file-roller Phyto file manager extras.
nvidia-utils NVIDIA GPU metrics in Dome.
  1. Install an Aqueous desktop. See the Aqueous installation guide.

  2. Select Aqueous from the display manager’s Wayland session list.

  3. On a fresh Aqueous desktop, Welcome offers a shell choice. Select Pearl, then complete setup. Existing selections and personal configuration are retained.

The Aqueous session starts Pearl as a user service; pearl-git uses its own suffixed service and can run beside a stable installation.

© 2026 Seafoam LabsShelly Chel