Installation¶
Pre-built packages are available from the GitHub Releases page and as CI artifacts on pull requests.
Debian / Ubuntu¶
Download the .deb package for your architecture and install. Both
amd64 and arm64 builds are published:
sudo dpkg -i ryll_0.1.0-1_amd64.deb # or ryll_0.1.0-1_arm64.deb
sudo apt-get install -f # install any missing dependencies
The package installs ryll to /usr/bin/ryll. Runtime dependencies
(libc, libssl) are detected automatically and will be pulled in by
apt-get install -f if missing.
Red Hat / Fedora (RPM)¶
Download the .rpm package for your architecture and install. Both
x86_64 and aarch64 builds are published:
Or with older yum-based systems:
The package installs ryll to /usr/bin/ryll. Runtime shared library
dependencies are detected automatically and resolved by your package
manager.
macOS (Homebrew)¶
Ryll is available for Apple Silicon Macs via a Homebrew tap:
Or add the tap first, then install:
Only Apple Silicon (aarch64) is supported. Intel Macs are not supported as Apple has dropped security updates for all x86 Macs.
Alternatively, download the tarball from
GitHub Releases
and copy the binary to a directory on your PATH:
Windows¶
Download the .zip archive for your architecture from
GitHub Releases
(both x86_64-pc-windows-msvc and aarch64-pc-windows-msvc are
published), extract it, and run ryll.exe:
To make it available system-wide, move ryll.exe to a directory
on your PATH.
Note that --capture mode is not available on Windows builds.
pip (Python, Linux only)¶
pip install ryll (or pip install shakenfist-client[vdi]) installs a
per-architecture manylinux wheel with the compiled ryll GUI binary
already embedded — no runtime download, no cache, works offline
immediately after install. Wheels are published for Linux
x86_64/aarch64 with glibc >= 2.28 (built in the manylinux_2_28
container); other platforms — macOS, Windows, musl libc, or older
glibc — should use one of the packages above.
The binary is the same GUI application as every other install path, so it needs the underlying GUI/audio system libraries at runtime, which pip cannot install:
On newer distributions (Debian trixie, Ubuntu 24.04+) the ALSA runtime
package was renamed libasound2t64 as part of the 64-bit time_t
transition, so install libasound2t64 in place of libasound2 there.
If one is missing, ryll fails to start with a dynamic-loader or
GUI-initialisation error naming the library; install the packages above
to resolve it. remote-viewer is the fallback whenever ryll can't be
installed or run on a given platform.
See plans/PLAN-pip-distribution.md for the full design rationale.
Building from source¶
If no pre-built package is available for your platform, you can build ryll from source. See the development guide for build instructions and the portability guide for platform-specific notes.
For macOS development and interactive testing, see the macOS development guide.