Installation#

Arch Linux#

Install the package from AUR.

paru -S python-ignis

For the latest (git) version of Ignis install python-ignis-git.

paru -S python-ignis-git

Nix#

Read more on the Nix page.

Void Linux#

An xbps-src template is available in a third party repository with prebuilt packages too.

Add this repository by creating ignis.conf at /etc/xbps.d/:

repository=https://raw.githubusercontent.com/binarylinuxx/ignis-xbps-src/x86_64-glibc/pkgs

Then, you can install Ignis as a usual package using xbps-install.

sudo xbps-install -S ignis

Pip#

Pip is the standard package manager for Python. You can install Ignis directly from the Git repository using Pip.

Hint

You can do this in a Python virtual environment. Create and activate one with the following commands:

python -m venv venv
source venv/bin/activate  # for fish: . venv/bin/activate.fish

To install the latest (Git) version of Ignis:

pip install git+https://github.com/ignis-sh/ignis.git

To install a specific version (e.g., v0.5):

# replace "TAG" with the desired Git tag
pip install git+https://github.com/ignis-sh/ignis.git@TAG

See also

For advanced usage, you can set up a development environment and install Ignis in editable mode. This allows you to easily switch between commits, versions, branches, or pull requests using git, without having to reinstall Ignis.

Building from source#

Dependencies:

  • ninja

  • meson

  • gtk4

  • gtk4-layer-shell

  • glib-mkenums (glib2-devel)

  • pygobject >= 3.50.0

  • pycairo

  • python-click

  • python-loguru

  • libpulse (if using PipeWire, install pipewire-pulse)

git clone https://github.com/ignis-sh/ignis.git
cd ignis
meson setup build --prefix=/usr
meson compile -C build
meson install -C build

Running#

ignis init