Quick Start

Tsumiki is a modular status bar for Hyprland built on the Fabric widget system.

Prerequisites

Before starting, ensure you have:

• Hyprland — a working Hyprland installation
• JetBrains Nerd Font — sudo pacman -S ttf-jetbrains-mono-nerd
• Python 3.12+ — python --version should show 3.12 or higher

Quick Install

git clone https://github.com/rubiin/tsumiki.git ~/.config/tsumiki
cd ~/.config/tsumiki
./init.sh -setup
./init.sh -start

The -setup flag installs all required system packages and Python dependencies. You may be prompted for your password during setup.

For alternative install methods (bootstrap script, manual setup), see the full installation guide.

Autostart

Add this line to ~/.config/hypr/hyprland.conf:

exec-once = sleep 5; ~/.config/tsumiki/init.sh -start

Minimal Config

Here is a minimal config.toml to get started:

"$schema" = "./tsumiki.schema.json"

[general]
debug = false
auto_restart = true

[layout]
left_section = ["workspaces", "window_title"]
middle_section = ["date_time"]
right_section = ["volume", "battery", "system_tray"]

[modules.bar]
layer = "top"
location = "top"

[widgets.workspaces]
count = 10
hide_unoccupied = true

[widgets.volume]
tooltip = true

[widgets.battery]
tooltip = true

After saving, restart the bar:

pkill tsumiki
./init.sh -start

Next Steps

Configure your layout, test widgets, and make it yours.
Read guide → Learn about every widget, module, and option.
Read docs → Add Hyprland layer rules for blur and popup effects.
View rules → Common issues and troubleshooting advice.
Get help →