quickshell-niri-panel

KO | EN

gitlite — search

#python #typescript #llm #golang #go #android #deep-learning #docker #nodejs #macos #cli #awesome-list #vue #ios

quickshell-niri-panel

(★ 17)

macOS-style top panel for niri Wayland compositor using Quickshell

quickshell-niri-panel Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Nirvana

> A blissful, minimal shell for Niri — peace in your workflow.

A lightweight top panel and control center for [Niri](https://github.com/YaLTeR/niri) Wayland compositor, built with [Quickshell](https://quickshell.outfoxxed.me/).

![Wayland](https://img.shields.io/badge/Wayland-Niri_25.11-blue?style=flat-square)
![Quickshell](https://img.shields.io/badge/Quickshell-0.2.1-green?style=flat-square)
![Qt](https://img.shields.io/badge/Qt-6.10-purple?style=flat-square)
![Arch](https://img.shields.io/badge/Tested-Arch_Linux-1793D1?style=flat-square&logo=arch-linux)

## 📸 Screenshots

| Fastfetch | Control Panel |
|:---------:|:-------------:|
| ![Fastfetch](https://raw.githubusercontent.com/parth-sarthi-code/quickshell-niri-panel/main/fastfetch.png) | ![Control Panel](https://raw.githubusercontent.com/parth-sarthi-code/quickshell-niri-panel/main/control_panel.png) |

Minimal Bar 
 <img src="minimal_bar.png" alt="Minimal Bar" /> 
 Expanded Bar (Network Speed + System Stats) 
 <img src="expanded_bar.png" alt="Expanded Bar" />

## ✨ Features

### Top Panel
- **Workspace Indicator** — Visual pills showing active/inactive workspaces
- **Focused App** — Currently focused window title
- **Network Speed** — Toggle-able upload/download monitor
- **Status Icons** — WiFi, Bluetooth, Battery, Airplane mode, Night light
- **Clock** — Clean time display

### Control Center
- **Quick Toggles** — WiFi, Bluetooth, Airplane Mode, Night Light
- **Sliders** — Volume (PipeWire), Brightness
- **Power Profiles** — Power Saver / Balanced / Performance
- **System Stats** — CPU usage, temperature, RAM
- **Media Controls** — Now playing with artist/title
- **Quick Actions** — Lock screen

## 📋 TODO

- [ ] Notifications
- [ ] Power menu
- [ ] Calendar widget
- [ ] System tray

## 🚀 Installation

### Install (Arch-based)

1) Get the config
```bash
git clone https://github.com/parth-sarthi-code/quickshell-niri-panel.git ~/.config/quickshell
```

2) Install dependencies (runtime):
- `quickshell` (or `quickshell-git`), `niri`, `qt6-base`, `qt6-declarative`
- Optional: the packages listed below (audio, brightness, network, etc.)

3) Build and install the qml-niri plugin (required):
```bash
sudo pacman -S --needed --noconfirm cmake git base-devel qt6-base qt6-declarative
cd /tmp
git clone https://github.com/imiric/qml-niri.git
cmake -S qml-niri -B qml-niri/build -DCMAKE_BUILD_TYPE=Release
cmake --build qml-niri/build
sudo cp -r qml-niri/build/Niri /usr/lib/qt6/qml/
```
Verify the plugin loads:
```bash
QML_IMPORT_PATH=/usr/lib/qt6/qml qml6 - <<'EOF'
import QtQuick
import Niri 0.1
Item {}
EOF
```
You should see no errors. If you do, ensure `QML_IMPORT_PATH` points to the parent directory containing `Niri/`.

4) Run quickshell with this config
```bash
quickshell -p ~/.config/quickshell
```

### Auto-start with Niri

Add to `~/.config/niri/config.kdl`:

```kdl
spawn-at-startup "sh" "-c" "LD_LIBRARY_PATH=/usr/lib/qt6/qml/Niri:$LD_LIBRARY_PATH quickshell"
```

## 🛠️ Dependencies

**Required:**
- [Quickshell](https://quickshell.outfoxxed.me/) >= 0.2.1 (`quickshell-git` on AUR)
- [Niri](https://github.com/YaLTeR/niri) >= 25.11
- Qt 6.10+

**Optional (tested on Arch Linux):**

| Category | Package | Description |
|----------|---------|-------------|
| Audio | `wireplumber` | PipeWire session manager |
| Audio | `playerctl` | Media controls |
| Hardware | `brightnessctl` | Brightness control |
| Hardware | `bluez` | Bluetooth support |
| Network | `networkmanager` | Network management |
| Power | `tuned` | Power profiles daemon |
| Display | `gammastep` | Night light / blue light filter |
| Display | `swaybg` | Wallpaper manager |
| Utilities | `fuzzel` | App launcher (Mod+Space) |
| Utilities | `swaylock` | Screen locker |
| Utilities | `mate-polkit` | Polkit authentication agent |
| Utilities | `fastfetch` | System info fetch tool |

**Recommended Apps (used in keybindings):**
- `ghostty` — Terminal (Mod+T)
- `google-chrome` — Browser (Mod+B)
- `nautilus` — File manager (Mod+E)

**Fonts:**
- `ttf-sf-pro` — SF Pro Display
- `otf-font-awesome` — Font Awesome icons
- `ttf-nerd-fonts-symbols` — Nerd Font icons

## 📁 Structure

```
~/.config/quickshell/
├── shell.qml           # Entry point
├── Config.qml          # Theme configuration
├── components/         # UI components
│   ├── TopPanel.qml
│   └── controlcenter/
├── services/           # System services
├── scripts/            # Install & utility scripts
│   ├── install.py
│   └── set-wallpaper.sh
└── niri/               # Niri config (installed to ~/.config/niri/)
    ├── config.kdl      # Optimized for Niri 25.11
    └── animations.kdl  # Custom animations (optional)
```

## ⌨️ Key Bindings (Niri 25.11)

| Binding | Action |
|---------|--------|
| `Alt+Tab` | Recent windows switcher (native) |
| `Mod+A` | Overview |
| `Mod+Space` | App launcher (fuzzel) |
| `Mod+T` | Terminal (ghostty) |
| `Mod+B` | Browser (google-chrome) |
| `Mod+E` | File manager (nautilus) |
| `Mod+M` | Maximize window to edges |
| `Mod+Q` | Close window |

## ⚙️ Configuration

Edit `Config.qml`:

```qml
readonly property int panelHeight: 32
readonly property real panelOpacity: 0.45
readonly property color accentColor: "#007AFF"
readonly property string fontFamily: "SF Pro Display, Inter, sans-serif"
```

## 📝 License

MIT

quickshell-niri-panel

quickshell-niri-panel Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

quickshell-niri-panel

quickshell-niri-panel Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README