https://github.com/ruby/reline

The compatible library with the API of Ruby's stdlib 'readline'
https://github.com/ruby/reline

Keywords

hacktoberfest ruby

Keywords from Contributors

rubygems repl activerecord mvc activejob documentation-tool debugger rubocop json-parser libyaml

Last synced: about 11 hours ago
JSON representation

Repository metadata

The compatible library with the API of Ruby's stdlib 'readline'

Host: GitHub
URL: https://github.com/ruby/reline
Owner: ruby
License: other
Created: 2018-03-02T14:13:53.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2026-04-21T06:20:01.000Z (10 days ago)
Last Synced: 2026-04-25T09:05:24.407Z (6 days ago)
Topics: hacktoberfest, ruby
Language: Ruby
Homepage:
Size: 1.83 MB
Stars: 296
Watchers: 40
Forks: 95
Open Issues: 36
Releases: 70
Metadata Files:
- Readme: README.md
- License: COPYING

README.md

This is a screen capture of IRB improved by Reline.

IRB improved by Reline

Reline

Reline is compatible with the API of Ruby's stdlib 'readline', GNU Readline and Editline by pure Ruby implementation.

Usage

Single line editing mode

It's compatible with the readline standard library.

See the document of readline stdlib or bin/example.

Multi-line editing mode

require "reline"

prompt = 'prompt> '
use_history = true

begin
  while true
    text = Reline.readmultiline(prompt, use_history) do |multiline_input|
      # Accept the input until `end` is entered
      multiline_input.split.last == "end"
    end

    puts 'You entered:'
    puts text
  end
# If you want to exit, type Ctrl-C
rescue Interrupt
  puts '^C'
  exit 0
end

$ ruby example.rb
prompt> aaa
prompt> bbb
prompt> end
You entered:
aaa
bbb
end

Documentation

Reline::Face

You can modify the text color and text decorations in your terminal emulator.
See doc/reline/face.md

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/reline.

Run tests

Note
Please make sure you have libvterm installed for yamatanooroti tests (integration tests).

If you use Homebrew, you can install it by running brew install libvterm.

WITH_VTERM=1 bundle install
WITH_VTERM=1 bundle exec rake test test_yamatanooroti

Releasing

rake release
gh release create vX.Y.Z --generate-notes

License

The gem is available as open source under the terms of the Ruby License.

Acknowledgments for rb-readline

In developing Reline, we have used some of the rb-readline implementation, so this library includes copyright notice, list of conditions and the disclaimer under the 3-Clause BSD License. Reline would never have been developed without rb-readline. Thank you for the tremendous accomplishments.

Owner metadata

Name: The Ruby Programming Language
Login: ruby
Email: info@ruby-lang.org
Kind: organization
Description: Repositories related to the Ruby Programming language
Website: https://www.ruby-lang.org/
Location: Matsue, Japan
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/210414?v=4
Repositories: 171
Last ynced at: 2023-04-09T03:40:20.875Z
Profile URL: https://github.com/ruby

GitHub Events

Total

Create event: 18
Commit comment event: 1
Release event: 6
Delete event: 19
Pull request event: 136
Fork event: 12
Issues event: 26
Watch event: 33
Issue comment event: 68
Push event: 69
Pull request review comment event: 77
Pull request review event: 125

Last Year

Create event: 12
Commit comment event: 1
Release event: 2
Delete event: 15
Pull request event: 45
Fork event: 2
Issues event: 5
Watch event: 5
Issue comment event: 17
Push event: 21
Pull request review event: 42
Pull request review comment event: 31

Committers metadata

Last synced: 1 day ago

Total Commits: 1,621
Total Committers: 71
Avg Commits per committer: 22.831
Development Distribution Score (DDS): 0.334

Commits in past year: 47
Committers in past year: 10
Avg Commits per committer in past year: 4.7
Development Distribution Score (DDS) in past year: 0.468

