Readline is a pure go(golang) implementation for GNU-Readline kind library
Go to file
Chzyer a0bb3f70e4 Merge pull request #32 from guanqun/add-api-for-set-completion
add a new API to set auto complete
2016-02-23 13:52:35 +08:00
example update history interfaces. and support DisableAutoSaveHistory 2016-02-16 16:56:57 +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 changelog: fix syntax 2015-11-20 23:25:18 +08:00
LICENSE Initial commit 2015-09-20 23:11:30 +08:00
README.md update readme 2016-02-11 12:21:32 +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 new interface and fixed crash if stdout isn't a tty 2016-02-18 11:25:41 +08:00
complete_helper.go Add Tree() method back in. 2016-01-07 09:54:10 -06: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 add a new API to set auto complete 2016-02-23 13:15:23 +08:00
password.go add password support 2015-11-20 20:56:42 +08:00
rawreader_windows.go add comment 2015-10-09 11:13:07 +08:00
readline.go disable interactive when stdin is not a tty 2016-02-18 13:08:19 +08:00
remote.go fix typo 2016-01-31 13:54:58 +08:00
runebuf.go Fix a division by zero on terminals that report 0 width. 2016-02-18 17:25:32 -05:00
search.go #30 fixed search history crash 2016-02-21 10:14:19 +08:00
std.go add a new API to set auto complete 2016-02-23 13:15:23 +08:00
std_windows.go finish windows support 2015-09-29 23:28:12 +08:00
terminal.go fixed crash if stdin is not a tty (pipe) 2016-02-17 14:08:55 +08:00
utils.go add new interface and fixed crash if stdout isn't a tty 2016-02-18 11:25:41 +08:00
utils_test.go add runes package 2015-10-04 21:56:34 +08:00
utils_unix.go add new interface and fixed crash if stdout isn't a tty 2016-02-18 11:25:41 +08:00
utils_windows.go add new interface and fixed crash if stdout isn't a tty 2016-02-18 11:25:41 +08:00
vim.go fixes bugs 2015-10-02 10:58:43 +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

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
		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
		break
	}
	println(line)
}
  • Example with auto refresh
import (
	"log"
	"gopkg.in/readline.v1"
)

rl, err := readline.New("> ")
if err != nil {
	panic(err)
}
defer rl.Close()
log.SetOutput(l.Stderr()) // let "log" write to l.Stderr instead of os.Stderr

go func() {
	for _ = range time.Tick(time.Second) {
		log.Println("hello")
	}
}()

for {
	line, err := rl.Readline()
	if err != nil { // io.EOF
		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
		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!

Feedback

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