vendor/github.com/c-bata/go-prompt/README.md - cloudstack-cloudmonkey - Git at Google

 # go-prompt

 [![Go Report Card](https://goreportcard.com/badge/github.com/c-bata/go-prompt)](https://goreportcard.com/report/github.com/c-bata/go-prompt)
 ![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)
 [![Backers on Open Collective](https://opencollective.com/go-prompt/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/go-prompt/sponsors/badge.svg)](#sponsors)
 [![GoDoc](https://godoc.org/github.com/c-bata/go-prompt?status.svg)](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

 [![demo](https://github.com/c-bata/assets/raw/master/go-prompt/kube-prompt.gif)](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.

 [![options](https://github.com/c-bata/assets/raw/master/go-prompt/prompt-options.png)](#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](https://github.com/c-bata/assets/raw/master/go-prompt/keyboard-shortcuts.gif)](#keyboard-shortcuts)

 Key Binding          | 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 the line before the cursor to the clipboard
 <kbd>Ctrl + L</kbd>  | Clear the screen

 ### History

 You can use <kbd>Up arrow</kbd> and <kbd>Down arrow</kbd> to walk through the history of commands executed.

 [![History](https://github.com/c-bata/assets/raw/master/go-prompt/history.gif)](#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.

 <a href="graphs/contributors"><img src="https://opencollective.com/go-prompt/contributors.svg?width=890&button=false" /></a>

 ### 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.

 [![Become a backer](https://opencollective.com/go-prompt/tiers/backer.svg?avatarHeight=64)](https://opencollective.com/go-prompt#backers)
 <a href="https://opencollective.com/go-prompt/sponsor/0/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/0/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/1/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/1/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/2/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/2/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/3/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/3/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/4/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/4/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/5/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/5/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/6/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/6/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/7/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/7/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/8/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/8/avatar.svg"></a>
 <a href="https://opencollective.com/go-prompt/sponsor/9/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/9/avatar.svg"></a>

 ## License

 This software is licensed under the MIT license, see [LICENSE](./LICENSE) for more information.
	# go-prompt

	[![Go Report Card](https://goreportcard.com/badge/github.com/c-bata/go-prompt)](https://goreportcard.com/report/github.com/c-bata/go-prompt)
	![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)
	[![Backers on Open Collective](https://opencollective.com/go-prompt/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/go-prompt/sponsors/badge.svg)](#sponsors)
	[![GoDoc](https://godoc.org/github.com/c-bata/go-prompt?status.svg)](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

	[![demo](https://github.com/c-bata/assets/raw/master/go-prompt/kube-prompt.gif)](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.

	[![options](https://github.com/c-bata/assets/raw/master/go-prompt/prompt-options.png)](#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](https://github.com/c-bata/assets/raw/master/go-prompt/keyboard-shortcuts.gif)](#keyboard-shortcuts)

	Key Binding \| 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 the line before the cursor to the clipboard
	<kbd>Ctrl + L</kbd> \| Clear the screen

	### History

	You can use <kbd>Up arrow</kbd> and <kbd>Down arrow</kbd> to walk through the history of commands executed.

	[![History](https://github.com/c-bata/assets/raw/master/go-prompt/history.gif)](#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.

	<a href="graphs/contributors"><img src="https://opencollective.com/go-prompt/contributors.svg?width=890&button=false" /></a>

	### 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.

	[![Become a backer](https://opencollective.com/go-prompt/tiers/backer.svg?avatarHeight=64)](https://opencollective.com/go-prompt#backers)
	<a href="https://opencollective.com/go-prompt/sponsor/0/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/0/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/1/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/1/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/2/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/2/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/3/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/3/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/4/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/4/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/5/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/5/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/6/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/6/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/7/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/7/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/8/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/8/avatar.svg"></a>
	<a href="https://opencollective.com/go-prompt/sponsor/9/website" target="_blank"><img src="https://opencollective.com/go-prompt/sponsor/9/avatar.svg"></a>

	## License

	This software is licensed under the MIT license, see [LICENSE](./LICENSE) for more information.