promkit
A toolkit for building your own interactive command-line tools in Rust, utilizing crossterm.
Getting Started
Put the package in your Cargo.toml.
[dependencies]
promkit = "0.1.0"
Features
- Readline
- Provide the lines to receive and display user inputs
- Masking, switch insert/overwrite modes, and suggestions
- Select
- Provides the selectbox to choose the items from
- Customization
- Enable to define your own command-line applications.
- See examples/advanced for more concrete examples.
Examples
Readline:
use promkit::{build::Builder, readline, Result};
fn main() -> Result<()> {
let mut p = readline::Builder::default().build()?;
loop {
let (line, exit_code) = p.run()?;
if exit_code == 0 {
println!("result: {:?}", line);
} else {
return Ok(());
}
}
}
Select:
use crossterm::style;
use promkit::{
build::Builder,
edit::{Register, SelectBox},
select, Result,
};
fn main() -> Result<()> {
let mut selectbox = Box::new(SelectBox::default());
selectbox.register_all((0..100).map(|v| v.to_string()).collect::<Vec<String>>());
let mut p = select::Builder::default()
.title("Q: What number do you like?")
.title_color(style::Color::DarkGreen)
.selectbox(selectbox)
.build()?;
let (line, exit_code) = p.run()?;
if exit_code == 0 {
println!("result: {:?}", line)
}
Ok(())
}
1 Jan 30, 2022
7 Nov 28, 2022
5 Jan 22, 2023
2 Nov 27, 2022
2 Nov 27, 2022
5 Mar 31, 2023
10.7k Jan 2, 2023
3 Dec 17, 2023
12.2k Dec 30, 2022
9 Dec 7, 2022
9 Sep 28, 2022
3 Jul 1, 2022
426 Dec 26, 2022
9.1k Dec 31, 2022
5 Aug 20, 2022
3 May 30, 2022
2 Jan 8, 2022