Installation
SketchyBar is typically installed by building it directly from the source code. This guide provides the steps to compile and install the application on your system.
Prerequisites
Before you begin, you will need the Xcode Command Line Tools installed on your macOS system. These tools provide the necessary compilers and build utilities like make
and cc
.
If you don't have them installed, you can do so by running:
xcode-select --install
Building from Source
-
Clone the Repository
First, clone the SketchyBar repository from GitHub to your local machine:
git clone https://github.com/FelixKratz/SketchyBar.git cd SketchyBar
-
Compile the Binary
The included
makefile
simplifies the compilation process. It is configured to build a universal binary that runs natively on both Apple Silicon (arm64) and Intel (x86_64) Macs.To build the universal binary, run the
make
command:make universal
This command performs the following steps:
- Compiles an
x86_64
version of the binary. - Compiles an
arm64
version of the binary. - Uses
lipo
to combine both architectures into a singlesketchybar
executable located in thebin/
directory.
- Compiles an
-
Install the Binary
Once the compilation is complete, you should copy the
sketchybar
binary to a location in your system'sPATH
. A common location is/usr/local/bin
.cp bin/sketchybar /usr/local/bin/
-
Install Plugins and Configuration
SketchyBar looks for its configuration file at
~/.config/sketchybar/sketchybarrc
. The repository includes a default configuration and a set of plugin scripts that you can use as a starting point.Create the necessary directory and copy the example files:
mkdir -p ~/.config/sketchybar/plugins cp sketchybarrc ~/.config/sketchybar/ cp -r plugins/ ~/.config/sketchybar/
Running SketchyBar
Once installed, you can start SketchyBar by simply running the command:
sketchybar
For it to start automatically on login, you should configure it to launch with launchd
or add it to your shell's startup file (e.g., .zshrc
, .profile
). The most reliable method is using launchd
.
Now you're ready to customize your bar! Head over to the Quick Start guide to learn how the default configuration works.