tpaau/shell

My custom desktop shell made with Quickshell for Niri.

Warning

This project is early development, and I do not provide an installation method yet. You can still try it though!

If you want to get updates on the state of the project, and to let me know that you do want to see this shell released, consider starring this repo!

Table of contents

• Screenshots
• Features
• Dependencies
• Try it
• Roadmap to alpha
• FAQ
  • What window managers are supported?
• Credit
  • Other software

Screenshots

That's what you're here for, right?

Frieren	Rain Worl
Application launcher	Lock screen

Features

• Support for the Niri compositor
• Material design
• Matugen color generation
• Shell modules
  • Status bar
  • Notification service with cross-session persistence
  • Quick settings
  • Application launcher
  • Session lock with multiple authentication methods
  • Session management
  • Volume and brightness OSD

Dependencies

• Niri
• Quickshell
• swayidle (to be removed)
• swaylock (to be removed)
• matugen
• UPower daemon
  • Power profiles daemon

Try it

While I do not provide an installation method just yet, you can still try the shell!

1. Clone the repo

git clone https://github.com/tpaau/shell
cd shell

2. Install the required dependencies

• You will also need cargo and optionally just
• swaylock is not a required dependency if you're just testing things out

3. Run the shell

Warning

The shell will mess with Niri config files in ~/.config/niri, so please make sure to back them up.

Run just run-dev, or copy the list of commands from the justfile and run them manually.

Note

The shell will create its data, config, and cache directories:

• ~/.local/share/tpaau-shell/
• ~/.config/tpaau-shell/
• ~/.cache/tpaau-shell/

You can easily remove them with just rm-shell-dirs.

If you updated the shell and now you get unexpected behavior or file errors, try removing these directories.

Roadmap to alpha (subject to change)

• Add the settings app
• Test support for multiple monitors
• Add a custom polkit agent
• Add dock
• Create packages for Fedora and Arch

FAQ

Will other window managers be supported?

No, I want to focus on the shell doing one thing and doing it well. I do not plan on supporting other compositors.

Credit

My dots would be worthless without the amazing software they are made for! Give the devs of these projects a big thanks!

• Quickshell
• Niri

Other software

• Depth Anything - Image depth generator
• just - Just a command runner