Quick Start

A brief overview of how to start with HyperDbg

Starting with HyperDbg

First of all, you should know about different Operation Modes and Prerequisites in HyperDbg.

• VMI Mode
• Debugger Mode
• Transparent Mode

If you want to learn how to use HyperDbg along with practical and real-world examples visit the following tutorial.

• OpenSecurityTraining2's Reversing with HyperDbg (Dbg3301) [YouTube]

If you want to build HyperDbg, follow the steps in the links below; you can also download compiled binaries instead of building HyperDbg.

• Transparent Mode
• Build & Install
• Download Releases

After that, you need to attach to an instance of HyperDbg.

• Local Debugging (VMI Mode)
• Debug a Physical Machine (Debugger Mode)
• Debug a VMware Workstation Guest (Debugger Mode)
• Connect to a Remote Machine (VMI Mode)
• Start a new process (VMI Mode and Debugger Mode)
• Attach to a running process (VMI Mode)

Finally, you can see many examples provided in the following link to use HyperDbg.

User-mode Debugging examples:

Examples

Kernel-mode Debugging examples:

Examples

Script engine examples:

ExamplesHyperDbg Documentation

Done! You successfully used HyperDbg Debugger.

List of HyperDbg Commands

• Debugging Commands
• Meta Commands
• Extension Commands

Scripting Language

• Assumptions & Evaluations
• Conditionals & Loops
• Variables & Assignments
• Script Functions
• Script Examples
• List of Script Functions

More advanced topics...

If you want to see more advanced topics about HyperDbg.

• How to create an action?
• How to create a condition?

Things to consider when using HyperDbg

• Basic Concepts in Intel VT-x
• VMX root-mode vs VMX non-root mode
• The "unsafe" behavior
• Script engine in VMX non-root mode
• Difference between process and thread switching commands
• Transparent Mode

Miscellaneous topics...

• Event Forwarding Mechanism
• Event short-circuiting Mechanism
• Event calling stages
• Instant events
• Message Overflow
• Switch to New Process Layout
• Customize Build
• Enable and Disable Events in Debugger Mode

HyperDbg Research and Design Internals

• HyperDbg Research
• Kernel Debugger Design
• Academic Paper (Reinventing Hardware-Assisted Debugging)
• VM-exit Transparency in HyperDbg
• Awesome Resources About HyperDbg
• Command Map (HyperDbg to Native Debuggers)
• Logo & Graphics
• Scripts

If you want to participate in HyperDbg

• Coding Style
• Command Style
• Doxygen Style
• Logo & Artworks

You can also follow the contribution guide.

Software Development Kit (SDK)

Software Development Kit (SDK)HyperDbg Documentation

Any other questions

If you have any other questions, then it's probably addressed in the FAQ section. If your question remains unanswered or your problem is unsolved, you can create an issue.