How to Install Bridgex on Windows, macOS, and Linux

Bridgex 0.2.1 can be installed in three ways: through the Rust toolchain using Cargo (recommended for all platforms), through pip on Windows and macOS, or by downloading the prebuilt Linux binary from SourceForge. Choose the tab below that matches your preferred installation method.

pip install bridgex is only supported on Windows and macOS. The PyPI wheel bundles a compiled Rust binary for those platforms. Linux users must use the SourceForge binary or build from source with Cargo.

Cargo (All Platforms)
pip (Windows & macOS)
Linux Binary (SourceForge)

Requirements

A Rust toolchain with cargo installed. The stable Rust channel is recommended.
On Linux, several system libraries are required before building (see the Linux system dependencies section below).

Install from crates.io

The simplest way to install the latest published release is directly from crates.io:

cargo install bridgex

Once installed, launch the application from any terminal:

bridgex

Build from Source

Clone the repository and navigate to the Rust crate directory, then build or run the application:

Clone the repository

git clone https://github.com/Dev2Forge/bridgex.git

Navigate to the crate directory

cd bridgex/src/bridgex

Build a release binary

cargo build --release

The compiled binary will be at ./target/release/bridgex.

Run or install locally

./target/release/bridgex

Requirements

Python 3.8 or later
pip

The PyPI package bundles the precompiled Rust binary for Windows (win_amd64) and macOS (arm64 and x86_64). No Rust toolchain is required.

This installation method is not supported on Linux. If you are on Linux, use the SourceForge binary or install via Cargo instead.

Install from PyPI

pip install bridgex

Launch Bridgex

After installation, run the application using either of the following commands:

bridgex

The bridgex entry point is registered by the PyPI package via project.scripts in pyproject.toml. If the binary is not found after installation, use python -m bridgex as a fallback.

Download the Prebuilt Binary

A prebuilt Linux binary is available from the official SourceForge project page:sourceforge.net/projects/bridgex

Visit the SourceForge project page

Navigate to https://sourceforge.net/projects/bridgex/ and download the latest Linux binary.

Make the binary executable

chmod +x bridgex

Run Bridgex

./bridgex

Optionally, move the binary to a directory on your $PATH (for example /usr/local/bin) so you can run bridgex from anywhere.

If you prefer to build from source on Linux, use the Cargo tab above and make sure all system dependencies listed below are installed first.

Linux System Dependencies

When building from source on a Debian/Ubuntu-based Linux system, you must install the following packages before running cargo build. The CI workflow uses these exact packages:

sudo apt update

base_packages="build-essential libssl-dev pkg-config libglib2.0-dev libgtk-3-dev \
  libudev-dev libxdo-dev libfreetype6-dev libfontconfig1-dev libegl1-mesa-dev \
  libgl1-mesa-dev libwayland-egl1-mesa libgles2-mesa-dev libx11-dev libxcursor-dev \
  libxrandr-dev libxi-dev libxkbcommon-dev libwayland-dev cmake"

sudo apt install -y $base_packages libwebkit2gtk-4.1-dev || \
  sudo apt install -y $base_packages libwebkit2gtk-4.0-dev

The installer attempts libwebkit2gtk-4.1-dev first and falls back to libwebkit2gtk-4.0-dev for older distributions that do not carry the 4.1 version. Both variants satisfy the build requirements.

The full list of required packages is:

Package	Purpose
`build-essential`	C/C++ compiler toolchain
`libssl-dev`	TLS support
`pkg-config`	Build system helper
`libglib2.0-dev`	GLib base library
`libgtk-3-dev`	GTK 3 UI toolkit
`libudev-dev`	Device event support
`libxdo-dev`	X11 automation library
`libfreetype6-dev`	Font rendering
`libfontconfig1-dev`	Font configuration
`libegl1-mesa-dev`	EGL (GPU surface)
`libgl1-mesa-dev`	OpenGL
`libwayland-egl1-mesa`	Wayland EGL integration
`libgles2-mesa-dev`	OpenGL ES 2
`libx11-dev`	Core X11 library
`libxcursor-dev`	Cursor theming
`libxrandr-dev`	Display configuration
`libxi-dev`	X Input extension
`libxkbcommon-dev`	Keyboard handling
`libwayland-dev`	Wayland protocol
`cmake`	Build system for native deps
`libwebkit2gtk-4.1-dev` or `libwebkit2gtk-4.0-dev`	WebKit2GTK web renderer

Getting Started

Using Bridgex

Reference

Project

How to Install Bridgex on Windows, macOS, and Linux

Requirements

Install from crates.io

Build from Source

Requirements

Install from PyPI

Launch Bridgex

Download the Prebuilt Binary

Linux System Dependencies

Build docs developers (and LLMs) love

Getting Started

Using Bridgex

Reference

Project

Documentation Index

​Requirements

​Install from crates.io

​Build from Source

​Requirements

​Install from PyPI

​Launch Bridgex

​Download the Prebuilt Binary

​Linux System Dependencies

Build docs developers (and LLMs) love

Requirements

Install from crates.io

Build from Source

Requirements

Install from PyPI

Launch Bridgex

Download the Prebuilt Binary

Linux System Dependencies