https://github.com/deivid-rodriguez/byebug
Debugging in Ruby
https://github.com/deivid-rodriguez/byebug
Keywords
byebug debugger repl ruby
Keywords from Contributors
activerecord activejob mvc rubygem rack rspec pry crash-reporting sinatra ruby-gem
Last synced: about 6 hours ago
JSON representation
Repository metadata
Debugging in Ruby
- Host: GitHub
- URL: https://github.com/deivid-rodriguez/byebug
- Owner: deivid-rodriguez
- License: bsd-2-clause
- Created: 2013-03-18T20:21:11.000Z (almost 13 years ago)
- Default Branch: main
- Last Pushed: 2026-02-12T20:22:32.000Z (18 days ago)
- Last Synced: 2026-02-22T08:26:48.303Z (9 days ago)
- Topics: byebug, debugger, repl, ruby
- Language: Ruby
- Homepage:
- Size: 4.09 MB
- Stars: 3,351
- Watchers: 39
- Forks: 327
- Open Issues: 87
- Releases: 81
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: code_of_conduct.md
README.md
Byebug
Byebug is a simple to use and feature rich debugger for Ruby. It uses the
TracePoint API for execution control and the Debug Inspector API for call stack
navigation. Therefore, Byebug doesn't depend on internal core sources. Byebug is also
fast because it is developed as a C extension and reliable because it is supported
by a full test suite.
The debugger permits the ability to understand what is going on inside a Ruby program
while it executes and offers many of the traditional debugging features such as:
- Stepping: Running your program one line at a time.
- Breaking: Pausing the program at some event or specified instruction, to
examine the current state. - Evaluating: Basic REPL functionality, although pry does a better job at
that. - Tracking: Keeping track of the different values of your variables or the
different lines executed by your program.
For enterprise
Byebug for enterprise is available via the Tidelift Subscription. Learn
more.
Build Status
Requirements
- Required: MRI 3.2.0 or higher.
Install
gem install byebug
Alternatively, if you use bundler:
bundle add byebug --group "development, test"
Usage
From within the Ruby code
Simply include byebug wherever you want to start debugging and the execution will
stop there. For example, if you were debugging Rails, you would add byebug to
your code:
def index
byebug
@articles = Article.find_recent
end
And then start a Rails server:
bin/rails s
Once the execution gets to your byebug command, you will receive a debugging prompt.
From the command line
If you want to debug a Ruby script without editing it, you can invoke byebug from the command line.
byebug myscript.rb
Byebug's commands
| Command | Aliases | Subcommands |
|---|---|---|
backtrace |
bt w where |
|
break |
b |
|
catch |
cat |
|
condition |
cond |
|
continue |
c cont |
|
continue! |
c! cont! |
|
debug |
||
delete |
del |
|
disable |
dis |
breakpoints display |
display |
disp |
|
down |
||
edit |
ed |
|
enable |
en |
breakpoints display |
finish |
fin |
|
frame |
f |
|
help |
h |
|
history |
hist |
|
info |
i |
args breakpoints catch display file line program |
interrupt |
int |
|
irb |
||
kill |
||
list |
l |
|
method |
m |
instance |
next |
n |
|
pry |
||
quit |
q |
|
quit! |
q! |
|
restart |
||
save |
sa |
|
set |
autoirb autolist autopry autosave basename callstyle fullpath histfile histsize linetrace listsize post_mortem savefile stack_on_error width |
|
show |
autoirb autolist autopry autosave basename callstyle fullpath histfile histsize linetrace listsize post_mortem savefile stack_on_error width |
|
skip |
sk |
|
source |
so |
|
step |
s |
|
thread |
th |
current list resume stop switch |
tracevar |
tr |
|
undisplay |
undisp |
|
untracevar |
untr |
|
up |
||
var |
v |
all constant global instance local |
Semantic Versioning
Byebug attempts to follow semantic versioning and
bump major version only when backwards incompatible changes are released.
Backwards compatibility is targeted to pry-byebug and any other plugins
relying on byebug.
Getting Started
Read byebug's markdown
guide to get
started. Proper documentation will be eventually written.
Related projects
- pry-byebug adds
next,step,finish,continueandbreakcommands
topryusingbyebug. - ruby-debug-passenger adds a rake task that restarts Passenger with Byebug
connected. - minitest-byebug starts a byebug session on minitest failures.
- sublime_debugger provides a plugin for ruby debugging on Sublime Text.
- atom-byebug provides integration with the Atom editor [EXPERIMENTAL].
Contribute
See Getting Started with Development.
Funding
Subscribe to Tidelift to ensure byebug stays actively
maintained, and at the same time get licensing assurances and timely security
notifications for your open source dependencies.
You can also help byebug by leaving a small (or big) tip through Liberapay.
Security contact information
Please use the Tidelift security contact to report a security vulnerability.
Tidelift will coordinate the fix and disclosure.
Credits
Everybody who has ever contributed to this forked and reforked piece of
software, especially:
Owner metadata
- Name: David Rodríguez
- Login: deivid-rodriguez
- Email:
- Kind: user
- Description: Open source paramedic
- Website:
- Location: Madrid, Spain
- Twitter:
- Company: @tidelift
- Icon url: https://avatars.githubusercontent.com/u/2887858?v=4
- Repositories: 239
- Last ynced at: 2025-12-13T01:35:49.472Z
- Profile URL: https://github.com/deivid-rodriguez
GitHub Events
Total
- Release event: 1
- Delete event: 55
- Pull request event: 112
- Fork event: 7
- Issues event: 6
- Watch event: 39
- Issue comment event: 49
- Push event: 104
- Pull request review event: 4
- Create event: 52
Last Year
- Release event: 1
- Delete event: 55
- Pull request event: 112
- Fork event: 3
- Issues event: 5
- Watch event: 20
- Issue comment event: 43
- Push event: 104
- Pull request review event: 4
- Create event: 52
Committers metadata
Last synced: 4 days ago
Total Commits: 2,841
Total Committers: 81
Avg Commits per committer: 35.074
Development Distribution Score (DDS): 0.306
Commits in past year: 96
Committers in past year: 10
Avg Commits per committer in past year: 9.6
Development Distribution Score (DDS) in past year: 0.417
| Name | Commits | |
|---|---|---|
| David Rodríguez | d****z@g****m | 1973 |
| David Rodríguez | d****z@r****t | 540 |
| dependabot[bot] | d****] | 86 |
| dependabot-preview[bot] | 2****] | 70 |
| Yuichiro Kaneko | s****a@g****m | 15 |
| Oleg Sukhodolsky | o****3@g****m | 9 |
| Eric Hu | h****c@g****m | 9 |
| Anton Baklanov | a****v@g****m | 9 |
| Yuri Kanivetsky | y****y@g****m | 7 |
| Takashi Kokubun | t****n@g****m | 7 |
| MSP-Greg | M****g | 6 |
| Anton Astashov | a****v@g****m | 6 |
| Sergio | 2****9 | 5 |
| Antonio Terceiro | a****a@t****z | 4 |
| dependabot[bot] | s****t@d****m | 4 |
| tzmfreedom | m****u@h****p | 4 |
| Shuky Chen | s****9@g****m | 3 |
| Vladimir Kochnev | h****e@y****u | 3 |
| Hongli Lai (Phusion) | h****i@p****l | 3 |
| Jon Atack | j****k@g****m | 3 |
| Kohei Suzuki | e****t@g****m | 3 |
| Utkarsh Gupta | u****h@d****g | 3 |
| Dariusz Dzien | d****2@g****m | 2 |
| Benjamin Quorning | b****g@z****m | 2 |
| Arthur Neves | a****n@g****m | 2 |
| Edward Ocampo-Gooding | e****d@e****t | 2 |
| Jun Kudou | p****g@a****p | 2 |
| Ethan Reesor | f****d@g****m | 2 |
| Geremia Taglialatela | t****a | 2 |
| Nobuyoshi Nakada | n****u@r****g | 2 |
| and 51 more... | ||
Committer domains:
- cookpad.com: 2
- wikimatze.de: 1
- swrve.com: 1
- codequest.eu: 1
- pivotallabs.com: 1
- exitloop.ca: 1
- dio.jp: 1
- ruby-lang.org: 1
- akanekodou.mydns.jp: 1
- edwardog.net: 1
- zendesk.com: 1
- debian.org: 1
- phusion.nl: 1
- yandex.ru: 1
- hotmail.co.jp: 1
- dependabot.com: 1
- terceiro.xyz: 1
- riseup.net: 1
- lendkey.com: 1
- bonanza.com: 1
- jm3.net: 1
- lovedthanlost.net: 1
- puppetlabs.com: 1
- hespul.org: 1
- me.com: 1
- shopify.com: 1
- qrmaster.co.nz: 1
- bitdeli.com: 1
- redhat.com: 1
- rubyforge.net: 1
- tegali.com: 1
- tis.co.jp: 1
- val.co.jp: 1
- meowfishies.com: 1
- phili.pe: 1
- plaidshirt.io: 1
Issue and Pull Request metadata
Last synced: 4 days ago
Total issues: 47
Total pull requests: 171
Average time to close issues: almost 2 years
Average time to close pull requests: 8 months
Total issue authors: 46
Total pull request authors: 23
Average comments per issue: 6.36
Average comments per pull request: 0.91
Merged pull request: 57
Bot issues: 0
Bot pull requests: 127
Past year issues: 5
Past year pull requests: 85
Past year average time to close issues: 1 day
Past year average time to close pull requests: 11 days
Past year issue authors: 5
Past year pull request authors: 5
Past year average comments per issue: 2.6
Past year average comments per pull request: 0.42
Past year merged pull request: 29
Past year bot issues: 0
Past year bot pull requests: 67
Top Issue Authors
- shubhamjaincav (2)
- halhenke (1)
- davidrunger (1)
- ndbroadbent (1)
- benlieb (1)
- deivid-rodriguez (1)
- fxn (1)
- ryanb (1)
- AlexanderZagaynov (1)
- katawura (1)
- JunichiIto (1)
- bgvo (1)
- jacobobq (1)
- ariccio (1)
- senhalil (1)
Top Pull Request Authors
- dependabot[bot] (71)
- dependabot-preview[bot] (56)
- deivid-rodriguez (18)
- ono-max (2)
- pabloh (2)
- andrew (2)
- bitwise-aiden (2)
- davidrunger (2)
- sergioro9 (2)
- Mangara (1)
- pocke (1)
- marshall-lee (1)
- 0xsatoshi99 (1)
- garmoshka-mo (1)
- alexymik (1)
Top Issue Labels
- enhancement (3)
- needs feedback (1)
- help wanted (1)
Top Pull Request Labels
- dependencies (127)
- ruby (67)
- security (6)
Package metadata
- Total packages: 13
-
Total downloads:
- rubygems: 884,482,426 total
- Total docker downloads: 1,656,036,570
- Total dependent packages: 3,269 (may contain duplicates)
- Total dependent repositories: 510,541 (may contain duplicates)
- Total versions: 257
- Total maintainers: 1
gem.coop: byebug
Byebug is a Ruby debugger. It's implemented using the TracePoint C API for execution control and the Debug Inspector C API for call stack navigation. The core component provides support that front-ends can build on. It provides breakpoint handling and bindings for stack frames among other things and it comes with an easy to use command line interface.
- Homepage: https://github.com/deivid-rodriguez/byebug
- Documentation: http://www.rubydoc.info/gems/byebug/
- Licenses: BSD-2-Clause
- Latest release: 13.0.0 (published about 2 months ago)
- Last Synced: 2026-02-27T15:31:17.373Z (4 days ago)
- Versions: 83
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 442,429,367 Total
- Docker Downloads: 828,018,285
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.041%
- Downloads: 0.052%
- Docker downloads count: 0.111%
- Maintainers (1)
rubygems.org: byebug
Byebug is a Ruby debugger. It's implemented using the TracePoint C API for execution control and the Debug Inspector C API for call stack navigation. The core component provides support that front-ends can build on. It provides breakpoint handling and bindings for stack frames among other things and it comes with an easy to use command line interface.
- Homepage: https://github.com/deivid-rodriguez/byebug
- Documentation: http://www.rubydoc.info/gems/byebug/
- Licenses: BSD-2-Clause
- Latest release: 13.0.0 (published about 2 months ago)
- Last Synced: 2026-02-25T22:02:29.879Z (5 days ago)
- Versions: 83
- Dependent Packages: 3,269
- Dependent Repositories: 510,541
- Downloads: 442,053,059 Total
- Docker Downloads: 828,018,285
-
Rankings:
- Dependent packages count: 0.018%
- Dependent repos count: 0.031%
- Downloads: 0.051%
- Docker downloads count: 0.177%
- Average: 0.401%
- Stargazers count: 0.628%
- Forks count: 1.5%
- Maintainers (1)
proxy.golang.org: github.com/deivid-rodriguez/byebug
- Homepage:
- Documentation: https://pkg.go.dev/github.com/deivid-rodriguez/byebug#section-documentation
- Licenses: bsd-2-clause
- Latest release: v13.0.0+incompatible (published about 2 months ago)
- Last Synced: 2026-02-25T16:22:13.993Z (6 days ago)
- Versions: 81
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 6.515%
- Average: 6.733%
- Dependent repos count: 6.952%
ubuntu-23.10: ruby-byebug
- Homepage: https://github.com/deivid-rodriguez/byebug
- Licenses: bsd-2-clause
- Latest release: 11.1.3-3build2 (published 18 days ago)
- Last Synced: 2026-02-13T18:16:17.036Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-10: ruby-byebug
- Homepage: http://github.com/deivid-rodriguez/byebug
- Documentation: https://packages.debian.org/buster/ruby-byebug
- Licenses: bsd-2-clause
- Latest release: 10.0.2-1 (published 20 days ago)
- Last Synced: 2026-02-13T04:19:44.482Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-23.04: ruby-byebug
- Homepage: https://github.com/deivid-rodriguez/byebug
- Licenses:
- Latest release: 11.1.3-3build2 (published 20 days ago)
- Last Synced: 2026-02-11T06:36:35.336Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-20.04: ruby-byebug
- Homepage: https://github.com/deivid-rodriguez/byebug
- Licenses: bsd-2-clause
- Latest release: 11.1.1-2 (published 18 days ago)
- Last Synced: 2026-02-13T07:11:02.532Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-11: ruby-byebug
- Homepage: https://github.com/deivid-rodriguez/byebug
- Documentation: https://packages.debian.org/bullseye/ruby-byebug
- Licenses:
- Latest release: 11.1.3-1 (published 20 days ago)
- Last Synced: 2026-02-13T08:18:57.715Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-22.04: ruby-byebug
- Homepage: https://github.com/deivid-rodriguez/byebug
- Licenses:
- Latest release: 11.1.3-2build1 (published 18 days ago)
- Last Synced: 2026-02-13T13:13:48.483Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-12: ruby-byebug
- Homepage: https://github.com/deivid-rodriguez/byebug
- Documentation: https://packages.debian.org/bookworm/ruby-byebug
- Licenses:
- Latest release: 11.1.3-3 (published 18 days ago)
- Last Synced: 2026-02-12T23:26:18.070Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-13: ruby-byebug
- Homepage: https://github.com/deivid-rodriguez/byebug
- Documentation: https://packages.debian.org/trixie/ruby-byebug
- Licenses:
- Latest release: 11.1.3-5 (published 19 days ago)
- Last Synced: 2026-02-13T13:13:48.624Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
Dependencies
- chandler = 0.9.0 development
- minitest ~> 5.11 development
- pry = 0.14.1 development
- rake ~> 13.0 development
- rake-compiler ~> 1.0 development
- simplecov = 0.21.2 development
- yard = 0.9.26 development
- addressable 2.7.0
- byebug 11.1.3
- chandler 0.9.0
- coderay 1.1.3
- docile 1.3.4
- faraday 1.0.0
- method_source 1.0.0
- minitest 5.14.4
- multipart-post 2.1.1
- netrc 0.11.0
- octokit 4.15.0
- pry 0.14.1
- public_suffix 4.0.3
- rake 13.0.3
- rake-compiler 1.1.1
- sawyer 0.8.2
- simplecov 0.21.2
- simplecov-html 0.12.3
- simplecov_json_formatter 0.1.2
- yard 0.9.26
- bundler ~> 2.0 development
- mdl = 0.11.0 development
- rubocop = 1.3.1 development
- rubocop-packaging ~> 0.5 development
- rubocop-performance ~> 1.3 development
- yard = 0.9.26 development
- ast 2.4.2
- chef-utils 16.6.14
- kramdown 2.3.0
- kramdown-parser-gfm 1.1.0
- mdl 0.11.0
- mixlib-cli 2.1.8
- mixlib-config 3.0.9
- mixlib-shellout 3.1.7
- parallel 1.20.1
- parser 3.0.0.0
- rainbow 3.0.0
- regexp_parser 2.1.1
- rexml 3.2.4
- rubocop 1.3.1
- rubocop-ast 1.4.1
- rubocop-packaging 0.5.1
- rubocop-performance 1.10.2
- ruby-progressbar 1.11.0
- tomlrb 1.3.0
- unicode-display_width 1.7.0
- yard 0.9.26
- actions/checkout v2 composite
- actions/checkout v2 composite
- actions/checkout v2 composite
- actions/download-artifact v1 composite
- actions/upload-artifact v1 composite
- actions/cache v1 composite
- actions/checkout v2 composite
- ruby/setup-ruby v1 composite
- alpine 3.10 build
- actions/checkout v5 composite
- ruby/setup-ruby v1 composite
Score: 34.192931999470225