surveyor

README

surveyor

A Command-Line Interface (CLI) utility for interactive terminal prompts.

Inspired by enquirer.

Disclaimer: This is still under development and not ready for production. See critical bug that defeats the whole premise of this project.

Table of Contents

• Install
  • Homebrew
  • Go
• Usage
• Contributing
• License

Install

surveyor is available for Linux, macOS, Windows, and more.

Homebrew

Coming soon...

Go

GO111MODULE="on" go get -u -v github.com/pbnj/surveyor

Usage

NAME:
   surveyor - A Command-Line Interface (CLI) utility for interactive terminal prompts

USAGE:
   main [global options] command [command options] [arguments...]

COMMANDS:
   input        Prompt user for text input
   multiline    Prompt user for multiline text input
   password     Prompt user for password input
   confirm      Prompt user for confirmation
   select       Prompt user for single-choice selection
   multiselect  Prompt user for multi-choice selection
   help, h      Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Example

Input

GH_USER=$(surveyor input --message "What is your GitHub username:")

curl https://api.github.com/users/${GH_USER}

Multiline

Password

Confirm

select

multiselect

Contributing

Any and all contributions are welcome!

For bugs, suggestions, or enhancements, please submit an issue.

Special Thanks

Thank you to authors and maintainers of:

• AlecAivazis/survey
• urfave/cli

License

MIT