Installing RBTools¶

RBTools is most often installed as a Python package. Installation steps depend on your system and whether you’re developing against RBTools:

Use an official installer (recommended for Windows)
Use pipx (recommended for Linux and macOS)
Use Python pip (recommended if you manage your Python environment)

Installation Options¶

Using an official installer¶

We provide an official installer for Windows, helping you quickly get started with RBTools without needing to worry about Python.

To install RBTools using the official installer:

Download and run the RBTools for Windows installer.
Open a new command prompt and verify RBTools is installed and in your path:
```
C:\> rbt
```
You should see the RBTools help displayed. If it doesn’t work, make C:\Program Files\RBTools\bin is in your path.

Using pipx¶

pipx is a command line tool that safely installs Python packages (such as RBTools) in a self-contained environment. This is recommended for most users.

To install RBTools using pipx:

Install pipx:
$ sudo apt install pipx
$ sudo yum install pipx
If you use Homebrew:
$ brew install pipx
If you can’t install the package using the instructions above, you can install it using pip3 instead:
```
$ sudo pip3 install -U pip
```
Set up your executable search path:
```
$ pipx ensurepath
```
Follow the displayed instructions.
Install RBTools:
```
$ pipx install RBTools
```
Verify RBTools is installed and in your path:
```
$ rbt
```
You should see the RBTools help displayed. If it doesn’t work, make sure that you followed the instructions from pipx ensurepath.
To upgrade RBTools, run:
```
$ pipx upgrade RBTools
```

Using Python pip¶

pip is the standard Python package installation tool. It’s available on most (but not all) systems.

You may want to use pip instead of pipx in you are:

Installing in a Python virtual environment
Developing against the RBTools API
Using pyenv to manage your Python install

To install using pip:
```
$ pip3 install RBTools
```
(To install globally, you may need to run this using sudo.)
Verify RBTools is installed and in your path:
```
$ rbt
```
You should see the RBTools help displayed. If it doesn’t work, make sure that you followed the instructions from pipx ensurepath.
To upgrade RBTools, run:
```
$ pip3 install -U RBTools
```

Note

pip install used to be preferred, but many systems no longer allow this command, including:

Debian 12+
Fedora 38+
Kali Linux 2023.1+
Ubuntu 23.04+

For systems without pip install, you will need to create a Python virtual environment or install using pipx.

After Installation¶

Once RBTools is installed, you’ll need to authenticate with Review Board and configure RBTools.

See our step-by-step instructions to get you started.