Skip to main content

Setup

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.

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.

Hiding the original macOS bar

If you have a notched MacBook, SketchyBar will (with the default config) appear below the original macOS bar. You can do a few things to make SketchyBar visible:

  • Give SketchyBar a y_offset
sketchybar --bar y_offset=32
  • Hide the default macOS menu bar in System Preferences -> Dock & Menu Bar: hide_macOS_bar

Compile from source

It is easy to compile the project from source:

  • Install xCode commandline tools:
xcode-select --install
  • Clone the repository:
git clone https://github.com/FelixKratz/SketchyBar.git
  • In the sketchybar folder run:
make

This will generate a universal binary with arm64 and x86 instructions. It is possible to generate an arm64/x86 only binary via:

make arm64

or

make x86

Compiling on older macOS (pre Big Sur) versions should always be done via make x86.

Uninstall

Uninstall via brew:

brew uninstall sketchybar
brew untap FelixKratz/formulae