inquire-clack

inquire is a library for building interactive prompts on terminals.

It provides several different prompts in order to interactively ask the user for information via the CLI. With inquire, you can use:

• Text to get text input from the user, with built-in autocompletion support;
• Editor* to get longer text inputs by opening a text editor for the user;
• DateSelect* to get a date input from the user, selected via an interactive calendar;
• Select to ask the user to select one option from a given list;
• MultiSelect to ask the user to select an arbitrary number of options from a given list;
• Confirm for simple yes/no confirmation prompts;
• CustomType for text prompts that you would like to parse to a custom type, such as numbers or UUIDs;
• Password for secretive text prompts.

Demo

Source

Features

• Cross-platform, supporting UNIX and Windows terminals (thanks to crossterm);
• Several kinds of prompts to suit your needs;
• Support for fine-grained configuration for each prompt type, allowing you to customize:
  • Default values;
  • Input validators and formatters;
  • Help messages;
  • Autocompletion for Text prompts;
  • Custom list filters for Select and MultiSelect prompts;
  • Custom parsers for Confirm and CustomType prompts;
  • Custom extensions for files created by Editor prompts;
  • and many others!

Usage

Put this line in your Cargo.toml, under [dependencies].

inquire = "0.9.1"

* This prompt type is gated under a feature flag, e.g.:

inquire = { version = "0.9.1", features = ["date", "editor"] }

Derive Macros

For enum types, you can use the Selectable derive macro from the inquire-derive crate to automatically generate Select and MultiSelect prompts:

Add this to your Cargo.toml:

inquire = "0.9.1"
inquire-derive = "0.9.0"

#[derive(Debug, Copy, Clone, Selectable)]
enum Color {
    Red,
    Green,
    Blue,
}

fn main() -> InquireResult<()> {
    let color = Color::select("Choose a color:").prompt()?;
    Ok(())
}