Support Center

Burp Community

See what our users are saying about Burp Suite:

How do I?

New Post View All

Feature Requests

New Post View All

Burp Extensions

New Post View All

Bug Reports

New Post View All
Documentation

Burp Suite Documentation

Take a look at our Documentation section for full details about every Burp Suite tool, function and configuration option.

Full Documentation Contents Burp Projects
Suite Functions Burp Tools
Options Using Burp Suite
Extensibility

Burp Extender

Burp Extender lets you extend the functionality of Burp Suite in numerous ways.

Extensions can be written in Java, Python or Ruby.

API documentation Writing your first Burp Suite extension
Sample extensions View community discussions about Extensibility

Launching Burp Suite from the Command Line

Burp Suite is a Java application and is distributed via native platform installers or as a standalone Java executable file, with the .JAR extension. You can download Burp Suite Free Edition from the PortSwigger.net website. For Burp Suite Professional users, you can log in and download the latest Professional build using your account details.

The native platform installers bundle Burp together with a private Java runtime environment, so you don't need to worry about installing or updating Java.

The Burp JAR file can be executed using a Java Runtime Environment, and there is no need to unpack the contents of the JAR file itself.

To launch Burp, first open a command prompt.

On Windows, click the Start button, type "cmd" into the search box, and click on the "cmd" item under "Programs".

 

On Mac OS X, in Finder, click on Applications, Utilities, and then Terminal.

 

On Linux, look in your lists of applications for an item called "console", "terminal" or "shell".

 

To run the .JAR version of Burp Suite you will need to have Java installed on your machine.

In the command prompt window, type:

java -version

If Java is installed, you will see a message like: java version "1.7.0_67".

 

Burp requires a computer with the official Java Runtime Environment (64-bit edition, version 1.7 or later) installed.

From the Oracle website, download the latest Java Runtime Environment (JRE), run the installer, and then open a new command prompt and start again.

 

On some platforms you may be able to run Burp directly by double-clicking the Burp JAR or EXE file.

However, it is preferable to launch the Burp JAR file from the command line, as this gives you more control over its execution, in particular the amount of memory that your computer assigns to Burp. To do this, in your command prompt type a command like:

java -jar -Xmx2G /path/to/burp.jar

where 2 is the amount of memory (in Gb) that you want to assign to Burp, and /path/to/burp.jar is the location of the Burp JAR file on your computer.

 

Note: On some platforms, it may not be necessary to assign additional memory to Burp in this way. If Burp does run low on memory, it will display warnings in the Alerts tab. If this happens, you should start assigning additional memory to Burp when you launch it. For most tasks, assigning 4G of RAM will be sufficient, but you can assign more if you need it, and if your computer has sufficient memory to do so.

If everything is working, a splash screen should display for a few seconds, and then the Burp Suite startup wizard should appear.

If nothing happens, or if an error message appears, please refer to the troubleshooting help.

Related articles: