Requestty
requestty
(request-tty) is an easy-to-use collection of interactive cli prompts inspired by Inquirer.js.
-
Easy-to-use - The builder API and macros allow you to easily configure and use the in-built prompts.
-
Extensible - Easily create and use custom prompts with a companion ui rendering library.
-
Flexible - All prompts can be used standalone or chained together.
-
Dynamic - You can dynamically decide what questions should be asked based on previous questions.
-
Validation - You can validate user input with any prompt.
-
Examples - Every prompt is accompanied with an example as well as other examples for more complex workflows
Usage
Add this to your Cargo.toml
[dependencies]
requestty = "0.1.0"
let question = requestty::Question::expand("overwrite")
.message("Conflict on `file.rs`")
.choices(vec![
('y', "Overwrite"),
('a', "Overwrite this one and all next"),
('d', "Show diff"),
])
.default_separator()
.choice('x', "Abort")
.build();
println!("{:#?}", requestty::prompt_one(question));
In-built prompts
There are 10 in-built prompts:
-
Input
Prompt that takes user input and returns a
String
. -
Password
Prompt that takes user input and hides it.
-
Editor
Prompt that takes launches the users preferred editor on a temporary file
-
Confirm
Prompt that returns
true
orfalse
. -
Int
Prompt that takes a
i64
as input. -
Float
Prompt that takes a
f64
as input. -
Expand
Prompt that allows the user to select from a list of options by key
-
Select
Prompt that allows the user to select from a list of options
-
RawSelect
Prompt that allows the user to select from a list of options with indices
-
MultiSelect
Prompt that allows the user to select multiple items from a list of options
Optional features
-
macros
: Enabling this feature will allow you to use thequestions
andprompt_module
macros. -
smallvec
(default): Enabling this feature will useSmallVec
instead ofVec
for auto completions. This allows inlining single completions. -
crossterm
(default): Enabling this feature will use thecrossterm
library for terminal interactions such as drawing and receiving events. -
termion
: Enabling this feature will use thetermion
library for terminal interactions such as drawing and receiving events.
Minimum Supported Rust Version (MSRV)
Minimum supported rust version (as per cargo-msrv) is 1.47