Name	Email	Commits
aycabta	a**a@g**m	1080
tomoya ishida	t**n@g**m	128
Mari Imaizumi	m**5@g**m	69
Nobuyoshi Nakada	n**u@r**g	60
manga_osyo	m**o@g**m	58
Stan Lo	s**2@g**m	31
dependabot[bot]	4****]	27
YO4	y**o@a**p	16
Hiroshi SHIBATA	h**t@r**g	14
MSP-Greg	M****g	13
Takashi Kokubun	t**n@g**m	11
Yusuke Endoh	m**e@r**g	8
Jeremy Evans	c**e@j**t	7
Otávio Schwanck dos Santos	o**k@g**m	6
HASUMI Hitoshi	h**n@g**m	5
Kazuhiro NISHIYAMA	zn@m****m	5
elfham	3****m	5
Phillip Hellewell	s**k@g**m	4
Lars Kanis	l**s@g**e	4
Samuel Williams	s**s@o**z	3
Étienne Barrié	e**e@g**m	3
Wu	m**r@g**m	3
Koichi Sasada	k**1@a**t	3
Sorah Fukumori	h**r@s**p	2
SilverPhoenix99	s**9@g**m	2
Robert Schulze	r**t@d**e	2
Ricky McMillen	r**y@r**k	2
Peter Zhu	p**r@p**a	2
Olle Jonsson	o**n@g**m	2
Mark Delk	j**l@g**m	2
and 41 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 9 days ago

Total issues: 119
Total pull requests: 490
Average time to close issues: 9 months
Average time to close pull requests: about 2 months
Total issue authors: 66
Total pull request authors: 52
Average comments per issue: 1.93
Average comments per pull request: 0.87
Merged pull request: 382
Bot issues: 0
Bot pull requests: 23

Past year issues: 7
Past year pull requests: 63
Past year average time to close issues: 4 months
Past year average time to close pull requests: 10 days
Past year issue authors: 7
Past year pull request authors: 13
Past year average comments per issue: 2.0
Past year average comments per pull request: 0.37
Past year merged pull request: 39
Past year bot issues: 0
Past year bot pull requests: 22

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ruby/reline

Top Issue Authors

tompng (22)
aycabta (8)
elfham (5)
rubyFeedback (5)
sjanusz-r7 (4)
sfrieske (4)
ima1zumi (3)
postmodern (3)
st0012 (3)
eregon (2)
fractaledmind (2)
headius (2)
ddoherty03 (2)
hsbt (2)
DirtYiCE (1)

Top Pull Request Authors

tompng (216)
ima1zumi (84)
st0012 (40)
dependabot[bot] (23)
nobu (12)
hsbt (11)
hasumikin (7)
monkeyWzr (6)
YO4 (6)
elfham (5)
osyo-manga (5)
etiennebarrie (4)
sshock (4)
amatsuda (4)
sorah (3)

Top Issue Labels

bug (27)
enhancement (22)
good first issue (4)
Windows (2)

Top Pull Request Labels

bug (88)
enhancement (34)
dependencies (24)
github_actions (22)
documentation (5)
Don't merge (1)

Package metadata

Total packages: 5
Total downloads:
- rubygems: 405,023,843 total
Total docker downloads: 7,282,434,228
Total dependent packages: 20 (may contain duplicates)
Total dependent repositories: 28,587 (may contain duplicates)
Total versions: 200
Total maintainers: 8

gem.coop: reline

Alternative GNU Readline or Editline implementation by pure Ruby.

Homepage: https://github.com/ruby/reline
Documentation: http://www.rubydoc.info/gems/reline/
Licenses: Ruby
Latest release: 0.6.3 (published 6 months ago)
Last Synced: 2026-04-29T20:00:28.863Z (1 day ago)
Versions: 70
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 202,542,833 Total
Docker Downloads: 3,641,217,114
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Docker downloads count: 0.016%
- Average: 0.045%
- Downloads: 0.164%
Maintainers (7)
- hsbt
- st0012
- k0kubun
- aycabta
- tompng
- hasumikin
- ima1zumi

