gdb-dashboard README

The project's README from github.com/cyrus-and/gdb-dashboard. As one markdown file: README.md.

GDB dashboard

GDB dashboard is a standalone .gdbinit file written using the Python API that enables a modular interface showing relevant information about the program being debugged. Its main goal is to reduce the number of GDB commands needed to inspect the status of current program thus allowing the developer to primarily focus on the control flow.

Screenshot

Quickstart

Just place .gdbinit in your home directory, for example with:

wget -P ~ https://github.com/cyrus-and/gdb-dashboard/raw/master/.gdbinit

Optionally install Pygments to enable syntax highlighting:

pip install pygments

Then debug as usual, the dashboard will appear automatically every time the inferior program stops.

Keep in mind that no GDB command has been redefined, instead all the features are available via the main dashboard command (see help dashboard).

Head to the wiki to learn how to perform the most important tasks.

gdb-dashboard (cyrus-and/gdb-dashboard)

Searching Database…

What is this?This is a standalone .gdbinit file that gives GDB a modular visual dashboard, automatically showing the program's state (registers, stack, source, etc.) every time it stops, so you type fewer inspection commands.
Is this a separate app or just a config file for GDB?It's not a separate program - it's a single .gdbinit script written against GDB's Python API that extends GDB itself, rather than a standalone tool you launch.
How do I get the dashboard running?Place the project's .gdbinit file in your home directory, then run gdb as usual - the dashboard appears automatically whenever the inferior program stops.
Do I need anything besides GDB itself?You need GDB with its Python API; installing Pygments is optional and only adds syntax highlighting to the displayed code.
Does it change any of my existing GDB commands?No - it leaves every standard GDB command untouched and exposes all of its features through the separate 'dashboard' command instead.
Why does it reduce the number of GDB commands I need to type?It shows an overview of relevant program state automatically after every stop, so developers can focus on controlling program flow instead of manually running inspection commands.
Can I customize how the dashboard panels look?The project exposes stylable attributes and lets you divide the terminal into separate panels, so you can adjust layout and appearance of the dashboard.
What happens if I skip installing Pygments?The dashboard still works fine - you just lose syntax highlighting in sections like the source and disassembly views.
What are similar projects?pwndbg, zenc, .tmux, upterm, chalk, rr, xterm.js, ttfx
Creator
cyrus-and
Size
0.4 MB
Stars
12.3K
Updated
CommitJul 17
Age
11y
Commits · 90 Days