Skip to content

Building from Source

bisu edited this page Sep 21, 2026 · 1 revision

Building from Source

Prerequisites

  • Rust 1.98.1 or newer (edition 2021) — the declared MSRV
  • Linux: GTK/X11/Wayland dev libraries for the GUI (eframe builds with wayland + x11 features)
  • macOS/Windows: no extra packages needed

Check your toolchain:

rustc --version   # must be >= 1.98.1

Build

git clone https://github.com/bisug/BinaryInspector.git
cd BinaryInspector

# CLI only
cargo build --release --locked --bin binary-inspector

# GUI only
cargo build --release --locked --bin binary-inspector-gui

# Everything
cargo build --release --locked

Binaries land in target/release/:

Binary Purpose
binary-inspector CLI
binary-inspector-gui Native desktop GUI (egui/eframe)

Release profile

Cargo.toml tunes release builds for size and speed:

[profile.release]
codegen-units = 1
lto = "thin"
opt-level = 3
panic = "abort"
strip = "symbols"

Install

Either use the installer (downloads release assets or builds locally):

curl -fsSL https://raw.githubusercontent.com/bisug/BinaryInspector/main/install.sh | bash -s -- --to ~/.local/bin

Or copy manually:

install -m 0755 target/release/binary-inspector target/release/binary-inspector-gui ~/.local/bin/

Verify your build

cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test --locked
cargo doc --no-deps
./target/release/binary-inspector /bin/ls -m

All four gates must pass before committing (see Contributing).

Clone this wiki locally