rubygems.org: reline

Alternative GNU Readline or Editline implementation by pure Ruby.

Homepage: https://github.com/ruby/reline
Documentation: http://www.rubydoc.info/gems/reline/
Licenses: Ruby
Latest release: 0.6.3 (published 6 months ago)
Last Synced: 2026-04-29T16:55:04.909Z (1 day ago)
Versions: 70
Dependent Packages: 20
Dependent Repositories: 28,587
Downloads: 202,481,010 Total
Docker Downloads: 3,641,217,114
Rankings:
- Docker downloads count: 0.018%
- Dependent repos count: 0.211%
- Downloads: 0.522%
- Dependent packages count: 1.446%
- Average: 1.537%
- Forks count: 3.12%
- Stargazers count: 3.906%
Maintainers (7)
- hsbt
- st0012
- k0kubun
- aycabta
- tompng
- ima1zumi
- hasumikin

pkg.adelielinux.org: ruby-reline

Reline is compatible with the API of Ruby's stdlib 'readline', GNU Readline and Editline

Homepage: https://github.com/ruby/reline
Licenses: BSD-2-Clause
Latest release: 0.2.7-r0 (published over 3 years ago)
Last Synced: 2026-03-14T15:47:05.723Z (about 2 months ago)
Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent repos count: 0.0%
- Forks count: 3.585%
- Stargazers count: 4.213%
- Average: 6.293%
- Dependent packages count: 17.376%
Maintainers (1)
- djt@hxx.in

proxy.golang.org: github.com/ruby/reline

Homepage:
Documentation: https://pkg.go.dev/github.com/ruby/reline#section-documentation
Licenses: other
Latest release: v0.6.3 (published 6 months ago)
Last Synced: 2026-04-28T20:00:58.798Z (3 days ago)
Versions: 58
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Forks count: 3.021%
- Stargazers count: 3.626%
- Average: 6.756%
- Dependent packages count: 9.576%
- Dependent repos count: 10.802%

guix: ruby-reline

GNU Readline or Editline implementation in Ruby

Homepage: https://github.com/ruby/reline
Documentation: https://git.savannah.gnu.org/cgit/guix.git/tree/gnu/packages/ruby-xyz.scm#n5293
Licenses: bsd-2, ruby
Latest release: 0.3.3 (published about 2 months ago)
Last Synced: 2026-04-27T16:17:56.260Z (4 days ago)
Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%

Dependencies

Gemfile rubygems

bundler >= 0 development
irb >= 1.3.6 development
rake >= 0 development
test-unit >= 0 development
yamatanooroti >= 0.0.9 development

reline.gemspec rubygems

io-console ~> 0.5

.github/workflows/reline.yml actions

actions/checkout v3 composite
ruby/setup-ruby v1 composite

.github/workflows/gh-pages.yml actions

actions/checkout v6.0.2 composite
actions/configure-pages v5 composite
actions/deploy-pages v4 composite
actions/upload-pages-artifact v4 composite
ruby/setup-ruby f26937343756480a8cb3ae1f623b9c8d89ed6984 composite

.github/workflows/truffle-ruby-test.yml actions

actions/checkout v6.0.2 composite
ruby/setup-ruby v1 composite

.github/workflows/push_gem.yml actions

actions/checkout 0c366fd6a839edf440554fa01a7085ccba70ac98 composite
ruby/setup-ruby 13e7a03dc3ac6c3798f4570bfead2aed4d96abfb composite
rubygems/release-gem e9a6361a0b14562539327c2a02373edc56dd3169 composite
step-security/harden-runner fa2e9d605c4eeb9fcad4c99c224cee0c6c7f3594 composite

Score: 32.830675337044504