gdbgui installation

Try Without Installing

By using pipx, you can run Python CLI programs in ephemeral one-time virtual environments.

pipx gdbgui

A new tab running the latest version of gdbgui will open in your browser. Press CTRL+C to end the process, and your system will remain untouched.

Recommended Installation Instructions

gdbgui recommends using pipx, a program to run Python CLI binaries in isolated environments. You can install pipx like this:

curl https://raw.githubusercontent.com/cs01/pipx/master/get-pipx.py | python3

Then install gdbgui with pipx:

pipx install gdbgui

To upgrade run

pipx upgrade gdbgui

When installation is finished, type gdbgui from the command line to run it, or gdbgui -h for help.

Alternate Installation 1

If you prefer to use Virtual Environments, you can activate one and then run

pip install gdbgui

Alternate Installation 2

Download and run the binary executable for your system on gdbgui.com.

Please create an issue or pull request if any of this information is out of date, incomplete, or incorrect.

System Dependencies

Note that this only applies if you are installing the Python package, and not using the binary executable from gdbgui.com.

Linux Dependencies

sudo apt-get install gdb python3

macOS Dependencies

brew install python3
brew install gdb --with-python --with-all-targets

macOS users must also codesign gdb: follow these instructions. This will fix the error please check gdb is codesigned - see taskgated(8).

Windows Dependencies

If you do not have already have gdb/make/gcc installed, there are two options to install them on Windows: MinGW and cygwin.

MinGW (recommended)

Minimal GNU for Windows (MinGW) is the recommended Windows option. Install MinGW with the "MinGW Base System" package. This is the default package which contains make, gcc, and gdb.

It will install to somewhere like C:\MinGW\bin\.... For example C:\MinGW\bin\gdb.exe, C:\MinGW\bin\mingw32-make.exe, etc.

Ensure this MinGW binary directory (i.e. C:\MinGW\bin\) is on your "Path" environment variable: Go to Control Panel > System Properties > Environment Variables > System Variables > Path and make sure C:\MinGW\bin\ is added to that list. If it is not added to your "Path", you will have to run gdbgui with the path explicitly called out, such as gdbgui -g C:\MinGW\bin\gdb.exe.

Cygwin

Cygwin is a more UNIX-like compatibility layer on Windows, and gdbgui works with it as well.

Running from Source

In an activated Virtual Environment, run

git clone https://github.com/cs01/gdbgui
cd gdbgui
pip install -e .
python -m gdbgui

A Virtual Environment sandboxes python packages, which guarantees there will be no installation conflicts.

To create and use a new virtualenv:

pythom3 -m venv  # creates a virtual env named "venv"
source venv/bin/activate  # activates the virtualenv sandbox
pip install pip --upgrade  # make sure pip is at the latest version