quickshell

What problem does it solve?

QuickShell conventions standardize QML-based desktop shell development on Wayland, reducing setup friction and inconsistencies across projects.

Core Features & Use Cases

• Entry point is shell.qml with ShellRoot as the root object
• One QML type per file — filename matches the type name (PascalCase)
• Use pragma Singleton + Singleton {} root for shared state (clocks, services, settings)
• Use Scope {} to group shared resources outside Variants — avoids duplicating processes/timers per screen
• Use Variants with model: Quickshell.screens + delegate: Component {} for multi-monitor support
• Consistent naming and inline component patterns to improve readability and maintainability

Quick Start

Create a new QuickShell project by starting with shell.qml and defining ShellRoot as the root object