nixpkgs-wayland
Automated, pre-built packages for Wayland (sway/wlroots) tools on NixOS, often containing unreleased versions.
What is nixpkgs-wayland?
nixpkgs-wayland is a Nix overlay that provides automated, pre-built packages for Wayland compositors and tools, primarily for NixOS. It solves the problem of accessing the latest, often pre-release, versions of Wayland software like sway and wlroots utilities without manual compilation. The project maintains a binary cache and continuously updates packages from upstream source control.
NixOS users and developers who want the latest Wayland desktop tools, particularly those using sway or other wlroots-based compositors and seeking pre-release software.
Developers choose nixpkgs-wayland for immediate access to cutting-edge Wayland packages with automated updates and pre-built binaries, reducing manual effort and ensuring compatibility within the Nix ecosystem.
Overview
Automated, pre-built packages for Wayland (sway/wlroots) tools for NixOS. [maintainers=@colemickens, @Artturin]
Use Cases
Best For
- NixOS users wanting the latest sway and wlroots tools
- Accessing pre-release versions of Wayland software on Nix
- Setting up a Wayland desktop with automated package updates
- Using binary caches for faster installation of Wayland packages
- Developing or testing against newest Wayland protocols and compositors
- Managing Wayland utilities as a Nix overlay or flake
Not Ideal For
- Production systems requiring stable, long-term supported versions of Wayland software
- Users on non-NixOS distributions or those not using the Nix package manager
- Projects that rely on X11 or non-wlroots based Wayland compositors
Pros & Cons
Pros
Packages are automatically updated to the latest upstream versions, often including pre-release builds, as the README states they 'often contain unreleased versions' from source control.
Pre-built packages are available via Cachix for faster installation without local compilation, mentioned in the Binary Cache section and supported by CI workflows.
Includes a wide range of Wayland utilities from compositors like sway to tools for screenshots, notifications, and display management, as shown in the detailed Packages list.
Works as an overlay for both NixOS and non-NixOS users with support for flakes and traditional Nix expressions, detailed in multiple usage examples in the README.
Cons
Frequently includes unreleased versions that may be buggy or breaking, as the README warns packages are 'auto-updated' and 'often contain unreleased' software, risking stability.
Packages are built against the nixos-unstable channel, which can introduce compatibility issues or unexpected changes, as noted in the CI descriptions relying on this channel.
The project lacks CI on Pull Requests, which could lead to untested contributions being merged, as admitted in the Continuous Integration section with 'no CI on Pull Requests'.
Frequently Asked Questions
Related Projects
NURNix User Repository: User contributed nix packages [maintainer=@Pandapip1]
System ManagerManage system config using nix on any distro
chaotic-nyxNix flake for "too much bleeding-edge" and unreleased packages (e.g., mesa_git, linux_cachyos, firefox_nightly, sway_git, gamescope_git). And experimental modules (e.g., HDR, duckdns).
zig-overlayNix flake for the Zig compiler.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.