How to set a breakpoint in byebug?

Use the 'break' command followed by a line number or method name, such as 'break 10' for line 10 or 'break Article#index' for a method. This allows pausing execution at specific points to inspect state.

Byebug vs pry: which is better for debugging?

Byebug excels at core debugging features like stepping and breaking with better performance due to its C extension, while pry offers superior REPL capabilities. For pure debugging, Byebug is often preferred, but pry is better for interactive exploration.

How to step through Rails code with byebug?

Add 'byebug' in your Rails controller or model code, then start the server. When execution hits the byebug call, you'll get a prompt where you can use commands like 'next' to move line by line or 'step' to enter methods.

Does byebug support remote debugging?

Yes, through integrations like ruby-debug-passenger for Passenger. Byebug can be used in remote scenarios with additional setup, though it primarily focuses on local command-line debugging.

How to install byebug in a Ruby project?

Install it via 'gem install byebug' or add 'gem "byebug", group: "development, test"' to your Gemfile. For Rails, this is common in development and test environments to avoid production overhead.

Byebug commands cheat sheet?

Common commands include 'next' for executing the next line, 'step' for stepping into methods, 'continue' to resume, and 'backtrace' to view the call stack. The README provides a full table with aliases for quick reference.

Open-Awesome

byebug

BSD-2-ClauseRubyv13.0.0

A simple to use, feature-rich debugger for Ruby built as a C extension using the TracePoint and Debug Inspector APIs.

GitHub

3.4k stars328 forks0 contributors

What is byebug?

Byebug is a feature-rich debugger for Ruby that allows developers to pause program execution, inspect variables, and step through code line by line. It solves the problem of understanding runtime behavior in Ruby applications by providing traditional debugging features like stepping, breaking, and variable tracking.

Target Audience

Ruby developers who need to debug applications, particularly those working with Rails or other Ruby frameworks who require interactive debugging capabilities during development and testing.

Value Proposition

Developers choose Byebug because it's fast (built as a C extension), reliable (fully tested), and doesn't depend on internal Ruby core sources. It integrates seamlessly into Ruby workflows and offers a comprehensive set of debugging commands.

Overview

Debugging in Ruby

Use Cases

Best For

Debugging Rails applications during development
Stepping through complex Ruby scripts line by line
Inspecting variable states at specific breakpoints
Debugging test failures in Minitest or other testing frameworks
Remote debugging with Passenger integration
Learning Ruby execution flow through interactive debugging

Not Ideal For

Ruby projects using MRI versions older than 3.2.0
Developers who prioritize advanced REPL features for expression evaluation and exploration
Teams requiring graphical debugging interfaces or deep IDE integrations
Environments with strict dependency constraints where installing a C extension is problematic

Pros & Cons

Pros

Fast C Extension

Built as a C extension, Byebug offers high performance with minimal overhead during debugging sessions, as explicitly stated in the README.

Reliable and Tested

Supported by a full test suite, ensuring stability and fewer bugs, making it a dependable choice for critical debugging tasks.

Modern API Integration

Uses Ruby's TracePoint and Debug Inspector APIs, avoiding dependency on internal core sources and ensuring future compatibility.

Rich Command Set

Includes a comprehensive array of commands for stepping, breaking, tracking, and more, as detailed in the command table, providing fine-grained debugging control.

Cons

Basic REPL Functionality

The README admits that pry does a better job at evaluating expressions, making Byebug's REPL capabilities limited for developers who need rich interactive exploration.

Ruby Version Restriction

Only supports MRI Ruby 3.2.0 or higher, excluding projects on older versions or alternative implementations like JRuby, as specified in the requirements.

Incomplete Documentation

Proper documentation is not yet written, relying only on a markdown guide, which may be insufficient for advanced users or complex debugging scenarios.

Frequently Asked Questions

Related Projects

Better Errors

Better error page for Rack apps

Stars6,871

Forks433

Last commit1 year ago

awesome_print

Pretty print your Ruby objects with style -- in full color and with proper indentation

Stars4,083

Forks449

Last commit1 year ago

RailsPanel

Chrome extension for Rails development

Stars3,871

Forks187

Last commit12 days ago

letter_opener

Preview mail in the browser instead of sending.

Stars3,842

Forks244

Last commit1 month ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub