NationalSecurityAgency/ghidra

Install

To install an official pre-built multi-platform Ghidra release: Install [JDK 25 64-bit][jdk] Download a Ghidra [release file][releases] - NOTE: The official multi-platform release file is named ghidra.zip which can be found under the "Assets" drop-down. Downloading either of the files named "Source Code" is not correct for this step. Extract the Ghidra release file - NOTE: Do not extract on top of an existing installation Launch Ghidra: ./ghidraRun (ghidraRun.bat for Windows) - or launch [PyGhidra][pyghidra]: ./support/pyghidraRun (support\pyghidraRun.bat for Windows)

For additional information and troubleshooting tips about installing and running a Ghidra release, please refer to the [Getting Started][gettingstarted] document which can be found at the root of a Ghidra installation directory.

Security Warning

WARNING: There are known security vulnerabilities within certain versions of Ghidra. Before proceeding, please read through Ghidra's [Security Advisories][security] for a better understanding of how you might be impacted.

Build

To create the latest development build for your platform from this source repository:

Install build tools: [JDK 25 64-bit][jdk] [Gradle 9.1.0+][gradle] (or provided Gradle wrapper if Internet connection is available) [Python3][python3] (version 3.9 to 3.15) with bundled pip GCC or Clang, and make (Linux/macOS-only) [Microsoft Visual Studio][vs] 2017+ or [Microsoft C++ Build Tools][vcbuildtools] with the following components installed (Windows-only): - MSVC - Windows SDK - C++ ATL

Download and extract the source: [Download from GitHub][master]

NOTE: Instead of downloading the compressed source, you may instead want to clone the GitHub repository: git clone https://github.com/NationalSecurityAgency/ghidra.git

User Scripts and Extensions

Ghidra installations support users writing custom scripts and extensions via the GhidraDev plugin for Eclipse. The plugin and its corresponding instructions can be found within a Ghidra release at Extensions/Eclipse/GhidraDev/ or at [this link][ghidradev]. Alternatively, Visual Studio Code may be used to edit scripts by clicking the Visual Studio Code icon in the Script Manager. Fully-featured Visual Studio Code projects can be created from a Ghidra CodeBrowser window at Tools -> Create VSCode Module project.

NOTE: Both the GhidraDev plugin for Eclipse and Visual Studio Code integrations only support developing against fully built Ghidra installations which can be downloaded from the [Releases][releases] page.