# Installation

## Prerequisites

To use and run BurpGPT on your system, it is essential to have the following dependencies installed:

{% tabs %}
{% tab title="BurpGPT Pro" %}

* [Burp Suite Professional](https://portswigger.net/burp/pro): [Version 2025.6.5](https://portswigger.net/burp/releases/professional-community-2025-6-5) or later.
* Java: [Version 21](https://www.oracle.com/uk/java/technologies/downloads/#java21) or later.

{% hint style="warning" %}
Please note that using any version of Burp Suite lower than 2024.7.3 may result in various types of errors. To avoid these issues, it is essential to use the recommended version or a later one.
{% endhint %}

To use the `Local LLM` feature, exclusive to `BurpGPT Pro`, make sure you have the following dependencies installed:

* Python: [Version 3.13.5](https://www.python.org/downloads/release/python-3126/). The following libraries are required.
  * [flask](https://pypi.org/project/Flask/)
  * [flask-cors](https://pypi.org/project/Flask-Cors/)
  * [transformers](https://huggingface.co/docs/transformers/index)

{% hint style="info" %}
You can install the required Python libraries by running:

```bash
python -m pip install accelerate
python -m pip install bitsandbytes
python -m pip install flask
python -m pip install flask-cors
python -m pip install marshmallow
python -m pip install numpy<2
python -m pip install torch
python -m pip install transformers
```

{% endhint %}

{% hint style="warning" %}
To ensure proper functioning, it is important to add the Python executable to your system's PATH environment variable.&#x20;
{% endhint %}
{% endtab %}

{% tab title="BurpGPT Community" %}

* [Burp Suite Professional](https://portswigger.net/burp/pro).
* Gradle: [Version 8.5](https://gradle.org/releases/) (recommended) or later. The [build.gradle](https://github.com/aress31/burpgpt/blob/main/lib/build.gradle) file is provided in the project repository.
* Java: [Version 20](https://www.oracle.com/uk/java/technologies/downloads/) or later.

{% hint style="warning" %}
Please note that using any version lower than 2023.3.2 may result in a [java.lang.NoSuchMethodError](https://forum.portswigger.net/thread/montoya-api-nosuchmethoderror-275048be). It is crucial to use the specified version or a more recent one to avoid this issue.
{% endhint %}
{% endtab %}
{% endtabs %}

## Compilation

{% hint style="warning" %}
This step is only applicable to the Community edition. For the Pro edition, the standalone jar is distributed upon successful payment in the confirmation email. Please note that the download link is valid for 24 hours only, and additional download requests for the jar may incur additional fees.
{% endhint %}

To compile BurpGPT Community from the source code, follow these steps:

1. Ensure you have Gradle installed and properly configured on your system.
2. Download the official burpgpt repository:

{% code fullWidth="false" %}

```bash
git clone https://github.com/aress31/burpgpt
cd .\burpgpt\
```

{% endcode %}

3. Build the standalone `jar`:

```bash
./gradlew shadowJar
```

## Loading BurpGPT into Burp Suite

To install BurpGPT, please follow these steps:

1. Open Burp Suite and navigate to the `Extensions` tab.
2. Click on the `Add` button under the `Installed` section.
3. Browse to the location of the BurpGPT jar file and click `Next`.
4. Upon successful installation, users can expect the following changes:
   * In the Community edition, a new option titled `BurpGPT` will be added to the top bar menu.
   * In the Pro edition, a new tab titled `BurpGPT Pro` will now be visible.