• Stars
    star
    218
  • Rank 181,805 (Top 4 %)
  • Language
    Go
  • License
    MIT License
  • Created about 10 years ago
  • Updated about 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Cross platform prompting library

Prompt

Circle CI

GoDoc

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)
  • 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.

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

Lastly don't forget to add your name to CONTRIBUTORS.md

License

Prompt is MIT licensed, details can be found here.