Readline is a pure go(golang) implementation for GNU-Readline kind library
Go to file
chzyer b1b67f8632 [runebuffer] use single line 2016-03-30 23:55:12 +08:00
example return remain line if interrupt. 2016-03-25 17:08:13 +08:00
runes add runes package 2015-10-04 21:56:34 +08:00
.gitignore update ignore 2015-10-04 22:31:32 +08:00
.travis.yml CI: fix travis 2015-11-21 11:38:21 +08:00
CHANGELOG.md update changelog 2016-03-05 15:48:58 +08:00
LICENSE Initial commit 2015-09-20 23:11:30 +08:00
README.md Added OpenCollective badge and list of backers 2016-02-26 19:52:05 -08:00
ansi_windows.go finish windows support 2015-09-29 23:28:12 +08:00
char.go add simple vim mode 2015-10-01 22:44:43 +08:00
complete.go add remote mode 2016-03-13 18:32:48 +08:00
complete_helper.go add SetChildren for prefix completer interface 2016-03-16 18:03:13 +08:00
debug.go refactor 2015-09-27 10:50:14 +08:00
doc.go add doc 2015-09-23 13:55:53 +08:00
history.go report error if it save history fail 2016-02-18 08:41:35 +08:00
operation.go return remain line if interrupt. 2016-03-25 17:08:13 +08:00
password.go refactory 2016-03-05 15:45:42 +08:00
rawreader_windows.go add comment 2015-10-09 11:13:07 +08:00
readline.go fix remote 2016-03-23 17:07:53 +08:00
remote.go Fix #39, remote can raise a EOF error now 2016-03-28 17:37:07 +08:00
runebuf.go [runebuffer] use single line 2016-03-30 23:55:12 +08:00
search.go add remote mode 2016-03-13 18:32:48 +08:00
std.go refactory 2016-03-05 15:45:42 +08:00
std_windows.go finish windows support 2015-09-29 23:28:12 +08:00
terminal.go add remote mode 2016-03-13 18:32:48 +08:00
utils.go fix wordbreak to add number 2016-03-25 17:07:55 +08:00
utils_test.go add remote mode 2016-03-13 18:32:48 +08:00
utils_unix.go add remote mode 2016-03-13 18:32:48 +08:00
utils_windows.go add remote mode 2016-03-13 18:32:48 +08:00
vim.go #22 support more vim shortcut 2016-02-24 22:35:22 +08:00
windows_api.go finish windows support 2015-09-29 23:28:12 +08:00

README.md

readline

Software License Build Status GoDoc Gitter OpenCollective

Readline is A Pure Go Implementation of a libreadline-style Library.
The goal is to be a powerful alternater for GNU-Readline.

WHY: Readline will support most of features which GNU Readline is supported, and provide a pure go environment and a MIT license.

It can also provides shell-like interactives by using flagly (demo: flagly-shell)

Demo

demo

Also works fine in windows

demo windows

Todo

  • Vi Mode is not completely finish
  • More funny examples
  • Support dumb/eterm-color terminal in emacs

Features

  • Support emacs/vi mode, almost all basic features that GNU-Readline is supported
  • zsh-style backward/forward history search
  • zsh-style completion
  • 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.

Usage

  • Import package
go get gopkg.in/readline.v1

or

go get github.com/chzyer/readline
  • Simplest example
import "gopkg.in/readline.v1"

rl, err := readline.New("> ")
if err != nil {
	panic(err)
}
defer rl.Close()

for {
	line, err := rl.Readline()
	if err != nil { // io.EOF, readline.ErrInterrupt
		break
	}
	println(line)
}
  • Example with durable history
rl, err := readline.NewEx(&readline.Config{
	Prompt: "> ",
	HistoryFile: "/tmp/readline.tmp",
})
if err != nil {
	panic(err)
}
defer rl.Close()

for {
	line, err := rl.Readline()
	if err != nil { // io.EOF, readline.ErrInterrupt
		break
	}
	println(line)
}
  • Example with auto completion
import (
	"gopkg.in/readline.v1"
)

var completer = readline.NewPrefixCompleter(
	readline.PcItem("say",
		readline.PcItem("hello"),
		readline.PcItem("bye"),
	),
	readline.PcItem("help"),
)

rl, err := readline.NewEx(&readline.Config{
	Prompt:       "> ",
	AutoComplete: completer,
})
if err != nil {
	panic(err)
}
defer rl.Close()

for {
	line, err := rl.Readline()
	if err != nil { // io.EOF, readline.ErrInterrupt
		break
	}
	println(line)
}

Shortcut

Meta+B means press Esc and n separately.
Users can change that in terminal simulator(i.e. iTerm2) to Alt+B
Notice: Meta+B is equals with Alt+B in windows.

  • Shortcut in normal mode
Shortcut Comment
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)
Ctrl+U Cut text to the beginning of line
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
Ctrl+S Search forwards in history
Ctrl+R Search backwards in history
Ctrl+C / Ctrl+G Exit Search Mode and revert the history
Backspace Delete previous character
Other Exit Search Mode
  • Shortcut in Complete Select Mode (double Tab to enter this mode)
Shortcut Comment
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

Tested with

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
Windows 10 -

Notice:

  • Ctrl+A is not working in screen because it used as a control command by default

If you test it otherwhere, whether it works fine or not, please let me know!

Who is using Readline

Feedback

If you have any questions, please submit a github issue and any pull requests is welcomed :)

Backers

Love Readline? Help me keep it alive by donating funds to cover project expenses!
[Become a backer]