https://github.com/tcnksm/go-input

Go package for ideal tty prompt
https://github.com/tcnksm/go-input

golang

Last synced: 17 days ago
JSON representation

Go package for ideal tty prompt

• Host: GitHub
• URL: https://github.com/tcnksm/go-input
• Owner: tcnksm
• License: mit
• Created: 2016-01-05T08:17:39.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-08-12T19:16:23.000Z (over 2 years ago)
• Last Synced: 2024-08-01T15:08:09.033Z (3 months ago)
• Topics: golang
• Language: Go
• Homepage: https://godoc.org/github.com/tcnksm/go-input
• Size: 1.96 MB
• Stars: 253
• Watchers: 2
• Forks: 45
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
go-input [![Go Documentation](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)][godocs] [![Travis](https://img.shields.io/travis/tcnksm/go-input.svg?style=flat-square)][travis] [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]

====

[godocs]: http://godoc.org/github.com/tcnksm/go-input

[travis]: https://travis-ci.org/tcnksm/go-input

[license]: /LICENSE

`go-input` is a Go package for reading user input in console.

Here is the some good points compared with other/similar packages. It can handle `SIGINT` (`Ctrl+C`) while reading input and returns error. It allows to change IO interface as `io.Writer` and `io.Reader` so it's easy to test of your go program with this package (This package is also well-tested!). It also supports raw mode input (reading input without prompting) for multiple platform (Darwin, Linux and Windows). Not only this it allows to prompt complex input via Option struct. 

The documentation is on [GoDoc][godocs].

## Install

Use `go get` to install this package:

```bash

$ go get github.com/tcnksm/go-input

```

## Usage

The following is the simple example,

```golang

ui := &input.UI{

    Writer: os.Stdout,

    Reader: os.Stdin,

}

query := "What is your name?"

name, err := ui.Ask(query, &input.Options{

    Default: "tcnksm",

    Required: true,

    Loop:     true,

})

```

You can check other examples in [here](/_example).

## Contribution

1. Fork ([https://github.com/tcnksm/go-input/fork](https://github.com/tcnksm/go-input/fork))

1. Create a feature branch

1. Commit your changes

1. Rebase your local changes against the master branch

1. Run test suite with the `go test ./...` command and confirm that it passes

1. Run `gofmt -s`

1. Create new Pull Request

## Author

[Taichi Nakashima](https://github.com/tcnksm)