https://github.com/malpenzibo/ashell
A ready to go Wayland status bar for Hyprland
https://github.com/malpenzibo/ashell
bar hyprland iced-rs statusbar wayland wlroots
Last synced: about 1 year ago
JSON representation
A ready to go Wayland status bar for Hyprland
- Host: GitHub
- URL: https://github.com/malpenzibo/ashell
- Owner: MalpenZibo
- License: mit
- Created: 2023-07-05T17:10:23.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T21:46:38.000Z (about 1 year ago)
- Last Synced: 2025-04-01T22:34:02.579Z (about 1 year ago)
- Topics: bar, hyprland, iced-rs, statusbar, wayland, wlroots
- Language: Rust
- Homepage:
- Size: 5.2 MB
- Stars: 126
- Watchers: 5
- Forks: 15
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ashell
A ready to go Wayland status bar for Hyprland.
Feel free to fork this project and customize it for your needs or just open an
issue to request a particular feature.
> If you have graphical issues like missing transparency or graphical artifact you could launch ashell with WGPU_BACKEND=gl. This env var forces wgpu to use OpenGL instead of Vulkan
### Does it only work on Hyprland?
While it's currently tailored for Hyprland, it could work with other compositors.
However, it currently relies on [hyprland-rs](https://github.com/hyprland-community/hyprland-rs)
to gather information about the active window and workspaces. I haven't implemented any
feature flags to disable these functionalities or alternative methods to obtain this data.
## Install
[](https://repology.org/project/ashell/versions)
### Arch Linux
You can get the official Arch Linux package from the AUR:
#### Tagged release
```
paru/yay -S ashell
```
#### Main branch
```
paru/yay -S ashell-git
```
### ALT Linux
```
su -
apt-get install ashell
```
### Nix
To install ashell using the nix package be sure to enable flakes and then run
#### Tagged release
```
nix profile install github:MalpenZibo/ashell?ref=0.3.1
```
#### Main branch
```
nix profile install github:MalpenZibo/ashell
```
### NixOS
I haven't tested ashell on NixOS.
To enable this flake use
```nix
{ pkgs, ... }:
{
environment.systemPackages = with pkgs; [
(import (pkgs.callPackage (pkgs.fetchFromGitHub {
owner = "MalpenZibo";
repo = "ashell";
rev = "refs/heads/main"; # Or specify the branch/tag you need
sha256 = "sha256-PLACEHOLDER"; # Replace with the correct hash
}) {}).defaultPackage.x86_64-linux)
];
}
```
> I'm not an expert and I haven't tested this configuration
> but I'm quite sure that if you use NixOS you are smart enough to add ashell to your configuration :D
## Features
- App Launcher button
- Сlipboard button
- OS Updates indicator
- Hyprland Active Window
- Hyprland Workspaces
- System Information (CPU, RAM, Temperature)
- Hyprland Keyboard Layout
- Hyprland Keyboard Submap
- Tray
- Date time
- Privacy (check microphone, camera and screenshare usage)
- Media Player
- Settings panel
- Power menu
- Battery information
- Audio sources and sinks
- Screen brightness
- Network stuff
- VPN
- Bluetooth
- Power profiles
- Idle inhibitor
- Airplane mode
## Configuration
> The following are the configuration for the `main` branch and could contain breaking changes.
> For the tagged release you can find the configuration instruction in the corresponding README file.
> eg: https://github.com/MalpenZibo/ashell/blob/0.4.1/README.md
The configuration file uses the toml file format and is named `~/.config/ashell/config.toml`
```toml
# Ashell log level filter, possible values "debug" | "info" | "warn" | "error". Needs reload
logLevel = "warn"
# Possible status bar outputs, values could be: all, active, or a list of outputs
# all: the status bar will be displayed on all the available outputs, example: outputs = "all"
# active: the status bar will be displayed on the active output, example: outputs = "active"
# list of outputs: the status bar will be displayed on the outputs listed here, example: outputs = { targets = ["DP-1", "eDP-1"] }
# if the outputs is not available the bar will be displayed in the active output
outputs = "all"
# Bar position, possible values top | bottom.
position = "top"
# App launcher command, it will be used to open the launcher,
# without a value the related button will not appear
# optional, default None
appLauncherCmd = "~/.config/rofi/launcher.sh"
# Clipboard command, it will be used to open the clipboard menu,
# without a value the related button will not appear
# optional, default None
clipboardCmd = "cliphist-rofi-img | wl-copy"
# Maximum number of chars that can be present in the window title
# after that the title will be truncated
# optional, default 150
truncateTitleAfterLength = 150
# Declare which modules should be used and in which position in the status bar.
# This is the list of all possible modules
# - appLauncher
# - updates
# - clipboard
# - workspaces
# - windowTitle
# - systemInfo
# - keyboardLayout
# - keyboardSubmap
# - tray
# - clock
# - privacy
# - mediaPlayer
# - settings
# optional, the following is the default configuration
[modules]
# The modules that will be displayed on the left side of the status bar
left = [ "workspaces" ]
# The modules that will be displayed in the center of the status bar
center = [ "windowTitle" ]
# The modules that will be displayed on the right side of the status bar
# The nested modules array will form a group sharing the same element in the status bar
right = [ "systemInfo", [ "clock", "privacy", "settings" ] ]
# Update module configuration.
# Without a value the related button will not appear.
# optional, default None
[updates]
# The check command will be used to retrieve the update list.
# It should return something like `package_name version_from -> version_to\n`
checkCmd = "checkupdates; paru -Qua"
# The update command is used to init the OS update process
updateCmd = 'alacritty -e bash -c "paru; echo Done - Press enter to exit; read" &'
# Workspaces module configuration, optional
[workspaces]
# The visibility mode of the workspaces, possible values are:
# all: all the workspaces will be displayed
# monitorSpecific: only the workspaces of the related monitor will be displayed
# optional, default all
visibilityMode = "all"
# Enable filling with empty workspaces
# For example:
# With this flag set to true if there are only 2 workspaces,
# the workspace 1 and the workspace 4, the module will show also
# two more workspaces, the workspace 2 and the workspace 3
# optional, default false
enableWorkspaceFilling = false
# The system module configuration
[system]
# cpu indicator warning level (default 60)
cpuWarnThreshold = 60
# cpu indicator alert level (default 80)
cpuAlertThreshold = 80
# mem indicator warning level (default 70)
memWarnThreshold = 70
# mem indicator alert level (default 85)
memAlertThreshold = 85
# temperature indicator warning level (default 60)
tempWarnThreshold = 60
# temperature indicator alert level (default 80)
tempAlertThreshold = 80
# Clock module configuration
[clock]
# clock format see: https://docs.rs/chrono/latest/chrono/format/strftime/index.html
format = "%a %d %b %R"
# Media player module configuration
[mediaPlayer]
# optional, default 100
maxTitleLength = 100
# Settings module configuration
[settings]
# command used for lock the system
# without a value the related button will not appear
# optional, default None
lockCmd = "hyprlock &"
# command used to open the sinks audio settings
# without a value the related button will not appear
# optional default None
audioSinksMoreCmd = "pavucontrol -t 3"
# command used to open the sources audio settings
# without a value the related button will not appear
# optional, default None
audioSourcesMoreCmd = "pavucontrol -t 4"
# command used to open the network settings
# without a value the related button will not appear
# optional, default None
wifiMoreCmd = "nm-connection-editor"
# command used to open the VPN settings
# without a value the related button will not appear
# optional, default None
vpnMoreCmd = "nm-connection-editor"
# command used to open the Bluetooth settings
# without a value the related button will not appear
# optional, default None
bluetoothMoreCmd = "blueman-manager"
# Appearance config
# Each color could be a simple hex color like #228800 or an
# object that define a base hex color and two optional variant of that color (a strong one and a weak one)
# and the text color that should be used with that base color
# example:
# [appearance.backgroundColor]
# base = "#448877"
# strong = "#448888" # optional default autogenerated from base color
# weak = "#448855" # optional default autogenarated from base color
# text = "#ffffff" # optional default base text color
[appearance]
# optional, default iced.rs font
fontName = "Comic Sans MS"
# The style of the main bar, possible values are: islands | solid | gradient
# optional, default islands
style = "islands"
# The opacity of the main bar, possible values are: 0.0 to 1.0
# optional, default 1.0
opacity = 0.7
# used as a base background color for header module button
backgroundColor = "#1e1e2e"
# used as a accent color
primaryColor = "#fab387"
# used for darker background color
secondaryColor = "#11111b"
# used for success message or happy state
successColor = "#a6e3a1"
# used for danger message or danger state (the weak version is used for the warning state
dangerColor = "#f38ba8"
# base default text color
textColor = "#f38ba8"
# this is a list of color that will be used in the workspace module (one color for each monitor)
workspaceColors = [ "#fab387", "#b4befe" ]
# this is a list of color that will be used in the workspace module
# for the special workspace (one color for each monitor)
# optional, default None
# without a value the workspaceColors list will be used
specialWorkspaceColors = [ "#a6e3a1", "#f38ba8" ]
# menu options
[appearance.menu]
# The opacity of the menu, possible values are: 0.0 to 1.0
# optional, default 1.0
opacity = 0.7
# The backdrop of the menu, possible values are: 0.0 to 1.0
# optional, default 0.0
backdrop = 0.3
```
## Some screenshots
I will try my best to keep these screenshots as updated as possible but some details
could be different
#### default style
#### solid style
#### gradient style
#### opacity settings
|  |  |
| ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|  |  |
|  |  |
|  |  |