demand

KO | EN

gitlite — search

#hacktoberfest #typescript #go #android #machine-learning #rust #deep-learning #linux #awesome #cli #kubernetes #awesome-list #vue #openai

(★ 245)

prompt library for rust

File Explorer

Download Latest Version (.zip)

- - entire-search.toml
- config.toml
- hooks.json
- .gitignore
- settings.json
- - release-plz.yml
  - test.yml
- renovate.json
- - base16.gif
  - base16.tape
  - catppuccin.gif
  - catppuccin.tape
  - charm.gif
  - charm.tape
  - dracula.gif
  - dracula.tape
  - new.gif
  - new.tape
- - Dockerfile
- confirm.gif
- confirm.tape
- dialog.gif
- dialog.tape
- input-autocomplete.gif
- input-autocomplete.tape
- input-password.gif
- input-password.tape
- input.gif
- input.tape
- list.gif
- list.tape
- logo.svg
- multiselect.gif
- multiselect.tape
- select.gif
- select.tape
- spinner.gif
- spinner.tape
- autocomplete_basic.rs
- autocomplete_email.rs
- autocomplete_files.rs
- autocomplete_git.rs
- confirm.rs
- confirm_custom.rs
- dialog.rs
- input-password.rs
- input.rs
- list.rs
- multiselect.rs
- multiselect_huge.rs
- select.rs
- spinner-prompts.rs
- spinner.rs
- themes.rs
- validation.rs
- wizard.rs
- confirm.rs
- ctrlc.rs
- ctrlc_stub.rs
- dialog.rs
- event.rs
- height.rs
- input.rs
- lib.rs
- list.rs
- multiselect.rs
- option.rs
- select.rs
- spinner.rs
- synchronized_output.rs
- test.rs
- theme.rs
- tty.rs
- wizard.rs
- non_tty_input.rs
- resize.rs
- synchronized_output.rs
.gitignore
Cargo.toml
CHANGELOG.md
cliff.toml
greptile.json
hk.pkl
LICENSE
mise.toml
README.md
release-plz.toml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# demand

