94 lines
3.2 KiB
Markdown
94 lines
3.2 KiB
Markdown
# go-prompt
|
|
|
|
|
|
|
|
|
|
Library for building a powerful interactive prompt, inspired by [python-prompt-toolkit](https://github.com/jonathanslenders/python-prompt-toolkit).
|
|
Easy building a multi-platform binary of the command line tools because built with Golang.
|
|
|
|
|
|
|
|
(This is a GIF animation of kube-prompt.)
|
|
|
|
#### Projects using go-prompt
|
|
|
|
* [kube-prompt : An interactive kubernetes client featuring auto-complete written in Go.](https://github.com/c-bata/kube-prompt)
|
|
|
|
## Features
|
|
|
|
### Flexible options
|
|
|
|
go-prompt provides many options. All options are listed in [Developer Guide](./DEVELOPER_GUIDE.md).
|
|
|
|
|
|
|
|
### Keyboard Shortcuts
|
|
|
|
Emacs-like keyboard shortcut is available by default (it's also default shortcuts in Bash shell).
|
|
You can customize and expand these shortcuts.
|
|
|
|
|
|
|
|
KeyBinding | Description
|
|
--------------------|---------------------------------------------------------
|
|
<kbd>Ctrl + A</kbd> | Go to the beginning of the line (Home)
|
|
<kbd>Ctrl + E</kbd> | Go to the End of the line (End)
|
|
<kbd>Ctrl + P</kbd> | Previous command (Up arrow)
|
|
<kbd>Ctrl + N</kbd> | Next command (Down arrow)
|
|
<kbd>Ctrl + F</kbd> | Forward one character
|
|
<kbd>Ctrl + B</kbd> | Backward one character
|
|
<kbd>Ctrl + D</kbd> | Delete character under the cursor
|
|
<kbd>Ctrl + H</kbd> | Delete character before the cursor (Backspace)
|
|
<kbd>Ctrl + W</kbd> | Cut the Word before the cursor to the clipboard.
|
|
<kbd>Ctrl + K</kbd> | Cut the Line after the cursor to the clipboard.
|
|
<kbd>Ctrl + U</kbd> | Cut/delete the Line before the cursor to the clipboard.
|
|
|
|
|
|
### Easy to use
|
|
|
|
Usage is like this:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/c-bata/go-prompt"
|
|
)
|
|
|
|
func completer(d prompt.Document) []prompt.Suggest {
|
|
s := []prompt.Suggest{
|
|
{Text: "users", Description: "Store the username and age"},
|
|
{Text: "articles", Description: "Store the article text posted by user"},
|
|
{Text: "comments", Description: "Store the text commented to articles"},
|
|
}
|
|
return prompt.FilterHasPrefix(s, d.GetWordBeforeCursor(), true)
|
|
}
|
|
|
|
func main() {
|
|
fmt.Println("Please select table.")
|
|
t := prompt.Input("> ", completer)
|
|
fmt.Println("You selected " + t)
|
|
}
|
|
```
|
|
|
|
More practical example is available from `_example` directory and [a source code of kube-prompt](https://github.com/c-bata/kube-prompt).
|
|
|
|
|
|
## Links
|
|
|
|
* If you want to create CLI using go-prompt, you might want to look at the [Developer Guide](./DEVELOPER_GUIDE.md).
|
|
* If you want to contribute, you might want to look at the [ *Architecture of go-prompt* section in Developer Guide](./DEVELOPER_GUIDE.md).
|
|
* If you want to know internal API, you might want to look at the [GoDoc](http://godoc.org/github.com/c-bata/go-prompt).
|
|
|
|
## Author
|
|
|
|
Masashi Shibata
|
|
|
|
* Twitter: [@c\_bata\_](https://twitter.com/c_bata_/)
|
|
* Github: [@c-bata](https://github.com/c-bata/)
|
|
|
|
## LICENSE
|
|
|
|
This software is licensed under the MIT License (See [LICENSE](./LICENSE) ).
|