inquire

Crates.ioinquire
lib.rsinquire
version0.7.5
sourcesrc
created_at2021-06-24 03:17:32.838351
updated_at2024-04-23 03:53:26.676368
descriptioninquire is a library for building interactive prompts on terminals
homepagehttps://github.com/mikaelmello/inquire
repositoryhttps://github.com/mikaelmello/inquire
max_upload_size
id414237
size544,454
Mikael Mello (mikaelmello)

documentation

https://docs.rs/inquire

README

Latest Version Build status Supported platforms License



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

Animated GIF making a demonstration of a questionnaire created with this library. You can replay this recording in your terminal with asciinema play command - asciinema play ../assets/expense_tracker.cast 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.7.5"

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

inquire = { version = "0.7.5", features = ["date", "editor"] }
Commit count: 724

cargo fmt