fui
Add CLI & form interface to your program.
Basic example
cargo.toml
[dependencies]
fui = "2.0"
Using with clap (experimental)
= env::args().collect(); if _arg_vec.len() <= 1 { _arg_vec = Fui::from(&app).get_cli_input(); } // regular clap code let matches = app.get_matches_from(_arg_vec);">
extern crate clap; extern crate fui; use clap::{App, Arg}; use fui::Fui; use std::env; // regular clap code let app = App::new("some-app").arg( Arg::with_name("some-switch") .long("arg-long") .help("arg-help"), ); // extra fui code let mut _arg_vec: Vec<String> = env::args().collect(); if _arg_vec.len() <= 1 { _arg_vec = Fui::from(&app).get_cli_input(); } // regular clap code let matches = app.get_matches_from(_arg_vec);
Using without clap
// Example showing imagined CLI app. with two actions
#[macro_use]
extern crate clap;
extern crate fui;
use fui::{Fui, Value};
use fui::form::FormView;
use fui::fields::Text;
fn hdlr(v: Value) {
println!("user input (from fn) {:?}", v);
}
fn main() {
Fui::new(crate_name!())
.action(
"action1",
"help for action1",
FormView::new().field(Text::new("action1-data").help("help for action1 data")),
|v| {
println!("user input (from closure) {:?}", v);
},
)
.action(
"action2",
"help for action2",
FormView::new().field(Text::new("action2-data").help("help for action2 data")),
hdlr,
)
.version(crate_version!())
.about(crate_description!())
.author(crate_authors!())
.run();
}
This will make the program automatically working in 2 modes:
-
Ready for parsing CLI arguments, like here:
$ ./app_basic -h app_basic 1.0.0 xliiv <[email protected]> An Example program which has CLI & form interface (TUI) USAGE: app_basic [SUBCOMMAND] FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: action1 help for action1 action2 help for action2 help Prints this message or the help of the given subcommand(s)
-
Ready for getting user input from easy and discoverable TUI interface, like image below:
More examples
Screens
Clap support
Implemented features
- switch arguments
- positional arguments
- option arguments
- global arguments
- subcommands (single level)
To be implemented
- conflicts_with
- requires
- validators
- min/max/exact number of values for
- positional args
- options args
- groups
- conditional defaults
- custom delimeter
TODO
- find a solution for long help messages
- ctrl+enter submits (#151)
- handle unwraps
Ideas
.validator(OneOf || Regex::new("v\d+\.\d+\.\d+")).unwrap()?- support user's history?
- checkboxes: automatic toggle on char(+alt)?
- replace
views::Autocomplete&views::Multiselectwith a new implementation ofAutocomplete
2 Nov 11, 2022
4 Jan 9, 2023
13 Jun 16, 2023
23 Oct 12, 2022
39 Dec 8, 2022
4 Mar 20, 2022
5.2k Jan 5, 2023
![[Question] releases to crates.io](https://avatars.githubusercontent.com/u/23293562?v=4)
27 Oct 29, 2022
3 Apr 30, 2023
4 Oct 4, 2022
5 Mar 16, 2023
5 Sep 5, 2023
1 Dec 13, 2021
33 Nov 23, 2022
1 Feb 22, 2022
5 Jan 26, 2023
5 Jun 28, 2021