[![Crates.io](https://img.shields.io/crates/v/demand)
](https://crates.io/crates/demand)
[![docs.rs](https://img.shields.io/docsrs/demand)](https://docs.rs/demand)
[![GitHub License](https://img.shields.io/github/license/jdx/demand)](https://raw.githubusercontent.com/jdx/demand/main/LICENSE)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jdx/demand/test.yml)](https://github.com/jdx/demand/actions/workflows/test.yml)
[![GitHub issues](https://img.shields.io/github/issues/jdx/demand)](http://github.com/jdx/demand/issues)

A prompt library for Rust. Based on [huh? for Go](https://github.com/charmbracelet/huh). Maintained by [@jdx](https://github.com/jdx) and [@roele](https://github.com/roele).

## Sponsors

demand is sponsored by [entire.io](https://entire.io) and [37signals](https://37signals.com).

[View all sponsors](https://jdx.dev/sponsors.html).

## Input

* Single-line text input with variable prompt and placeholder
* Complete suggestions with `TAB`
* Auto-complete API for custom suggestions
* Validate input with a custom closure

Run example with [`cargo run --example input`](./examples/input.rs).

![Input](https://raw.githubusercontent.com/jdx/demand/main/assets/input.gif)

```rust
use demand::Input;

fn main() {
    let notempty_minlen = |s: &str| {
        if s.is_empty() {
            return Err("Name cannot be empty");
        }
        if s.len() < 8 {
            return Err("Name must be at least 8 characters");
        }
        Ok(())
    };

let t = Input::new("What's your name?")
        .description("We'll use this to personalize your experience.")
        .placeholder("Enter your name")
        .prompt("Name: ")
        .suggestions(vec![
            "Adam Grant",
            "Danielle Steel",
            "Eveline Widmer-Schlumpf",
            "Robert De Niro",
            "Ronaldo Rodrigues de Jesus",
            "Sarah Michelle Gellar",
            "Yael Naim",
            "Zack Snyder",
        ])
        .validation(notempty_minlen);
    let i = t.run().expect("error running input");
}
```

### Autocomplete

Run example with [`cargo run --example autocomplete_basic`](./examples/autocomplete_basic.rs).

![Autocomplete Input](https://raw.githubusercontent.com/jdx/demand/main/assets/input-autocomplete.gif)

### Password

Run example with [`cargo run --example input-password`](./examples/input-password.rs).

![Input](https://raw.githubusercontent.com/jdx/demand/main/assets/input-password.gif)

## List

Shows a list of options. Run example with [`cargo run --example list`](./examples/list.rs).

![List](https://raw.githubusercontent.com/jdx/demand/main/assets/list.gif)

```rust
use demand::List;

fn main() {
    let list = List::new("Toppings")
        .description("List of available toppings")
        .item("Lettuce")
        .item("Tomatoes")
        .item("Charm Sauce")
        .item("Jalapenos")
        .item("Cheese")
        .item("Vegan Cheese")
        .item("Nutella")
        .item("Peanut Butter")
        .item("Banana")
        .filterable(true);
    list.run().expect("error running list")
}
```

## Select

Select from a list of options.

Run example with [`cargo run --example select`](./examples/select.rs).

![Select](https://raw.githubusercontent.com/jdx/demand/main/assets/select.gif)

```rust
use demand::{DemandOption, Select};

fn main() {
    let ms = Select::new("Toppings")
        .description("Select your topping")
        .filterable(true)
        .option(DemandOption::new("Lettuce").description("Fresh and crispy"))
        .option(DemandOption::new("Tomatoes").description("Juicy and red"))
        .option(DemandOption::new("Charm Sauce").description("Our secret recipe"))
        .option(DemandOption::new("Jalapenos").label("Jalapeños").description("Spicy and hot"))
        .option(DemandOption::new("Cheese").description("Melted and gooey"))
        .option(DemandOption::new("Vegan Cheese").description("Melted and gooey"))
        .option(DemandOption::new("Nutella").description("Sweet and creamy"));
    ms.run().expect("error running select");
}
```

## Multiselect

Select multiple options from a list.
Run example with [`cargo run --example multiselect`](./examples/multiselect.rs).

![Multiselect](https://raw.githubusercontent.com/jdx/demand/main/assets/multiselect.gif)

```rust
use demand::{DemandOption, MultiSelect};

fn main() {
    let ms = MultiSelect::new("Toppings")
        .description("Select your toppings")
        .min(1)
        .max(4)
        .filterable(true)
        .option(DemandOption::new("Lettuce").selected(true))
        .option(DemandOption::new("Tomatoes").selected(true))
        .option(DemandOption::new("Charm Sauce"))
        .option(DemandOption::new("Jalapenos").label("Jalapeños"))
        .option(DemandOption::new("Cheese"))
        .option(DemandOption::new("Vegan Cheese"))
        .option(DemandOption::new("Nutella"));
    ms.run().expect("error running multi select");
}
```

## Confirm

Confirm a question with a yes or no.
Run example with [`cargo run --example confirm`](./examples/confirm.rs).

![Confirm](https://raw.githubusercontent.com/jdx/demand/main/assets/confirm.gif)

```rust
use demand::Confirm;

fn main() {
    let ms = Confirm::new("Are you sure?")
        .affirmative("Yes!")
        .negative("No.");
    let yes = ms.run().expect("error running confirm");
}
```

## Dialog

Show a dialog with multiple buttons.
Run example with [`cargo run --example dialog`](./examples/dialog.rs).

![Dialog](https://raw.githubusercontent.com/jdx/demand/main/assets/dialog.gif)

```rust
use demand::{Dialog, DialogButton};

fn main() {
    let ms = Dialog::new("Are you sure?")
        .description("This will do a thing.")
        .buttons(vec![
            DialogButton::new("Ok"),
            DialogButton::new("Not sure"),
            DialogButton::new("Cancel"),
        ])
        .selected_button(1);
    ms.run().expect("error running confirm");
}
```

## Spinner

Spinners are used to indicate that a process is running.
Run example with [`cargo run --example spinner`](./examples/spinner.rs).

![Spinner](https://raw.githubusercontent.com/jdx/demand/main/assets/spinner.gif)

```rust
use std::{thread::sleep, time::Duration};

use demand::{Spinner, SpinnerStyle};

fn main() {
    Spinner::new("Loading Data...")
        .style(SpinnerStyle::line())
        .run(|| {
            sleep(Duration::from_secs(2));
        })
        .expect("error running spinner");
}
```

## Themes

Supply your own custom theme or choose from one of the predefined themes:

Derive a custom theme from the default theme.

```rust
let theme = Theme {
    selected_prefix: String::from(" •"),
    selected_prefix_fg: Theme::color_rgb(2, 191, 135),
    unselected_prefix: String::from("  "),
    ..Theme::default()
};

Input::new("What's your e-mail?")
        .description("Please enter your e-mail address.")
        .placeholder("name@domain.com")
        .theme(&theme)
        .run()
        .expect("error running input")?;
```

### Base 16

![base16](https://raw.githubusercontent.com/jdx/demand/main/assets/themes/base16.gif)

### Charm

Default if colors are enabled in the console.

![charm](https://raw.githubusercontent.com/jdx/demand/main/assets/themes/charm.gif)

### Catppuccin

![catppuccin](https://raw.githubusercontent.com/jdx/demand/main/assets/themes/catppuccin.gif)

### Dracula

![dracula](https://raw.githubusercontent.com/jdx/demand/main/assets/themes/dracula.gif)

### New

Default if colors are NOT enabled in the console.

![new](https://raw.githubusercontent.com/jdx/demand/main/assets/themes/new.gif)

## "demand"

The name of this library is inspired by a great [mistranslation](https://www.bbc.com/culture/article/20150202-the-greatest-mistranslations-ever)
that soured US-French relations in 1830. In French, the verb "demander" means "to ask".

demand

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

demand

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README