#cli #ask #prompt #question #interactive

inquire

inquire is a library for building interactive prompts on terminals

23 unstable releases (6 breaking)

0.6.0 Mar 3, 2023
0.5.2 Nov 1, 2022
0.3.0-alpha.2 Feb 26, 2022
0.2.1 Oct 2, 2021
0.0.6 Jul 26, 2021

#16 in Command-line interface

Download history 3053/week @ 2022-12-03 3710/week @ 2022-12-10 3797/week @ 2022-12-17 1767/week @ 2022-12-24 3695/week @ 2022-12-31 4885/week @ 2023-01-07 4458/week @ 2023-01-14 5645/week @ 2023-01-21 5966/week @ 2023-01-28 11706/week @ 2023-02-04 13512/week @ 2023-02-11 9517/week @ 2023-02-18 9443/week @ 2023-02-25 9550/week @ 2023-03-04 21556/week @ 2023-03-11 19493/week @ 2023-03-18

61,757 downloads per month
Used in 107 crates (95 directly)

MIT license

320KB
5.5K SLoC

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;
  • Standardized error handling (thanks to thiserror);
  • 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.6.0"

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

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

Dependencies

~2–7.5MB
~137K SLoC