Installation

Prerequisites

To build probe-rs, you will need a working Rust toolchain. The easiest way is to follow the rustup installation instructions.

Additionally, probe-rs depends on libusb and optionally on libftdi libraries, which need to be installed to build probe-rs. Instructions for your OS are provided below.

Debian-based Linux

On Debian and derived distros (e.g. Ubuntu), the following packages need to be installed:

sudo apt install -y pkg-config libusb-1.0-0-dev libftdi1-dev libudev-dev libssl-dev

If the libusb v0.1 dev package (libusb-dev) is installed when dependant crates are built, you may get link failures at the end of the build.

On Ubuntu you can fix this by removing it with

sudo apt purge libusb-dev

RPM-based Linux (Fedora, CentOS)

dnf install libusbx-devel libftdi-devel libudev-devel openssl-devel

Windows

On Windows you can use vcpkg to install the prerequisites:

# dynamic linking 64-bit
vcpkg install libftdi1:x64-windows libusb:x64-windows
set VCPKGRS_DYNAMIC=1

# static linking 64-bit
vcpkg install libftdi1:x64-windows-static-md libusb:x64-windows-static-md

macOS

On macOS, homebrew is the suggested method to install libftdi:

brew install libftdi

Installation

Install with cargo install. This will install the probe-rs, cargo-flash and cargo-embed binaries and put them in $PATH.

cargo install probe-rs --features cli

To build with FTDI probe support, enable the ftdi feature;

cargo install probe-rs --features cli,ftdi

What's next?

Follow the instructions in Probe Setup.