argx 0.3.0

Expressive command-line parsing and configuration for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Subcommands, reusable argument groups, aliases, global options, help, and version actions.
//!
//! ```text
//! cargo run --example commands -- --verbose add hello --force
//! cargo run --example commands -- rm hello
//! cargo run --example commands -- --help
//! cargo run --example commands -- --version
//! cargo run --example commands -- status --version
//! ```

use argx::{Args, Parser, Subcommand};

/// Short version displayed by `--version`.
const VERSION: &str = "1.2.3";
/// Extended version displayed by `--version --verbose`.
const LONG_VERSION: &str = "1.2.3 (build abc123)";

/// Options shared by every command.
#[derive(Debug, Args)]
struct Common {
    /// Enables verbose output.
    #[argx(short, long, global)]
    verbose: bool,
}

/// Arguments accepted by the `add` and `remove` commands.
#[derive(Debug, Args)]
struct Item {
    /// Forces the operation.
    #[argx(long)]
    force: bool,

    /// Value to add or remove.
    value: String,
}

/// Commands accepted by the application.
#[derive(Debug, Subcommand)]
enum Command {
    /// Adds one value.
    Add(Item),

    /// Removes one value.
    #[argx(alias = "rm")]
    Remove(Item),

    /// Shows status without additional arguments.
    #[argx(version = VERSION, long_version = LONG_VERSION)]
    Status,
}

/// Manage values in the example workspace.
///
/// The longer command description is authored in the Rust documentation beside its type.
///
/// # Examples
///
///     commands add hello
///     commands --verbose rm hello
#[derive(Debug, Parser)]
#[argx(version = VERSION, long_version = LONG_VERSION)]
struct Cli {
    /// Common options
    #[argx(flatten)]
    common: Common,

    /// Selects one operation.
    #[argx(subcommand)]
    command: Command,
}

fn main() {
    let cli = Cli::parse();
    if cli.common.verbose {
        eprintln!("verbose mode enabled");
    }

    match cli.command {
        Command::Add(item) => {
            if item.force {
                eprintln!("force add: {}", item.value);
            } else {
                eprintln!("add: {}", item.value);
            }
        }
        Command::Remove(item) => eprintln!("remove: {}", item.value),
        Command::Status => eprintln!("status: ok"),
    }
}