Installation

Sunsetr can be installed through several methods depending on your distribution and preferences.

Dependencies

Optional for Hyprland Users

  • Hyprland >= 0.49.0
  • hyprsunset >= v0.2.0 (only if using the hyprsunset backend)

For Other Wayland Compositors

  • Any Wayland compositor supporting wlr-gamma-control-unstable-v1 protocol
  • No external dependencies - uses native Wayland protocols

Build from Source

Installing

First, clone the repository:

git clone https://github.com/psi4j/sunsetr.git &&
cd sunsetr

Then install using cargo-make:

# Install cargo-make if you don't have it already
cargo install cargo-make

# Then install system-wide (requires sudo)
cargo make install
# Or install to ~/.local (no sudo)
cargo make install-local

Or install manually:

# Build with cargo
cargo build --release

# Then install manually
sudo cp target/release/sunsetr /usr/local/bin/

Uninstalling

If you used cargo make install:

cargo make uninstall

If you manually copied the binary:

sudo rm /usr/local/bin/sunsetr

Arch Linux (AUR)

sunsetr, sunsetr-git, and sunsetr-bin are available in the AUR:

sunsetr (Latest Version)

paru -S sunsetr

sunsetr-git (Development Version)

paru -S sunsetr-git

sunsetr-bin (Pre-compiled Binary)

paru -S sunsetr-bin

Recommendation: Use sunsetr for stability, or sunsetr-git if you want to help test the latest features.

NixOS

sunsetr is available in nixpkgs unstable.

NixOS Configuration

Add to your configuration.nix:

environment.systemPackages = with pkgs; [
  sunsetr
];

Then rebuild your system:

sudo nixos-rebuild switch

Imperative Installation

For non-NixOS systems or user-level installation:

nix-env -iA nixpkgs.sunsetr

Install using nix-shell

Test sunsetr without permanently installing it:

nix-shell -p sunsetr

Using Flakes

A flake is available for those wanting to use the latest version from main without waiting for it to be added to nixpkgs.

Add sunsetr to your flake inputs:

{
  inputs.sunsetr.url = "github:psi4j/sunsetr";
}

Then use it in your configuration:

{ inputs, pkgs, ... }:
{
  # Install as a system package
  environment.systemPackages = [
    inputs.sunsetr.packages.${pkgs.system}.sunsetr
  ];

  # OR with home-manager
  home.packages = [
    inputs.sunsetr.packages.${pkgs.system}.sunsetr
  ];
}

Other Distributions

Fedora / RHEL (Copr)

Coming soon! Copr repository support is planned.

Debian / Ubuntu

Coming soon! .deb packages are planned for Debian-based distributions.

Manual Installation (Any Distribution)

If your distribution isn't listed above, you can build from source:

  1. Install Rust and Cargo (if not already installed):

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  2. Follow the Build from Source instructions above.

Verifying Installation

After installation, verify sunsetr is available:

sunsetr --version

You should see output with the current version number.

Next Steps

Now that sunsetr is installed, you can follow the Quick Start guide to continue setting things up.