Documentation

Config | Theme | Companion

---

Winbar (Windows Bar) is a modern, highly customizable status bar (AppBar) designed for Windows, built on the powerful combination of Wails, Go, and React. Inspired by the sleek, modular top bars often found in Linux desktop environments (like Polybar or Waybar) and other windows status bar (like YASB). Winbar transforms your Windows desktop into a centralized, highly efficient command center tailored exactly to your needs.

Features

• Windows AppBar Integration: Docks seamlessly to the top of your screen, behaving like a native taskbar.

• Modular Bar Design: Configure left, center, and right sections of the bar using a simple YAML configuration.

  
  
  
  

• Changeable & Custom Themes: Change the theme to your liking. Dont like the default? add your own theme.

  
  
  
  

• Overlay: Winbar isn't only a status bar, it has an overlay for the main command center feature with modules

  
  
  
  

• Tons of Modules Categories:

  • Home: Basic modules categories for your basic need: Music Player (YAMW), App Launcher, System Resources, and System Controls.

  • Notes: Modules for taking note, creating a todo list, and a drawing board for your fancy diagram.

  • AI: Modules for the next generation of technology, integrate your local AI to winbar.

  • Server: Modules for tech enthusiast. Manage & monitor your server with ease.

    
    

• System Tray: Manage the app quietly in the background, open configurations, and easily toggle "Run on Launch".

• Custom Shorcut: If you have a copilot key (F23), you can change it to open the overlay

• Modern UI & Fast Performance: Beautiful and responsive UI using web based tools, with RAM usage under 300MB

Installation

1. Go to the Releases page.
2. Download the executable file
3. Bypass OS Security Warnings: Since winbar is an unsigned open-source application, Windows might flag it upon first launch.

   If Windows Defender SmartScreen appears, click More info > Run anyway.

4. Enjoy your new windows status bar

Configuration

Winbar is highly configurable via a config.yaml file located in the same directory as the executable. If it doesn't exist, the application will create a default one on startup. You can easily open the configuration file by right-clicking the Winbar system tray icon and selecting "Open Config".

Example config.yaml

theme: default
left:
- power
- overlay                                           # If the overlay widget is remove, then all modules and overlay feature will be disabled
- theme_toggle
- overlay_toggle
- workspace
center:
- day
right:
- music
- volume
- battery
- wifi
- notification
modules:
- yamw
- sysinfo
- todo
- notepad
- control
- launcher
prometheus_url: http://localhost:9090/              # Insert your server Prometheus URL 
launcher_apps:                                      # insert your application file path
- name: steam                                       # Recommended to add apps from the launcher module, instead of from changing this config file 
  path: C:\Program Files (x86)\Steam\steam.exe

---

More Config, Themes, Companions Documentation

The explanation above is a brief documentation on how to get started on configurating the config.yaml. Winbar customization doesn't stop at the config.yaml, you can add your custom theme and even a custom companion for you AI chat. For more in-depth information and explanation about all the configuration that can be done, please see this other documentations

Config | Theme | Companion

Configuration & Extra Notes

• Some modules and widget may need an external program to be working, this include the yamw (music player widget & module) & workspace widget. For example, the workspace widget works only if you have downloaded Space.
• Some modules also need a server to be working. For example, all the server category module need a server to run. Including it without actually having a server might bring error and waste computer resources
• The companion module is still experimental, as of now the module only been tested using llama.cpp. Other inference engine might not work (e.g. ollama)
• Winbar is still brand new and bug may appear

Local Development

Prerequisites

• Go
• Node.js & npm
• Wails CLI v2

Build from source

# Clone the repository
git clone https://github.com/Arjuna-Ragil/winbar.git
cd winbar

# Build the application using Wails
wails build

The compiled executable will be located in the build/bin/ directory.

Development

To run the application in live-development mode (which enables frontend hot-reloading):

wails dev

Tech Stack & Dependecies

• Backend: The backend logic uses Go (Golang) as the main languange. But, some code part doesn't really follow the go standard since talking with the win32 API (which is using C) needs to follow some C languange rules. This project uses a few library that is free and open-source:

  • lxn/win
  • distatus/battery
  • getlantern/systray
  • itchyny/volume-go
  • shirou/gopsutil/v4
  • wailsapp/wails/v2

• Frontend: React (JS & TS), Vite, TailwindCSS, Excalidraw, Lucide React.

Contributing

This project is getting larger day by day and I can't exactly find every single bug. So I hope if you are interested, please create an issue if you found a bug. Futhermore, if you have found and fix a bug, please create a PR. Other than that, if you have a request for a new widget, module, or even you have created your own widget & module and one to share with others, feel free to create an issue or a PR. Thanks :)

Thank You For using Winbar