Getting started

Installation

Download the latest build from GitHub and install it on macOS or Linux, or build it from source.

On this page

Download

Every release is on the GitHub Releases page. Open the newest one and download the file for your system.

Open burrowclient.dmg and drag Burrow Client into Applications.
Start it. macOS says it can’t verify the app, because the build isn’t signed with an Apple developer certificate. Click Done.
Go to System Settings → Privacy & Security, scroll down and click Open Anyway next to Burrow Client.

You only need to do this once.

TODOSay which Macs the .dmg supports. The download page on this site says Apple Silicon, but the README doesn’t mention Intel Macs.

Use the AppImage. Make it executable, then run it:

bash

chmod +x burrowclient.AppImage
./burrowclient.AppImage

You need Node.js. Burrow is developed and tested on Node 24.

bash

git clone https://github.com/zukotuutori/burrow-client.git
cd burrow-client
npm install

Then build for your platform. The result lands in dist/.

bash

npm run build:mac

bash

npm run build:linux

The Linux build needs rpm-build (sudo dnf install rpm-build on Fedora) and has to run on Linux.

Once Burrow is installed, you check for new versions from inside the app. Your data stays where it is. See Updates.