HowTo :: Install GEF (GDB Plug-in)

Date: 2018-12-16

Last Modified: 2026-02-01

Reading Time: 4 mins

Section: HowTo

Categories: howto

Introduction

Install GEF to supercharge your GDB debugging experience with syntax highlighting, automatic context display, and dozens of powerful commands.

What is GEF?

GEF (GDB Enhanced Features) is a powerful plugin that transforms GDB from a basic command-line debugger into a modern, user-friendly debugging powerhouse. It adds:

Automatic context display showing registers, stack, code, and threads after every step
Syntax highlighting for assembly and source code
Memory inspection tools with visual formatting
Enhanced breakpoints with better visualization
Exploit development helpers for security research
Python-based extensibility to add your own commands

If you’ve used GDB and found it difficult to follow what’s happening, GEF solves that problem by showing you everything you need in an organized, colorful interface.

Tip

GEF is particularly popular among security researchers, reverse engineers, and exploit developers, but it’s valuable for any developer debugging C/C++ programs.

What You’ll Need

Prerequisites

Before installing GEF, ensure you have:

GDB installed with Python support (most modern installations include this)
Git for cloning the GEF repository
Python 2.7+ or Python 3.x
pip package manager for installing Python dependencies
Root or sudo access to install to /opt (or choose a user directory instead)

Step-by-Step Installation Guide

Step 1: Verify GDB Python Support

Before installing GEF, confirm your GDB was compiled with Python support:

1
gdb -nx -ex 'pi print(sys.version)' -ex quit

Expected output:

3.8.10 (default, Nov 14 2022, 12:59:47)
[GCC 9.4.0]

No Python Support?

If you see an error like “Python scripting is not supported in this copy of GDB,” you’ll need to reinstall GDB with Python support. On Debian/Ubuntu:

1
sudo apt install gdb python3-dev

On Fedora/RHEL:

1
sudo yum install gdb python3-devel

Step 2: Clone the GEF Repository

Navigate to /opt and clone the GEF repository. This location makes GEF available system-wide:

1
2
cd /opt
sudo git clone https://github.com/hugsy/gef.git

Alternative: User Installation

If you don’t have sudo access or prefer a user installation:

1
2
cd ~
git clone https://github.com/hugsy/gef.git

Adjust paths in the following steps accordingly (use ~/gef instead of /opt/gef).

Step 3: Run the Installation Scripts

GEF provides convenient installation scripts that configure everything automatically:

1
2
sudo /opt/gef/scripts/gef.sh
sudo /opt/gef/scripts/gef-extras.sh

What these scripts do:

gef.sh installs the core GEF plugin by adding a source line to your ~/.gdbinit
gef-extras.sh installs additional helper scripts and commands for advanced features

Step 4: Install Python Dependencies

Some GEF features require additional Python packages. Start GDB and check for missing dependencies:

1
gdb -q

In the GDB prompt, type:

gef➤  gef missing

This command lists any missing Python packages. Install them using pip:

1
pip install keystone-engine ropper capstone unicorn

Using pyenv?

If you use pyenv to manage Python versions, make sure you’ve activated the correct Python environment before installing dependencies. See our Installing pyenv guide for details.

Verification

To verify GEF is installed correctly, start GDB:

1
gdb -q

You should see colorful GEF startup banner:

1
GEF for linux ready, type `gef' to start, `gef config' to configure

Try running a simple program:

1
2
3
gdb -q /bin/ls
gef➤  break main
gef➤  run

You should see GEF’s enhanced context display showing registers, code, stack, and more.

Troubleshooting

Common Issues

Issue: GDB doesn’t load GEF, shows “command not found” Solution: Check that ~/.gdbinit contains the source line. Add it manually if missing:

1
echo "source /opt/gef/gef.py" >> ~/.gdbinit

Issue: Python import errors when starting GDB Solution: Ensure Python dependencies are installed for the Python version GDB uses:

1
2
3
4
5
# Check which Python GDB uses
gdb -q -ex 'pi import sys; print(sys.executable)' -ex quit

# Install dependencies for that Python version
/path/to/that/python -m pip install keystone-engine capstone ropper

Issue: GEF commands work but features are missing Solution: Run gef missing inside GDB and install listed packages.

Issue: Permission denied when cloning to /opt Solution: Use sudo for the git clone command, or clone to a user directory like ~/gef instead.

Keeping GEF Updated

GEF is actively developed with new features and bug fixes. To update to the latest version:

1
python ~/.gdbinit-gef.py --update

Or manually pull the latest changes:

1
2
cd /opt/gef
sudo git pull

Auto-Update

Consider setting up a cron job or alias to remind yourself to update GEF monthly:

1
alias gef-update='python ~/.gdbinit-gef.py --update'

Next Steps

Now that you have GEF installed:

Learn the basics: Read our Getting Started with GDB guide
Explore GEF commands: Type gef help in GDB to see all available commands
Configure GEF: Run gef config to customize colors, context layout, and features
Try debugging: Practice with our Linux Syscalls in Assembly tutorial

GEF Resources

Official GEF Documentation
Type gef help inside GDB for command reference
Type help <command> for detailed help on any GEF command