Bran is a statusbar for i3, intended to be simple to set up and use by providing a strong set of defaults, while allowing for customization through the same command-line interface that's used for invoking itself.

Bran is built in Go, and requires the Go toolchain to be set up before building and installing.

Assuming everything is set up correctly, installation is simply a matter of running go get, i.e.:

go get -u -v github.com/deuill/bran

You should now have a binary named bran in your $GOPATH/bin directory.

Bran contains a small number of core "applets", which provide functionality such as date/time display, volume status via ALSA/Pulseaudio, CPU and memory usage etc.

Both placement and customization of these is defined through the command-line interface for bran, for example:

bar {
    status_command bran cpu memory date
}

This initializes bran with three applets, CPU usage, memory usage and date/time, displayed left-to-right as entered. Applets can be customized by providing additional arguments after the applet name:

bar {
    status_command bran cpu:"interval=10 scale=F" memory volume:step=10 date
}

This sets the update interval and temperature scale for the cpu applet to 10 seconds and Fahrenheit respectively, and sets the volume step for the volume applet to 10%.

Multiple configuration values need to be wrapped in quotes, due to the way shells handle space-separated strings.

All code in this repository is covered by the terms of the MIT License, the full text of which can be found in the LICENSE file.