# go-prompt
[](https://goreportcard.com/report/github.com/c-bata/go-prompt)
[](#backers) [](#sponsors)
[](https://godoc.org/github.com/c-bata/go-prompt)
A library for building powerful interactive prompts inspired by [python-prompt-toolkit](https://github.com/jonathanslenders/python-prompt-toolkit),
making it easier to build cross-platform command line tools using Go.
```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)
}
```
#### Projects using go-prompt
* [c-bata/kube-prompt : An interactive kubernetes client featuring auto-complete written in Go.](https://github.com/c-bata/kube-prompt)
* [rancher/cli : The Rancher Command Line Interface (CLI)is a unified tool to manage your Rancher server](https://github.com/rancher/cli)
* [kubicorn/kubicorn : Simple, cloud native infrastructure for Kubernetes.](https://github.com/kubicorn/kubicorn)
* [cch123/asm-cli : Interactive shell of assembly language(X86/X64) based on unicorn and rasm2](https://github.com/cch123/asm-cli)
* [ktr0731/evans : more expressive universal gRPC client](https://github.com/ktr0731/evans)
* [CrushedPixel/moshpit: A Command-line tool for datamoshing.](https://github.com/CrushedPixel/moshpit)
* (If you create a CLI utility using go-prompt and want your own project to be listed here, please submit a GitHub issue.)
## Features
### Powerful auto-completion
[](https://github.com/c-bata/kube-prompt)
(This is a GIF animation of kube-prompt.)
### Flexible options
go-prompt provides many options. Please check [option section of GoDoc](https://godoc.org/github.com/c-bata/go-prompt#Option) for more details.
[](#flexible-options)
### Keyboard Shortcuts
Emacs-like keyboard shortcuts are available by default (these also are the default shortcuts in Bash shell).
You can customize and expand these shortcuts.
[](#keyboard-shortcuts)
Key Binding | Description
---------------------|---------------------------------------------------------
Ctrl + A | Go to the beginning of the line (Home)
Ctrl + E | Go to the end of the line (End)
Ctrl + P | Previous command (Up arrow)
Ctrl + N | Next command (Down arrow)
Ctrl + F | Forward one character
Ctrl + B | Backward one character
Ctrl + D | Delete character under the cursor
Ctrl + H | Delete character before the cursor (Backspace)
Ctrl + W | Cut the word before the cursor to the clipboard
Ctrl + K | Cut the line after the cursor to the clipboard
Ctrl + U | Cut the line before the cursor to the clipboard
Ctrl + L | Clear the screen
### History
You can use Up arrow and Down arrow to walk through the history of commands executed.
[](#history)
### Multiple platform support
We have confirmed go-prompt works fine in the following terminals:
* iTerm2 (macOS)
* Terminal.app (macOS)
* Command Prompt (Windows)
* gnome-terminal (Ubuntu)
## Links
* [Change Log](./CHANGELOG.md)
* [GoDoc](http://godoc.org/github.com/c-bata/go-prompt)
* [gocover.io](https://gocover.io/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/)
## Supporting go-prompt
### Contributors
This project exists thanks to all the people who contribute.
### Backers and Sponsors (OpenCollective)
Started getting support via opencollective. If you support this project by becoming a sponsor, your logo will show up here with a link to your website.
[](https://opencollective.com/go-prompt#backers)
## License
This software is licensed under the MIT license, see [LICENSE](./LICENSE) for more information.