Skip to content

Back to the project

Alternative installations

The recommended route is Homebrew; every route ends with the same broglow install.

Mac package

The complete Mac package contains the app, the ESP32-C3 firmware and the operating guide. Apple Silicon builds have been tested on a real Mac; Intel builds are unverified for installation and Bluetooth.

Download the complete bundle for your Mac from GitHub Releases and verify its SHA-256:

broglow-v1.4.2-aarch64-apple-darwin.tar.gz (Apple Silicon)

25b460a6963f39e0be9e304372777908d17c5ec8522acb670a0c5d06433c34c0  broglow-v1.4.2-aarch64-apple-darwin.tar.gz

broglow-v1.4.2-x86_64-apple-darwin.tar.gz (Intel)

a0eb5106fe1c485a5a207dc106accc034f5c289ec0f2602a45083cff3e7c2717  broglow-v1.4.2-x86_64-apple-darwin.tar.gz

Verify, extract and install the package by following Install a prebuilt package. Then check PATH and pair the lamp.

Build from source (macOS and Linux)

You need Rust stable; on macOS also the Apple command-line tools (xcode-select --install), on Linux the system development libraries for the GTK 3 tray. From a full source checkout:

cargo install --locked --path .
"$HOME/.cargo/bin/broglow" install

Details and checks: Build from source. No Linux binaries are published; on Linux the lamp works over USB only, and the tray's GTK 3 bindings carry known advisories listed in the contributing guide.

Run broglow from any folder (PATH)

The package and source routes put the command in ~/.cargo/bin/broglow (the prebuilt package does not need Cargo); Homebrew's $(brew --prefix)/bin is already on PATH. In a fresh terminal outside the package or source folder, check:

cd /tmp
command -v broglow
type -a broglow
broglow --help

If the first line is not your ~/.cargo/bin/broglow (shown as a full path, such as /Users/you/.cargo/bin/broglow), add this line once to ~/.zshrc (default macOS shell), preserving existing settings:

export PATH="$HOME/.cargo/bin:$PATH"

Open a new terminal and repeat the checks. If ~/.zshrc already loads "$HOME/.cargo/env" (the Rust installer adds it), change nothing; other shells use their own startup file. broglow install does not change PATH.

Windows

Download broglow-vVERSION-x86_64-pc-windows-msvc.tar.gz from Releases: the tray app and CLI in broglow.exe, with USB lamp support and the ESP32-C3 firmware images (.\broglow.exe flash writes them to a lamp on USB); no installer, Bluetooth or manuals. Extract it into a permanent folder (for example tar -xf <file> in PowerShell) and run from that folder:

.\broglow.exe install

.\broglow.exe menubar launches the tray directly; .\broglow.exe opens the terminal dashboard. To build from source on Windows instead, use the Rust MSVC toolchain, run cargo install --locked --path ., then broglow install.