周玉环 d906a41c2e first commit преди 2 дни
..
internal d906a41c2e first commit преди 2 дни
.gitignore d906a41c2e first commit преди 2 дни
CHANGELOG.md d906a41c2e first commit преди 2 дни
LICENSE d906a41c2e first commit преди 2 дни
Makefile d906a41c2e first commit преди 2 дни
README.md d906a41c2e first commit преди 2 дни
buffer.go d906a41c2e first commit преди 2 дни
completion.go d906a41c2e first commit преди 2 дни
document.go d906a41c2e first commit преди 2 дни
emacs.go d906a41c2e first commit преди 2 дни
filter.go d906a41c2e first commit преди 2 дни
history.go d906a41c2e first commit преди 2 дни
input.go d906a41c2e first commit преди 2 дни
input_posix.go d906a41c2e first commit преди 2 дни
input_windows.go d906a41c2e first commit преди 2 дни
key.go d906a41c2e first commit преди 2 дни
key_bind.go d906a41c2e first commit преди 2 дни
key_bind_func.go d906a41c2e first commit преди 2 дни
key_string.go d906a41c2e first commit преди 2 дни
option.go d906a41c2e first commit преди 2 дни
output.go d906a41c2e first commit преди 2 дни
output_posix.go d906a41c2e first commit преди 2 дни
output_vt100.go d906a41c2e first commit преди 2 дни
output_windows.go d906a41c2e first commit преди 2 дни
prompt.go d906a41c2e first commit преди 2 дни
render.go d906a41c2e first commit преди 2 дни
shortcut.go d906a41c2e first commit преди 2 дни
signal_posix.go d906a41c2e first commit преди 2 дни
signal_windows.go d906a41c2e first commit преди 2 дни

README.md

go-prompt

Go Report Card Software License GoDoc Build Status

A library for building powerful interactive prompts inspired by python-prompt-toolkit, making it easier to build cross-platform command line tools using 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

Features

Powerful auto-completion

demo

(This is a GIF animation of kube-prompt.)

Flexible options

go-prompt provides many options. Please check option section of GoDoc for more details.

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

Author

Masashi Shibata

License

This software is licensed under the MIT license, see LICENSE for more information.