Skip to content
Snippets Groups Projects
Commit 9f15159b authored by Moul's avatar Moul Committed by Éloïs
Browse files

[ref] core: improve command line interface

parent 12aea3cb
No related branches found
No related tags found
1 merge request!121CLI improvements
...@@ -37,25 +37,25 @@ pub enum DbExSubCommand { ...@@ -37,25 +37,25 @@ pub enum DbExSubCommand {
name = "distance", name = "distance",
raw(setting = "structopt::clap::AppSettings::ColoredHelp") raw(setting = "structopt::clap::AppSettings::ColoredHelp")
)] )]
/// durs databases explorer (distances datas) /// Web of Trust distances explorer
DistanceOpt(DistanceOpt), DistanceOpt(DistanceOpt),
#[structopt( #[structopt(
name = "members", name = "members",
raw(setting = "structopt::clap::AppSettings::ColoredHelp") raw(setting = "structopt::clap::AppSettings::ColoredHelp")
)] )]
/// durs databases explorer (members datas) /// Members explorer
MembersOpt(MembersOpt), MembersOpt(MembersOpt),
#[structopt( #[structopt(
name = "member", name = "member",
raw(setting = "structopt::clap::AppSettings::ColoredHelp") raw(setting = "structopt::clap::AppSettings::ColoredHelp")
)] )]
/// durs databases explorer (member datas) /// Member explorer
MemberOpt(MemberOpt), MemberOpt(MemberOpt),
#[structopt( #[structopt(
name = "balance", name = "balance",
raw(setting = "structopt::clap::AppSettings::ColoredHelp") raw(setting = "structopt::clap::AppSettings::ColoredHelp")
)] )]
/// durs databases explorer (balances datas) /// Pubkeys’ balances explorer
BalanceOpt(BalanceOpt), BalanceOpt(BalanceOpt),
} }
......
...@@ -37,11 +37,11 @@ use log::Level; ...@@ -37,11 +37,11 @@ use log::Level;
/// Rust implementation of Duniter /// Rust implementation of Duniter
pub struct DursOpt { pub struct DursOpt {
#[structopt(short = "p", long = "profile")] #[structopt(short = "p", long = "profile")]
/// Set a custom user datas folder /// Set a custom user data folder
profile_name: Option<String>, profile_name: Option<String>,
#[structopt(short = "l", long = "logs", raw(next_line_help = "true"))] #[structopt(short = "l", long = "logs", raw(next_line_help = "true"))]
/// Set the level of logs verbosity. (Default is INFO). /// Set log level. (Defaults to INFO).
/// Possible values : [OFF, ERROR, WARN, INFO, DEBUG, TRACE] /// Available levels: [OFF, ERROR, WARN, INFO, DEBUG, TRACE]
logs_level: Option<Level>, logs_level: Option<Level>,
#[structopt(subcommand)] #[structopt(subcommand)]
/// CoreSubCommand /// CoreSubCommand
...@@ -52,33 +52,33 @@ pub struct DursOpt { ...@@ -52,33 +52,33 @@ pub struct DursOpt {
/// Core cli subcommands /// Core cli subcommands
pub enum CoreSubCommand { pub enum CoreSubCommand {
#[structopt(name = "enable")] #[structopt(name = "enable")]
/// Enable some module /// Enable a module
EnableOpt(EnableOpt), EnableOpt(EnableOpt),
#[structopt(name = "disable")] #[structopt(name = "disable")]
/// Disable some module /// Disable a module
DisableOpt(DisableOpt), DisableOpt(DisableOpt),
#[structopt(name = "modules")] #[structopt(name = "modules")]
/// list modules /// List available modules
ListModulesOpt(ListModulesOpt), ListModulesOpt(ListModulesOpt),
#[structopt(name = "start")] #[structopt(name = "start")]
/// start durs server /// Start node
StartOpt(StartOpt), StartOpt(StartOpt),
#[structopt(name = "sync")] #[structopt(name = "sync")]
/// synchronization /// Synchronize
SyncOpt(SyncOpt), SyncOpt(SyncOpt),
/// reset data or conf or all /// Reset data or conf or all
#[structopt( #[structopt(
name = "reset", name = "reset",
raw(setting = "structopt::clap::AppSettings::ColoredHelp") raw(setting = "structopt::clap::AppSettings::ColoredHelp")
)] )]
ResetOpt(ResetOpt), ResetOpt(ResetOpt),
/// durs databases explorer /// Database explorer
#[structopt( #[structopt(
name = "dbex", name = "dbex",
raw(setting = "structopt::clap::AppSettings::ColoredHelp") raw(setting = "structopt::clap::AppSettings::ColoredHelp")
)] )]
DbExOpt(DbExOpt), DbExOpt(DbExOpt),
/// keys operations /// Keys operations
#[structopt( #[structopt(
name = "keys", name = "keys",
author = "inso <inso@tuta.io>", author = "inso <inso@tuta.io>",
......
...@@ -19,9 +19,9 @@ use crate::cli::InvalidInput; ...@@ -19,9 +19,9 @@ use crate::cli::InvalidInput;
use std::str::FromStr; use std::str::FromStr;
#[derive(StructOpt, Debug, Copy, Clone)] #[derive(StructOpt, Debug, Copy, Clone)]
/// start durs server /// Reset data or configuration
pub struct ResetOpt { pub struct ResetOpt {
/// choose type datas to reset /// Kind of data to be reseted: data, conf, all
pub reset_type: ResetType, pub reset_type: ResetType,
} }
...@@ -44,7 +44,7 @@ impl FromStr for ResetType { ...@@ -44,7 +44,7 @@ impl FromStr for ResetType {
"data" => Ok(ResetType::Datas), "data" => Ok(ResetType::Datas),
"conf" => Ok(ResetType::Conf), "conf" => Ok(ResetType::Conf),
"all" => Ok(ResetType::All), "all" => Ok(ResetType::All),
_ => Err(InvalidInput("Values accepted are : data, conf, all.")), _ => Err(InvalidInput("Kind of data to be reseted: data, conf, all.")),
} }
} }
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment