go-prompt/README.md

# go-prompt-toolkit

![demo](./_resources/demo.gif)

Library for building powerful interactive command lines in Golang.

#### Similar Projects

* [jonathanslenders/python-prompt-toolkit](https://github.com/jonathanslenders/python-prompt-toolkit): **go-prompt-toolkit** is inspired by this library.
* [peterh/liner](https://github.com/peterh/liner): The most similar project in golang is **liner** that I've ever seen.

#### Projects using go-prompt-toolkit

* [kube-prompt : An interactive kubernetes client featuring autocomplete using prompt-toolkit.](https://github.com/c-bata/kube-prompt)

## Getting Started

```go
package main

import (
    "fmt"
    "time"

    "github.com/c-bata/go-prompt-toolkit/prompt"
)

// executor executes command and print the output.
// 1. Execute sql
// 2. Get response and print it
func executor(in string)  {
    out := "something response from db."
    fmt.Println(out)
    return
}

// completer returns the completion items from user input.
func completer(in string) []prompt.Suggest {
    return []primpt.Suggest{
        {Text: "users", Description: "user collections."},
        {Text: "articles", Description: "article is posted by users."},
        {Text: "comments", Description: "comment is inserted with each articles."},
        {Text: "groups", Description: "group is the collection of users."},
        {Text: "tags", Description: "tag contains hash tag like #prompt"},
    }
}

func main() {
    pt := prompt.NewPrompt(
        executor,
        completer,
        prompt.OptionTitle("sqlite3-prompt"),
        prompt.OptionPrefix(">>> "),
        prompt.OptionPrefixColor(prompt.Blue),
    )
    defer fmt.Println("\nGoodbye!")
    pt.Run()
}
```


## Options

![options](./_resources/prompt-options.png)

#### `OptionParser(x ConsoleParser)`
#### `OptionWriter(x ConsoleWriter)`
#### `OptionTitle(x string)`
#### `OptionPrefix(x string)`
#### `OptionPrefixTextColor(x Color)`
#### `OptionPrefixBackgroundColor(x Color)`
#### `OptionInputTextColor(x Color)`
#### `OptionInputBGColor(x Color)`
#### `OptionPreviewSuggestionTextColor(x Color)`
#### `OptionPreviewSuggestionBGColor(x Color)`
#### `OptionSuggestionTextColor(x Color)`
#### `OptionSuggestionBGColor(x Color)`
#### `OptionSelectedSuggestionTextColor(x Color)`
#### `OptionSelectedSuggestionBGColor(x Color)`
#### `OptionMaxCompletions(x uint16)`
#### `OptionDescriptionTextColor(x Color)`
#### `OptionDescriptionBGColor(x Color)`
#### `OptionSelectedDescriptionTextColor(x Color)`
#### `OptionSelectedDescriptionBGColor(x Color)`


## LICENSE

```
MIT License

Copyright (c) 2017 Masashi SHIBATA

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```