arachnid-cli 0.0.3

arachnid aims to be a complete offensive security suite written 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
90
91
92
93
94
95
96
97

/*
    Appellation: cli <module>
    Created At: 2026.01.10:15:58:56
    Contrib: @FL03
*/
use super::cmd::Command;
use crate::Context;

/// The root command line interface structure
#[derive(
    Clone,
    Debug,
    Default,
    Eq,
    Hash,
    Ord,
    PartialEq,
    PartialOrd,
    clap::Parser,
    serde::Deserialize,
    serde::Serialize,
)]
#[clap(about, author, long_about = None, version)]
#[command(arg_required_else_help(true), allow_missing_positional(true))]
pub struct Cli {
    #[clap(subcommand)]
    pub command: Option<Command>,
    #[clap(long, short = 'C', default_value_t = String::from("Puzzled.toml"))]
    pub config: String,
    #[clap(action = clap::ArgAction::Count, long, short)]
    pub release: u8,
    #[arg(action = clap::ArgAction::Count, long, short)]
    pub update: u8,
    #[arg(action = clap::ArgAction::Count, long, short)]
    pub verbose: u8,
}

impl Cli {
    #[tracing::instrument(target = "cli")]
    /// parse a new instance of the command line arguments
    pub fn parse() -> Self {
        tracing::debug! { "Parsing command line arguments..." }
        <Self as clap::Parser>::parse()
    }
    /// returns a reference to the optional command
    pub fn command(&self) -> &Option<Command> {
        &self.command
    }
    /// returns the `release` flag
    pub const fn release(&self) -> u8 {
        self.release
    }
    /// returns the `verbose` flag
    pub const fn verbose(&self) -> u8 {
        self.verbose
    }
    /// returns a copy of the `update` flag
    pub const fn update(&self) -> u8 {
        self.update
    }
    /// returns true if the release flag has been toggled at least once
    pub const fn is_release(&self) -> bool {
        self.release > 0
    }
    /// returns true if the verbose flag has been toggled at least once
    pub const fn is_verbose(&self) -> bool {
        self.verbose > 0
    }
    /// returns true if the update flag has been toggled at least once
    pub const fn is_update(&self) -> bool {
        self.update > 0
    }
    /// handle the parsed arguments w.r.t. the given context
    #[tracing::instrument(skip_all, target = "cli")]
    pub async fn handle(&self, ctx: &mut Context) -> anyhow::Result<()> {
        // handle any commands
        if let Some(cmd) = &self.command {
            tracing::info! { "Executing command: {:?}", cmd.name() }
            cmd.handle(ctx).await?;
        }
        // handle the flags
        if self.is_release() {
            tracing::info!(
                "Release flag has been toggled {n} times",
                n = self.release()
            );
        }
        if self.is_verbose() {
            tracing::info! { "Verbose flag has been toggled {n} times", n = self.verbose() }
        }

        if self.is_update() {
            tracing::info! { "Update flag has been toggled {n} times", n = self.update() }
        }
        Ok(())
    }
}