Skip to Content
Kwybars
Development

Overview

Developer quick start, commands, and the build and QA workflow.

This section is for contributors working on Kwybars itself rather than end users setting it up on their desktop.

Checkout

git clone https://github.com/naurissteins/Kwybars.git
cd Kwybars

Dependencies

On Arch Linux:

sudo pacman -S --needed rust pipewire clang pkgconf

On Debian or Ubuntu:

sudo apt install build-essential cargo libclang-dev libpipewire-0.3-dev pkg-config

clang (libclang) is only needed at build time, to generate the PipeWire bindings. Rust 1.88 or newer is required.

Common Developer Commands

Run the visualizer:

cargo run

Run with a specific config and more log output:

KWYBARS_LOG=debug cargo run -- --config /path/to/config.toml

Check a setup:

cargo run -- doctor
cargo run -- validate-config --config /path/to/config.toml
cargo run -- list-themes

Look at the audio side alone, in the terminal:

cargo run -- debug audio
cargo run -- debug spectrum

Config tools:

cargo run -- switch-config /path/to/config.toml
cargo run -- image-overlay match --overlay-dir /path/to/overlays /path/to/wallpaper.jpg

Build and QA

Run these before sending a change:

cargo fmt --all
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace
cargo build --release

Dependency checks (licenses, advisories) use cargo-deny:

./scripts/check-deps

scripts/measure reports CPU, context switches, and memory of a running command, which is how performance changes are compared:

scripts/measure -- target/release/kwybars

Logging and Nix

See Logging. For Nix, nix develop (or nix-shell) opens a development shell; packaging and the NixOS module are covered in NixOS.

For the module layout and how the parts work together, continue with Internals.

On this page