| images | ||
| plugins | ||
| src | ||
| .gitignore | ||
| DOCS.md | ||
| LICENSE.md | ||
| makefile | ||
| README.md | ||
| sketchybarrc | ||
This bar project aims to create a highly flexible, customizable, fast and powerful status bar replacement for users that like playing around with shell scripts.
More example setups here. Full documentation here.
Features
- Performance friendly
- No accessibility permissions needed
- Fully scriptable
- Fully configurable
- Supports drawing native macOS menu bar applications
- Powerful event system
- Popup Menus
- Mouse Support
- Support for graphs
- Per display and per space individualization
Documentation
For the full documentation of all commands and properties please refer to the website or if you prefer a single document see the markdown docs.
Installation
Brew Install
brew tap FelixKratz/formulae
brew install sketchybar
Do not forget to copy the example configuration files to your home directory (the brew installation specific commands are listed in the caveats section after the brew install is finished). The default configuration is intentionally sparse, so if you are looking for something more sophisticated as a starting point, you might want to look at this discussion or my personal dotfiles.
Run the bar automatically at startup:
brew services start sketchybar
or in the command line with verbose output:
sketchybar
Fonts
The default sketchybar font is the Hack Nerd Font:
brew tap homebrew/cask-fonts
brew install --cask font-hack-nerd-font
if you experience missing icons you might need to install it. Any font of your liking can be used in sketchybar.
Plugins
When you use/create additional plugins, make sure that they are made executable via
chmod +x name/of/plugin.sh
If you run sketchybar from the command line directly with the command sketchybar you will see
all outputs and error messages from your scripts.
The default plugin folder is located in ~/.config/sketchybar/plugins.
Plugins need to be referenced with absolute paths because relative paths will not be resolved correctly.
Have a look at the discussion for plugins and share your own if you want to.
You should of course vet the code from all plugins before executing them to make sure they are not harming your computer.
Credits
This project was forked from spacebar and completely reimagined and rewritten.
The original idea is based on the status bar that was included in yabai before getting removed.