2015-09-20 18:11:30 +03:00
# readline
2015-09-20 18:16:46 +03:00
2015-09-23 08:09:26 +03:00
[](LICENSE.md)
2015-09-23 08:12:20 +03:00
[](https://travis-ci.org/chzyer/readline)
2016-02-11 07:21:32 +03:00
[](https://godoc.org/github.com/chzyer/readline)
2016-02-27 06:52:05 +03:00
[](https://gitter.im/chzyer/readline?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
2016-05-03 20:20:02 +03:00
[](#backers)
[](#sponsors)
2015-09-23 08:09:26 +03:00
2015-09-25 08:06:36 +03:00
Readline is A Pure Go Implementation of a libreadline-style Library.
The goal is to be a powerful alternater for GNU-Readline.
2015-09-23 08:43:48 +03:00
**WHY:**
Readline will support most of features which GNU Readline is supported, and provide a pure go environment and a MIT license.
2015-09-23 08:03:18 +03:00
2016-02-11 07:21:32 +03:00
It can also provides shell-like interactives by using [flagly ](https://github.com/chzyer/flagly ) (demo: [flagly-shell ](https://github.com/chzyer/flagly/blob/master/demo/flagly-shell/flagly-shell.go ))
2015-09-23 08:09:26 +03:00
# Demo
2015-10-09 06:26:59 +03:00
2015-09-23 08:09:26 +03:00
2015-09-29 18:57:14 +03:00
Also works fine in windows
2015-10-09 06:26:59 +03:00
2015-09-29 18:57:14 +03:00
2015-11-21 06:36:20 +03:00
* [example/readline-demo ](https://github.com/chzyer/readline/blob/master/example/readline-demo/readline-demo.go ) The source code about the demo above
2016-03-31 05:55:53 +03:00
* [example/readline-im ](https://github.com/chzyer/readline/blob/master/example/readline-im/readline-im.go ) Example for how to write a IM program.
* [example/readline-multiline ](https://github.com/chzyer/readline/blob/master/example/readline-multiline/readline-multiline.go ) Example for how to parse command which can submit by multiple time.
2015-11-21 06:36:20 +03:00
* [example/readline-pass-strength ](https://github.com/chzyer/readline/blob/master/example/readline-pass-strength/readline-pass-strength.go ) A example about checking password strength, written by [@sahib ](https://github.com/sahib )
2015-09-23 08:26:42 +03:00
2015-09-25 07:59:36 +03:00
# Todo
2015-10-02 07:46:27 +03:00
* Vi Mode is not completely finish
2015-09-25 07:59:36 +03:00
* More funny examples
2015-09-30 11:13:36 +03:00
* Support dumb/eterm-color terminal in emacs
2015-09-25 07:59:36 +03:00
2015-10-02 05:37:21 +03:00
# Features
2015-10-02 05:58:43 +03:00
* Support emacs/vi mode, almost all basic features that GNU-Readline is supported
2015-10-02 05:37:21 +03:00
* zsh-style backward/forward history search
* zsh-style completion
2015-10-02 06:01:54 +03:00
* Readline auto refresh when others write to Stdout while editing (it needs specify the Stdout/Stderr provided by *readline.Instance to others).
* Support colourful prompt in all platforms.
2015-10-02 05:37:21 +03:00
2015-09-23 08:43:48 +03:00
# Usage
2015-09-23 08:35:48 +03:00
2015-10-16 04:01:31 +03:00
* Import package
```
go get gopkg.in/readline.v1
```
or
```
2015-10-16 04:02:55 +03:00
go get github.com/chzyer/readline
2015-10-16 04:01:31 +03:00
```
2015-09-23 08:32:43 +03:00
* Simplest example
2015-09-23 08:35:48 +03:00
2015-09-23 08:26:42 +03:00
```go
2015-10-16 04:01:31 +03:00
import "gopkg.in/readline.v1"
2015-09-23 08:26:42 +03:00
rl, err := readline.New("> ")
if err != nil {
panic(err)
}
defer rl.Close()
for {
line, err := rl.Readline()
2016-02-24 17:52:02 +03:00
if err != nil { // io.EOF, readline.ErrInterrupt
2015-09-23 08:26:42 +03:00
break
}
println(line)
}
```
2015-09-23 08:32:43 +03:00
* Example with durable history
2015-09-23 08:35:48 +03:00
2015-09-23 08:32:43 +03:00
```go
rl, err := readline.NewEx(& readline.Config{
Prompt: "> ",
HistoryFile: "/tmp/readline.tmp",
})
if err != nil {
panic(err)
}
defer rl.Close()
for {
line, err := rl.Readline()
2016-02-24 17:52:02 +03:00
if err != nil { // io.EOF, readline.ErrInterrupt
2015-09-23 08:32:43 +03:00
break
}
println(line)
}
```
2015-09-25 20:06:47 +03:00
* Example with auto completion
```go
import (
2015-10-16 04:01:31 +03:00
"gopkg.in/readline.v1"
2015-09-25 20:06:47 +03:00
)
var completer = readline.NewPrefixCompleter(
readline.PcItem("say",
readline.PcItem("hello"),
readline.PcItem("bye"),
),
readline.PcItem("help"),
)
2015-10-27 23:26:58 +03:00
rl, err := readline.NewEx(& readline.Config{
2015-09-25 20:06:47 +03:00
Prompt: "> ",
AutoComplete: completer,
})
if err != nil {
panic(err)
}
defer rl.Close()
for {
line, err := rl.Readline()
2016-02-24 17:52:02 +03:00
if err != nil { // io.EOF, readline.ErrInterrupt
2015-09-25 20:06:47 +03:00
break
}
println(line)
}
```
2015-09-23 08:32:43 +03:00
2015-09-23 08:09:26 +03:00
# Shortcut
2015-09-23 08:03:18 +03:00
2015-09-23 08:19:53 +03:00
`Meta` +`B` means press `Esc` and `n` separately.
2015-10-01 17:44:43 +03:00
Users can change that in terminal simulator(i.e. iTerm2) to `Alt` +`B`
2015-09-30 11:13:36 +03:00
Notice: `Meta` +`B` is equals with `Alt` +`B` in windows.
2015-09-23 08:03:18 +03:00
2015-09-26 19:32:04 +03:00
* Shortcut in normal mode
| Shortcut | Comment |
2015-09-26 19:33:32 +03:00
|--------------------|------------------------------------------|
2015-09-26 19:32:04 +03:00
| `Ctrl` +`A` | Beginning of line |
| `Ctrl` +`B` / `←` | Backward one character |
| `Meta` +`B` | Backward one word |
| `Ctrl` +`C` | Send io.EOF |
| `Ctrl` +`D` | Delete one character |
| `Meta` +`D` | Delete one word |
| `Ctrl` +`E` | End of line |
| `Ctrl` +`F` / `→` | Forward one character |
| `Meta` +`F` | Forward one word |
| `Ctrl` +`G` | Cancel |
| `Ctrl` +`H` | Delete previous character |
| `Ctrl` +`I` / `Tab` | Command line completion |
| `Ctrl` +`J` | Line feed |
| `Ctrl` +`K` | Cut text to the end of line |
| `Ctrl` +`L` | Clean screen (TODO) |
| `Ctrl` +`M` | Same as Enter key |
| `Ctrl` +`N` / `↓` | Next line (in history) |
| `Ctrl` +`P` / `↑` | Prev line (in history) |
| `Ctrl` +`R` | Search backwards in history |
| `Ctrl` +`S` | Search forwards in history |
| `Ctrl` +`T` | Transpose characters |
| `Meta` +`T` | Transpose words (TODO) |
2015-09-28 06:13:39 +03:00
| `Ctrl` +`U` | Cut text to the beginning of line |
2015-09-26 19:32:04 +03:00
| `Ctrl` +`W` | Cut previous word |
| `Backspace` | Delete previous character |
| `Meta` +`Backspace` | Cut previous word |
| `Enter` | Line feed |
* Shortcut in Search Mode (`Ctrl`+`S` or `Ctrl` +`r` to enter this mode)
| Shortcut | Comment |
2015-09-26 19:33:32 +03:00
|-------------------------|---------------------------------------------|
2015-09-26 19:32:04 +03:00
| `Ctrl` +`S` | Search forwards in history |
| `Ctrl` +`R` | Search backwards in history |
| `Ctrl` +`C` / `Ctrl` +`G` | Exit Search Mode and revert the history |
2015-09-26 19:36:35 +03:00
| `Backspace` | Delete previous character |
2015-09-26 19:32:04 +03:00
| Other | Exit Search Mode |
* Shortcut in Complete Select Mode (double `Tab` to enter this mode)
| Shortcut | Comment |
2015-09-26 19:33:32 +03:00
|-------------------------|---------------------------------------------|
2015-09-26 19:32:04 +03:00
| `Ctrl` +`F` | Move Forward |
| `Ctrl` +`B` | Move Backward |
| `Ctrl` +`N` | Move to next line |
| `Ctrl` +`P` | Move to previous line |
| `Ctrl` +`A` | Move to the first candicate in current line |
| `Ctrl` +`E` | Move to the last candicate in current line |
| `Tab` / `Enter` | Use the word on cursor to complete |
| `Ctrl` +`C` / `Ctrl` +`G` | Exit Complete Select Mode |
| Other | Exit Complete Select Mode |
2015-09-23 08:43:48 +03:00
2015-09-27 04:05:04 +03:00
# Tested with
2015-09-27 05:12:15 +03:00
| Environment | $TERM |
|-------------------------------|--------|
| Mac OS X iTerm2 | xterm |
| Mac OS X default Terminal.app | xterm |
| Mac OS X iTerm2 Screen | screen |
| Mac OS X iTerm2 Tmux | screen |
| Ubuntu Server 14.04 LTS | linux |
| Centos 7 | linux |
2015-09-29 18:35:11 +03:00
| Windows 10 | - |
2015-09-27 05:12:15 +03:00
### Notice:
2015-09-30 11:13:36 +03:00
* `Ctrl` +`A` is not working in `screen` because it used as a control command by default
2015-09-27 04:05:04 +03:00
If you test it otherwhere, whether it works fine or not, please let me know!
2016-02-24 17:52:02 +03:00
## Who is using Readline
* [cockroachdb/cockroach ](https://github.com/cockroachdb/cockroach )
* [youtube/doorman ](https://github.com/youtube/doorman )
* [bom-d-van/harp ](https://github.com/bom-d-van/harp )
* [abiosoft/ishell ](https://github.com/abiosoft/ishell )
* [robertkrimen/otto ](https://github.com/robertkrimen/otto )
2016-04-18 06:38:46 +03:00
* [Netflix/hal-9001 ](https://github.com/Netflix/hal-9001 )
2016-02-24 17:52:02 +03:00
2015-09-23 08:43:48 +03:00
# Feedback
2015-09-30 11:13:36 +03:00
If you have any questions, please submit a github issue and any pull requests is welcomed :)
2015-11-08 09:23:29 +03:00
* [https://twitter.com/chzyer ](https://twitter.com/chzyer )
* [http://weibo.com/2145262190 ](http://weibo.com/2145262190 )
2016-02-27 06:52:05 +03:00
# Backers
Love Readline? Help me keep it alive by donating funds to cover project expenses!< br / >
2016-05-03 20:20:02 +03:00
[[Become a backer ](https://opencollective.com/readline#backer )]
< a href = "https://opencollective.com/readline/backer/0/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/1/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/2/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/3/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/4/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/5/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/6/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/7/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/8/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/9/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/10/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/11/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/12/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/13/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/14/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/15/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/16/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/17/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/18/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/19/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/20/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/21/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/22/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/23/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/24/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/25/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/26/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/27/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/28/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/backer/29/website" target = "_blank" > < img src = "https://opencollective.com/readline/backer/29/avatar.svg" > < / a >
# Sponsors
Become a sponsor and get your logo here on our Github page. [[Become a sponsor ](https://opencollective.com/readline#sponsor )]
< a href = "https://opencollective.com/readline/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/11/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/12/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/13/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/14/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/15/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/16/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/17/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/18/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/19/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/20/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/21/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/22/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/23/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/24/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/25/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/26/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/27/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/28/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/readline/sponsor/29/website" target = "_blank" > < img src = "https://opencollective.com/readline/sponsor/29/avatar.svg" > < / a >
2016-02-27 06:52:05 +03:00
