dux-shell README

The project's README from github.com/duxlabs-dev/dux-shell. As one markdown file: README.md.

Dux Modular Shell

Dux Modular Shell

A modern desktop shell for Wayland

Built with Quickshell and Go, running on dux-qt-base

Documentation GitHub stars GitHub License GitHub release Arch version AUR version (git) Ko-Fi donate Discord

Dux Modular Shell (DMS) is a complete desktop shell for niri, Hyprland, MangoWC, Sway, labwc, Scroll, Miracle WM, and other Wayland compositors. It replaces waybar, swaylock, swayidle, mako, fuzzel, polkit, and everything else you'd normally stitch together to make a desktop.

Repository Structure

This is a monorepo containing both the shell interface and the core backend services:

dux-shell/
├── quickshell/         # QML-based shell interface
│   ├── Modules/        # UI components (panels, widgets, overlays)
│   ├── Services/       # System integration (audio, network, bluetooth)
│   ├── Widgets/        # Reusable UI controls
│   └── Common/         # Shared resources and themes
├── core/               # Go backend and CLI
│   ├── cmd/            # dms CLI and duxinstall binaries
│   ├── internal/       # System integration, IPC, distro support
│   └── pkg/            # Shared packages
├── distro/             # Distribution packaging
│   ├── fedora/         # Fedora RPM specs
│   ├── debian/         # Debian packaging
│   └── nix/            # NixOS/home-manager modules
└── flake.nix           # Nix flake for declarative installation

See it in Action

https://github.com/user-attachments/assets/d310418b-cc44-4ace-ac0d-2fc0c851291d

More Screenshots
Desktop Dashboard Launcher Control Center

Installation

curl -fsSL https://install.duxlabs.dev | sh

One command installs DMS and all dependencies on Arch, Fedora, Debian, Ubuntu, openSUSE, or Gentoo.

FreeBSD: native support is included in-tree; see distro/freebsd/README.md for supported integrations and setup notes.

Manual installation guide

Features

Dynamic Theming Wallpaper-based color schemes that automatically theme GTK, Qt, terminals, editors (vscode, vscodium), and more using matugen and dank16.

System Monitoring Real-time CPU, RAM, GPU metrics and temperatures built into the dms daemon (powered by dgop). Process list with search and management.

Powerful Launcher Spotlight-style search for applications, files (dsearch), emojis, running windows, calculator, and commands. Extensible with plugins.

Control Center Unified interface for network, Bluetooth, audio devices, display settings, and night mode.

Smart Notifications Notification center with grouping, rich text support, and keyboard navigation.

Media Integration MPRIS player controls, calendar sync, weather widgets, and clipboard history with image previews.

Session Management Lock screen, idle detection, auto-lock/suspend with separate AC/battery settings, and a settings front-end for dux-greeter.

Plugin System Extend functionality with the plugin registry. DMS keeps ~/.config/dms/plugins.lock.json synchronized with managed plugin installs and their exact Git commits, so the same plugins can be reproduced on another machine.

Supported Compositors

Works best with niri, Hyprland, Sway, MangoWC, labwc, Scroll, and Miracle WM with full workspace switching, overview integration, and monitor management. Other Wayland compositors work with reduced features.

Compositor configuration guide

Command Line Interface

Control the shell from the command line or keybinds:

dms run              # Start the shell
dms ipc call spotlight toggle
dms ipc call audio setvolume 50
dms ipc call wallpaper set /path/to/image.jpg
dms brightness list  # List available displays
dms plugins search   # Browse plugin registry
dms plugins lock     # Refresh the portable plugin lockfile
dms plugins restore ~/plugins.lock.json

Full CLI and IPC documentation

Documentation

Dux Projects

DMS is one piece of the suite. The rest lives in its own repos:

Development

See component-specific documentation:

See CONTRIBUTING.md for editor setup, the i18n workflow, and Go style guidelines.

Building from Source

Core + Duxinstall:

cd core
make              # Build dms CLI
make duxinstall   # Build installer

Shell:

quickshell -p quickshell/

NixOS:

{
  inputs.dms.url = "github:duxlabs-dev/dux-shell";

  # Use in home-manager or NixOS configuration
  imports = [ inputs.dms.homeModules.dank-material-shell ];
}

Contributing

Contributions welcome. Bug fixes, widgets, features, translation, documentation and plugins all help.

Credits

Star History

Star History Chart

License

MIT License - See LICENSE for details.

dux-shell (duxlabs-dev/dux-shell)

Searching Database…

What is this?It's a complete desktop shell for Wayland, built with Quickshell and Go. It replaces the separate tools you'd normally stitch together, such as a bar, lock screen, idle manager, notifications, launcher and polkit agent.
Is it a window manager or just a bar?It's not a window manager itself. It runs on top of an existing Wayland compositor like niri, Hyprland or Sway and handles the desktop around it.
What's the catch?Other Wayland compositors work, but with reduced features. FreeBSD has in-tree support with its own setup notes in distro/freebsd/README.md.
Does it show CPU, RAM and GPU usage itself?Yes. The dms daemon has built-in real-time CPU, RAM and GPU metrics plus temperatures, powered by dgop, along with a searchable process list where you can manage processes.
Does it theme my apps from my wallpaper?Yes. It builds color schemes from the wallpaper using matugen and dank16 and applies them to GTK, Qt, terminals and editors such as vscode and vscodium.
Can the launcher search files and run commands?Yes. Besides apps, it searches files via dsearch, emojis, running windows and calculator results, runs commands, and can be extended with plugins.
Size
180.9 MB
Stars
9.1K
Age
1y
Commits · 90 Days