Command Line Utility for Stylish Interactive Prompts
(uses dialoguer underneath)
Get started with Enquirer, the most powerful command line utility for creating interactive CLI prompts.
enquirer is available on Linux, macOS
$ brew tap termapps/tap
$ brew install enquirer
This is recommended way for installation on macOS since updating to the new version is easy.
$ cargo install enquirer
Pre-built binary executables are available at releases page for macOS (64bit), Linux (64bit, 32bit).
Download and unarchive the binary then put the executable in $PATH.
Check roadmap for other ways
The main reason I created this tool is to use it as an stylish interactive and user-friendly prompt for bash scripting.
```bash
confirm=$(enquirer confirm -m "Do you want to continue?" -d)
if [ "$confirm" = "true" ]; then echo "Continuing ..." else echo "Thanks for using this tool. Quitting ..." exit fi ```
See prompts for more information on subcommands.
``` enquirer 0.3.0 Command Line Utility for Stylish Interactive Prompts
USAGE:
enquirer [FLAGS]
FLAGS: -h, --help Prints help information --no-color Disable colors in the prompt -V, --version Prints version information
SUBCOMMANDS:
confirm Prompt that returns true or false (as strings)
help Prints this message or the help of the given subcommand(s)
input Prompt that takes user input and returns a string
multi-select Prompt that allows the user to select multiple items from a list of options
secret Prompt that takes user input, hides it from the terminal, and returns a string
select Prompt that allows the user to select from a list of options
sort Prompt that allows the user to sort items in a list
```
If you want the dialoguer theme used in this tool you can add this package to your Cargo.toml
```rust use dialoguer::Confirmation; use enquirer::ColoredTheme;
fn main() { let prompt = Confirmation::withtheme(&ColoredTheme::default()) .withtext("Do you want to continue?") .with_default(true);
if prompt.interact()? {
println!("Looks like you want to continue");
} else {
println!("nevermind then :(");
}
} ```
Prompt that returns true or false (as strings)
``
enquirer-confirm 0.3.0
Prompt that returnstrueorfalse` (as strings)
USAGE:
enquirer confirm [FLAGS] [OPTIONS] --message
FLAGS:
-d, --default Default value for the prompt is true
-h, --help Prints help information
OPTIONS:
-m, --message
Prompt that takes user input and returns a string
``` enquirer-input 0.3.0 Prompt that takes user input and returns a string
USAGE:
enquirer input [FLAGS] [OPTIONS] --message
FLAGS:
-a, --allow-empty Allow empty input. Conflicts with default
-h, --help Prints help information
OPTIONS:
-d, --default
Prompt that takes user input, hides it from the terminal, and returns a string
``` enquirer-secret 0.3.0 Prompt that takes user input, hides it from the terminal, and returns a string
USAGE:
enquirer secret [FLAGS] [OPTIONS] --message
FLAGS: -a, --allow-empty Allow empty secret -h, --help Prints help information
OPTIONS:
-c, --confirm
Prompt that allows the user to select from a list of options
``` enquirer-select 0.3.0 Prompt that allows the user to select from a list of options
USAGE:
enquirer select [FLAGS] [OPTIONS] --message
FLAGS: -h, --help Prints help information -p, --paged Enables paging. Uses your terminal size
OPTIONS:
-m, --message
ARGS:
Prompt that allows the user to select multiple items from a list of options
``` enquirer-multi-select 0.3.0 Prompt that allows the user to select multiple items from a list of options
USAGE:
enquirer multi-select [FLAGS] [OPTIONS] --message
FLAGS: -h, --help Prints help information --no-inline Do not print the selected items on the prompt line -p, --paged Enables paging. Uses your terminal size
OPTIONS:
-m, --message
ARGS:
Prompt that allows the user to sort items in a list
``` enquirer-sort 0.3.0 Prompt that allows the user to sort items in a list
USAGE:
enquirer sort [FLAGS] --message
FLAGS: -h, --help Prints help information --no-inline Do not print the sorted items on the prompt line -p, --paged Enables paging. Uses your terminal size
OPTIONS:
-m, --message
ARGS:
Please see CHANGELOG.md.
MIT/X11
Report here.
Pavan Kumar Sunkara (pavan.sss1991@gmail.com)