File: README.md

package info (click to toggle)
golang-github-bowery-prompt 0.0~git20160808.0.d43c270-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 128 kB
  • ctags: 186
  • sloc: makefile: 2
file content (37 lines) | stat: -rw-r--r-- 1,494 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Prompt

[![Circle CI](https://circleci.com/gh/Bowery/prompt/tree/master.png?style=badge)](https://circleci.com/gh/Bowery/prompt/tree/master)

[![GoDoc](https://godoc.org/github.com/Bowery/prompt?status.png)](https://godoc.org/github.com/Bowery/prompt)

Prompt is a cross platform line-editing prompting library. Read the GoDoc page
for more info and for API details.

## Features
- Keyboard shortcuts in prompts
- History support
- Secure password prompt
- Custom prompt support
- Fallback prompt for unsupported terminals
- ANSI conversion for Windows

## Todo
- Multi-line prompt as a Terminal option
- Make refresh less jittery on Windows([possible reason](https://github.com/Bowery/prompt/blob/master/output_windows.go#L108))
- Add support for BSD systems
- Multi-byte character support on Windows
- `AnsiWriter` should execute the equivalent ANSI escape code functionality on Windows
- Support for more ANSI escape codes on Windows.
- More keyboard shortcuts from Readlines shortcut list

## Contributing

Make sure Go is setup and running the latest release version, and make sure your `GOPATH` is setup properly.

Follow the guidelines [here](https://guides.github.com/activities/contributing-to-open-source/#contributing).

Please be sure to `gofmt` any code before doing commits. You can simply run `gofmt -w .` to format all the code in the directory.

## License

Prompt is MIT licensed, details can be found [here](https://raw.githubusercontent.com/Bowery/prompt/master/LICENSE).