README
¶
readline
Golang imitation of library readline for command line operations, including line-editing shortcut keys and auto-completion.
Support multi-byte encoding.
Usage
Implementation
Completable elements may include commands, arguments, file names and other entities, depending on the specific interpreter and its configuration.
TODO
feature
-
add self-defined auto-complete interface.
-
add auto-complete interface for list files and directories.
-
use completer
-
multi-line input strings, single-line input strings that are long enough to wrap,
-
[o] separate it to a library
-
can not auto-complete multi sub-commands as options, like
git add --a --b a.c, here, '--a', '--b' and 'a.c(fs-completer)' are sub-commands. -
Make pretty output formate of candidates
-
Add test case
bug
- can not auto-complete 'ls //usr/l'
- fs-completer: when tab enter and complete to 'ls /usr/ ', there is an extra space after '/', which make user to delete this space and then enter space to auto-complete for the next path node.
Documentation
¶
Index ¶
- Constants
- func InputLoop(inst *Instance)
- func ReadPassword(fd int) ([]byte, error)
- type Completer
- type ExecuteFunc
- type Instance
- func (inst *Instance) Destroy()
- func (inst *Instance) Error(v ...interface{})
- func (inst *Instance) Errorf(format string, v ...interface{})
- func (inst *Instance) Log(format string, v ...interface{})
- func (inst *Instance) Print(v ...interface{})
- func (inst *Instance) PrintTree(w io.Writer)
- func (inst *Instance) Printf(format string, v ...interface{})
- func (inst *Instance) Println(v ...interface{})
- func (inst *Instance) SetCompleter(subs ...Completer)
- func (inst *Instance) SetExecute(f ExecuteFunc, data interface{})
- type State
Constants ¶
const ( CharInterrupt = 3 // Ctrl+C CharEOF = 4 // Ctrl+D CharTab = '\t' // 9 CharEnter = '\r' // 13 or 10('\n') CharESC = 27 // ansi escape code CharBackspace = 127 )
Variables ¶
This section is empty.
Functions ¶
func ReadPassword ¶
ReadPassword reads a line of input from a terminal without local echo. This is commonly used for inputting passwords and other sensitive data. The slice returned does not include the \n.
Types ¶
type ExecuteFunc ¶
type Instance ¶
type Instance struct {
Debug bool
// contains filtered or unexported fields
}
func (*Instance) SetCompleter ¶
func (*Instance) SetExecute ¶
func (inst *Instance) SetExecute(f ExecuteFunc, data interface{})
Source Files
Directories