<p align="center">
    <strong>🫂 niri-companion</strong>
</p>

<p align="center">
  niri-companion is a toolkit that adds extra functionality to
  <a href="https://github.com/YaLTeR/niri">niri</a>
</p>

<p align="center">
  <a href="https://pypi.org/project/niri-companion/">
    <img src="https://img.shields.io/pepy/dt/niri-companion" alt="Pepy Total Downloads" />
  </a>
  <a href="https://pypi.org/project/niri-companion/">
    <img src="https://img.shields.io/pypi/v/niri-companion" alt="PyPI - Version" />
  </a>
  <a href="https://pypi.org/project/niri-companion/">
    <img src="https://img.shields.io/pypi/l/niri-companion" alt="PyPI - License" />
  </a>
</p>

<p align="center">
  <strong><a href="https://github.com/dybdeskarphet/niri-companion/wiki">Wiki</a></strong>
  &bull;
  <strong><a href="./CHANGELOG.md">Changelog</a></strong>
</p>

## Overview

- `niri-genconfig` – allows having configuration groups for layered `niri ✨` setups
- `niri-workspaces` – creates sessions for different tasks.
- `niri-ipcext` – performs IPC-like modifications.

## Installation

Install with `pipx`, `pip` or `uv` accordingly:

```
pipx install niri-companion
pip install niri-companion
uv tool install niri-companion
```

- For Arch-based distributions, you can use the [`niri-companion`](https://aur.archlinux.org/packages/niri-companion) AUR package
  - `git clone https://aur.archlinux.org/niri-companion.git && cd niri-companion && makepkg -si` **(recommended)**
  - `paru -S niri-companion`
  - `yay -S niri-companion`
- For Debian-based distributions, you can use the [`niri-companion`](https://tracker.debian.org/pkg/niri-companion) package (Available in Debian 14 and Above)
  - `apt install niri-companion`
