diff --git a/README.md b/README.md index 9f6bf20..9f929b6 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ cargo install --path ./ Usage: sys-compare Commands: - create - compare + create Create a snapshot + compare Compare two snapshots help Print this message or the help of the given subcommand(s) Options: @@ -24,8 +24,8 @@ Options: Usage: sys-compare create --root-dir --output-path Options: - -r, --root-dir - -o, --output-path + -r, --root-dir Directory to create snapshot from + -o, --output-path Snapshot output/save location -h, --help Print help ``` @@ -34,10 +34,10 @@ Options: Usage: sys-compare compare [OPTIONS] --left --right Options: - -l, --left - -r, --right - -s, --selection - -c [possible values: true, false] + -l, --left left side of diff + -r, --right right side of diff + -s, --selection OPTIONAL: specify which change type specifically to return + -c OPTIONAL: when using selection specify to return count only or not [possible values: true, false] -h, --help Print help ``` diff --git a/src/options.rs b/src/options.rs index 428d9cf..4048778 100644 --- a/src/options.rs +++ b/src/options.rs @@ -9,19 +9,27 @@ pub struct Arguments { #[derive(Subcommand, Clone, Debug)] pub enum Commands { + /// Create a snapshot Create { + /// Directory to create snapshot from #[arg(short, long)] root_dir: String, + /// Snapshot output/save location #[arg(short, long)] output_path: String, }, + /// Compare two snapshots Compare { + /// left side of diff #[arg(short, long)] left: String, + /// right side of diff #[arg(short, long)] right: String, + /// OPTIONAL: specify which change type specifically to return #[arg(short, long)] selection: Option, + /// OPTIONAL: when using selection specify to return count only or not #[arg(short)] count_only: Option, },