{"id":13428036,"url":"https://github.com/deivid-rodriguez/byebug","last_synced_at":"2025-05-12T05:19:27.317Z","repository":{"id":7513004,"uuid":"8863313","full_name":"deivid-rodriguez/byebug","owner":"deivid-rodriguez","description":"Debugging in Ruby","archived":false,"fork":false,"pushed_at":"2025-05-05T21:19:52.000Z","size":4280,"stargazers_count":3343,"open_issues_count":90,"forks_count":329,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-05-08T11:45:46.653Z","etag":null,"topics":["byebug","debugger","repl","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deivid-rodriguez.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"deivid-rodriguez","liberapay":"byebug","tidelift":"rubygems/byebug"}},"created_at":"2013-03-18T20:21:11.000Z","updated_at":"2025-05-04T13:09:36.000Z","dependencies_parsed_at":"2023-02-17T17:50:38.187Z","dependency_job_id":"5409ca5b-10a2-45f2-b10e-9aafda0ed8ce","html_url":"https://github.com/deivid-rodriguez/byebug","commit_stats":{"total_commits":2745,"total_committers":75,"mean_commits":36.6,"dds":0.2812386156648452,"last_synced_commit":"7e7384836defcfb40b675f5405428515b48eea9e"},"previous_names":[],"tags_count":80,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deivid-rodriguez%2Fbyebug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deivid-rodriguez%2Fbyebug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deivid-rodriguez%2Fbyebug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deivid-rodriguez%2Fbyebug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deivid-rodriguez","download_url":"https://codeload.github.com/deivid-rodriguez/byebug/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253141474,"owners_count":21860541,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["byebug","debugger","repl","ruby"],"created_at":"2024-07-31T01:00:44.686Z","updated_at":"2025-05-09T00:35:32.511Z","avatar_url":"https://github.com/deivid-rodriguez.png","language":"Ruby","funding_links":["https://github.com/sponsors/deivid-rodriguez","https://liberapay.com/byebug","https://tidelift.com/funding/github/rubygems/byebug","https://tidelift.com/badges/package/rubygems/byebug","https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=readme_badge","https://liberapay.com/byebug/donate","https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=readme_text","https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=referral\u0026utm_campaign=github\u0026utm_content=enterprise","https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=referral\u0026utm_campaign=github\u0026utm_content=support","https://tidelift.com/security"],"categories":["Debug","Ruby","调试","Web 后端","Gems","Debugging Tools","Debugging"],"sub_categories":["Omniauth","Debugging"],"readme":"# Byebug\n\n[![Version][gem]][gem_url]\n[![Tidelift][tid]][tid_url]\n[![Gitter][irc]][irc_url]\n\n[gem]: https://img.shields.io/gem/v/byebug.svg\n[tid]: https://tidelift.com/badges/package/rubygems/byebug\n[irc]: https://img.shields.io/badge/IRC%20(gitter)-devs%20%26%20users-brightgreen.svg\n\n[gem_url]: https://rubygems.org/gems/byebug\n[tid_url]: https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=readme_badge\n[irc_url]: https://gitter.im/deivid-rodriguez/byebug\n\nByebug is a simple to use and feature rich debugger for Ruby. It uses the\nTracePoint API for execution control and the Debug Inspector API for call stack\nnavigation. Therefore, Byebug doesn't depend on internal core sources. Byebug is also\nfast because it is developed as a C extension and reliable because it is supported\nby a full test suite.\n\nThe debugger permits the ability to understand what is going on _inside_ a Ruby program\nwhile it executes and offers many of the traditional debugging features such as:\n\n* Stepping: Running your program one line at a time.\n* Breaking: Pausing the program at some event or specified instruction, to\n  examine the current state.\n* Evaluating: Basic REPL functionality, although [pry] does a better job at\n  that.\n* Tracking: Keeping track of the different values of your variables or the\n  different lines executed by your program.\n\n## For enterprise\n\nByebug for enterprise is available via the Tidelift Subscription. [Learn\nmore][Tidelift for enterprise].\n\n## Build Status\n\n![ubuntu](https://github.com/deivid-rodriguez/byebug/workflows/ubuntu/badge.svg)\n![windows](https://github.com/deivid-rodriguez/byebug/workflows/windows/badge.svg)\n\n## Requirements\n\n* _Required_: MRI 3.1.0 or higher.\n\n## Install\n\n```shell\ngem install byebug\n```\n\nAlternatively, if you use `bundler`:\n\n```shell\nbundle add byebug --group \"development, test\"\n```\n\n## Usage\n\n### From within the Ruby code\n\nSimply include `byebug` wherever you want to start debugging and the execution will\nstop there. For example, if you were debugging Rails, you would add `byebug` to\nyour code:\n\n```ruby\ndef index\n  byebug\n  @articles = Article.find_recent\nend\n```\n\nAnd then start a Rails server:\n\n```shell\nbin/rails s\n```\n\nOnce the execution gets to your `byebug` command, you will receive a debugging prompt.\n\n### From the command line\n\nIf you want to debug a Ruby script without editing it, you can invoke byebug from the command line.\n\n```shell\nbyebug myscript.rb\n```\n\n## Byebug's commands\n\nCommand     | Aliases         | Subcommands\n-------     | -------         | -----------\n`backtrace` | `bt` `w` `where`|\n`break`     | `b`             |\n`catch`     | `cat`           |\n`condition` | `cond`          |\n`continue`  | `c` `cont`      |\n`continue!` | `c!` `cont!`    |\n`debug`     |                 |\n`delete`    | `del`           |\n`disable`   | `dis`           | `breakpoints` `display`\n`display`   | `disp`          |\n`down`      |                 |\n`edit`      | `ed`            |\n`enable`    | `en`            | `breakpoints` `display`\n`finish`    | `fin`           |\n`frame`     | `f`             |\n`help`      | `h`             |\n`history`   | `hist`          |\n`info`      | `i`             | `args` `breakpoints` `catch` `display` `file` `line` `program`\n`interrupt` | `int`           |\n`irb`       |                 |\n`kill`      |                 |\n`list`      | `l`             |\n`method`    | `m`             | `instance`\n`next`      | `n`             |\n`pry`       |                 |\n`quit`      | `q`             |\n`quit!`     | `q!`            |\n`restart`   |                 |\n`save`      | `sa`            |\n`set`       |                 | `autoirb` `autolist` `autopry` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `width`\n`show`      |                 | `autoirb` `autolist` `autopry` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `width`\n`skip`      | `sk`            |\n`source`    | `so`            |\n`step`      | `s`             |\n`thread`    | `th`            | `current` `list` `resume` `stop` `switch`\n`tracevar`  | `tr`            |\n`undisplay` | `undisp`        |\n`untracevar`| `untr`          |\n`up`        |                 |\n`var`       | `v`             | `all` `constant` `global` `instance` `local`\n\n## Semantic Versioning\n\nByebug attempts to follow [semantic versioning](https://semver.org) and\nbump major version only when backwards incompatible changes are released.\nBackwards compatibility is targeted to [pry-byebug] and any other plugins\nrelying on `byebug`.\n\n## Getting Started\n\nRead [byebug's markdown\nguide](https://github.com/deivid-rodriguez/byebug/blob/master/GUIDE.md) to get\nstarted. Proper documentation will be eventually written.\n\n## Related projects\n\n* [pry-byebug] adds `next`, `step`, `finish`, `continue` and `break` commands\n  to `pry` using `byebug`.\n* [ruby-debug-passenger] adds a rake task that restarts Passenger with Byebug\n  connected.\n* [minitest-byebug] starts a byebug session on minitest failures.\n* [sublime_debugger] provides a plugin for ruby debugging on Sublime Text.\n* [atom-byebug] provides integration with the Atom editor [EXPERIMENTAL].\n\n## Contribute\n\nSee [Getting Started with Development](CONTRIBUTING.md).\n\n## Funding\n\nSubscribe to [Tidelift][Tidelift support] to ensure byebug stays actively\nmaintained, and at the same time get licensing assurances and timely security\nnotifications for your open source dependencies.\n\nYou can also help `byebug` by leaving a small (or big) tip through [Liberapay].\n\n## Security contact information\n\nPlease use the Tidelift security contact to [report a security vulnerability].\nTidelift will coordinate the fix and disclosure.\n\n## Credits\n\nEverybody who has ever contributed to this forked and reforked piece of\nsoftware, especially:\n\n* @ko1, author of the awesome TracePoint API for Ruby.\n* @cldwalker, [debugger]'s maintainer.\n* @denofevil, author of [debase], the starting point of this.\n* @kevjames3 for testing, bug reports and the interest in the project.\n* @FooBarWidget for working and helping with remote debugging.\n\n[debugger]: https://github.com/cldwalker/debugger\n[pry]: https://github.com/pry/pry\n[debase]: https://github.com/denofevil/debase\n[pry-byebug]: https://github.com/deivid-rodriguez/pry-byebug\n[ruby-debug-passenger]: https://github.com/davejamesmiller/ruby-debug-passenger\n[minitest-byebug]: https://github.com/kaspth/minitest-byebug\n[sublime_debugger]: https://github.com/shuky19/sublime_debugger\n[atom-byebug]: https://github.com/izaera/atom-byebug\n[Liberapay]: https://liberapay.com/byebug/donate\n[Tidelift]: https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=readme_text\n[Tidelift for enterprise]: https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=referral\u0026utm_campaign=github\u0026utm_content=enterprise\n[Tidelift support]: https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug\u0026utm_medium=referral\u0026utm_campaign=github\u0026utm_content=support\n[report a security vulnerability]: https://tidelift.com/security\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeivid-rodriguez%2Fbyebug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeivid-rodriguez%2Fbyebug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeivid-rodriguez%2Fbyebug/lists"}