{"id":13877934,"url":"https://github.com/ruby/reline","last_synced_at":"2025-04-29T14:21:10.438Z","repository":{"id":37602900,"uuid":"123587463","full_name":"ruby/reline","owner":"ruby","description":"The compatible library with the API of Ruby's stdlib 'readline'","archived":false,"fork":false,"pushed_at":"2025-04-04T13:33:33.000Z","size":1767,"stargazers_count":286,"open_issues_count":31,"forks_count":90,"subscribers_count":45,"default_branch":"master","last_synced_at":"2025-04-25T21:22:18.464Z","etag":null,"topics":["hacktoberfest","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruby.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"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}},"created_at":"2018-03-02T14:13:53.000Z","updated_at":"2025-04-19T05:07:16.000Z","dependencies_parsed_at":"2024-02-11T11:23:05.113Z","dependency_job_id":"9b36a78f-ccd7-439d-9a31-649373bc9e8f","html_url":"https://github.com/ruby/reline","commit_stats":{"total_commits":1528,"total_committers":72,"mean_commits":21.22222222222222,"dds":0.293848167539267,"last_synced_commit":"f13f3ca146990b426d2f3ae994f6c26ec1325c96"},"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Freline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Freline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Freline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Freline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruby","download_url":"https://codeload.github.com/ruby/reline/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250935461,"owners_count":21510552,"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":["hacktoberfest","ruby"],"created_at":"2024-08-06T08:01:35.302Z","updated_at":"2025-04-29T14:21:10.414Z","avatar_url":"https://github.com/ruby.png","language":"Ruby","readme":"[![Gem Version](https://badge.fury.io/rb/reline.svg)](https://badge.fury.io/rb/reline)\n[![CI](https://github.com/ruby/reline/actions/workflows/reline.yml/badge.svg)](https://github.com/ruby/reline/actions/workflows/reline.yml)\n\nThis is a screen capture of *IRB improved by Reline*.\n\n![IRB improved by Reline](https://raw.githubusercontent.com/wiki/ruby/reline/images/irb_improved_by_reline.gif)\n\n# Reline\n\nReline is compatible with the API of Ruby's stdlib 'readline', GNU Readline and Editline by pure Ruby implementation.\n\n## Usage\n\n### Single line editing mode\n\nIt's compatible with the readline standard library.\n\nSee [the document of readline stdlib](https://ruby-doc.org/stdlib/exts/readline/Readline.html) or [bin/example](https://github.com/ruby/reline/blob/master/bin/example).\n\n### Multi-line editing mode\n\n```ruby\nrequire \"reline\"\n\nprompt = 'prompt\u003e '\nuse_history = true\n\nbegin\n  while true\n    text = Reline.readmultiline(prompt, use_history) do |multiline_input|\n      # Accept the input until `end` is entered\n      multiline_input.split.last == \"end\"\n    end\n\n    puts 'You entered:'\n    puts text\n  end\n# If you want to exit, type Ctrl-C\nrescue Interrupt\n  puts '^C'\n  exit 0\nend\n```\n\n```bash\n$ ruby example.rb\nprompt\u003e aaa\nprompt\u003e bbb\nprompt\u003e end\nYou entered:\naaa\nbbb\nend\n```\n\nSee also: [test/reline/yamatanooroti/multiline_repl](https://github.com/ruby/reline/blob/master/test/reline/yamatanooroti/multiline_repl)\n\n## Documentation\n\n### Reline::Face\n\nYou can modify the text color and text decorations in your terminal emulator.\nSee [doc/reline/face.md](./doc/reline/face.md)\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/ruby/reline.\n\n### Run tests\n\n\u003e **Note**\n\u003e Please make sure you have `libvterm` installed for `yamatanooroti` tests (integration tests).\n\nIf you use Homebrew, you can install it by running `brew install libvterm`.\n\n```bash\nWITH_VTERM=1 bundle install\nWITH_VTERM=1 bundle exec rake test test_yamatanooroti\n```\n\n## Releasing\n\n```bash\nrake release\ngh release create vX.Y.Z --generate-notes\n```\n\n## License\n\nThe gem is available as open source under the terms of the [Ruby License](https://www.ruby-lang.org/en/about/license.txt).\n\n## Acknowledgments for [rb-readline](https://github.com/ConnorAtherton/rb-readline)\n\nIn developing Reline, we have used some of the rb-readline implementation, so this library includes [copyright notice, list of conditions and the disclaimer](license_of_rb-readline) under the 3-Clause BSD License. Reline would never have been developed without rb-readline. Thank you for the tremendous accomplishments.\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruby%2Freline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruby%2Freline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruby%2Freline/lists"}