Skip to content
Get packs

Guide · Open source

How to use gdb-dashboard: setup, panels and tips

Updated · written with AI from the project's own documentation and checked against our catalogue data

gdb-dashboard is a standalone .gdbinit file, written with GDB's Python API, that shows a panel of useful program state each time the program you are debugging stops. This guide explains how to set it up, how it fits into a normal GDB session, and where to find the rest of its features. It is aimed at developers who debug C or C++ programs in a terminal, and at students who want to watch program state change while stepping.

GDB dashboardcyrus-and/gdb-dashboard · ★ 12.3k · MIT

Quick start

  1. 1Download the .gdbinit file. Use wget to place the .gdbinit file from the project repository into your home directory.
  2. 2Optionally install Pygments. Run pip install pygments if you want syntax highlighting in the dashboard.
  3. 3Start a GDB session. Debug your program with GDB as usual, in a terminal.
  4. 4Watch the dashboard update. The dashboard appears automatically each time the program stops.
  5. 5Read the help. Run help dashboard to see the available features.
  6. 6Consult the wiki. Open the project wiki for guides to the most important tasks.

What gdb-dashboard is and who it suits

gdb-dashboard is a modular interface for GDB that runs inside your terminal. Its stated goal is to reduce the number of GDB commands you need to check the status of the program, so you can focus on control flow.

It suits developers who debug with GDB in a terminal and people who find repeated inspection commands tedious. It is not a good fit if you prefer a graphical IDE debugger, or if you are debugging a language GDB does not support.

Install gdb-dashboard by placing .gdbinit in your home directory

The project is a single .gdbinit file. Place it in your home directory, for example with wget as shown below. Setup is manual, so you need to be comfortable with a home-directory config file.

You need GDB with Python support. Pygments is optional and only enables syntax highlighting. Install it with pip if you want highlighting.

  • Prerequisite: GDB with Python support
  • Optional: Pygments, for syntax highlighting
wget -P ~ https://github.com/cyrus-and/gdb-dashboard/raw/master/.gdbinit pip install pygments

Debug a program and see the dashboard appear

Debug as usual with GDB. According to the project's README, the dashboard appears automatically every time the program being debugged (the inferior) stops, so there is no separate command to open it.

No GDB command has been redefined. All dashboard features are reached through the main dashboard command, and help dashboard lists them.

  • Start a debugging session with GDB as you normally would
  • Let the program stop, for example at a breakpoint or after a step
  • Run help dashboard inside GDB to see the available options
help dashboard

Learn the dashboard command and its panels

Because every feature lives under the dashboard command, you configure the view there rather than through separate commands. The README points to the project wiki for step-by-step tasks, so use it when you want to change what is shown.

The README describes the panel as showing relevant information such as the current code and related information. Check help dashboard in your installed version to see exactly which panels and settings you have.

  • Use help dashboard to list features
  • Use the project wiki for the most important tasks

Compare gdb-dashboard with similar projects

Comparable projects include pwndbg, GEF and peda. They all enhance GDB in a terminal. The source does not compare their features, so choose by testing the one whose view and setup suit you.

  • gdb-dashboard: a standalone .gdbinit file, MIT licensed
  • pwndbg, GEF and peda: other GDB enhancement projects

What people use it for

  • Stepping through a C program and watching the current code panel update at each stop
  • Following how variables change while learning how a program runs
  • Debugging a C or C++ program over a terminal session without a graphical IDE

Frequently asked questions

Is gdb-dashboard free to use?

Yes, the project is licensed under the MIT licence. You can read the source, which is a single .gdbinit file written in Python.

What do I need to run gdb-dashboard?

You need GDB with Python support. Pygments is optional and only adds syntax highlighting. Setup is manual: you place the .gdbinit file in your home directory.

How do I install gdb-dashboard?

Download the .gdbinit file into your home directory with wget, then optionally run pip install pygments. The README gives both commands.

Why does the dashboard not appear when I start GDB?

According to the README, the dashboard appears when the program being debugged stops. Start the program and let it reach a breakpoint or step, then check the output. The source does not list other troubleshooting steps.

Does gdb-dashboard replace GDB commands?

No. The README says no GDB command has been redefined. Features are available through the main dashboard command, which you can explore with help dashboard.

How does gdb-dashboard compare with pwndbg, GEF or peda?

These are comparable projects that also enhance GDB. The source does not compare them, so test the options yourself to see which view and setup you prefer.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

gdb-dashboard suits developers and students who debug C or C++ in a terminal with GDB and want a configurable on-screen view while stepping. It is not a good choice if you want a graphical IDE debugger or dislike editing a home-directory config file.

Install options & downloads