rtb-cli 0.7.1

CLI application scaffolding, clap integration, and built-in commands. Part of the phpboyscout Rust toolkit.
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

//! Built-in commands shipped with `rtb-cli`.
//!
//! Every built-in is an `impl Command` registered via
//! [`rtb_app::command::BUILTIN_COMMANDS`]. `Application::run`
//! filters them by the runtime [`Features`](rtb_app::features::Features)
//! set before handing them to `clap`.

use async_trait::async_trait;
use linkme::distributed_slice;
use rtb_app::app::App;
use rtb_app::command::{Command, CommandSpec, BUILTIN_COMMANDS};
use rtb_app::features::Feature;

use crate::health;
use crate::init::INITIALISERS;

// =====================================================================
// version — prints version + commit + date.
// =====================================================================

/// The `version` subcommand.
pub struct VersionCmd;

#[async_trait]
impl Command for VersionCmd {
    fn spec(&self) -> &CommandSpec {
        static SPEC: CommandSpec = CommandSpec {
            name: "version",
            about: "Print tool version information",
            feature: Some(Feature::Version),
            ..CommandSpec::DEFAULT
        };
        &SPEC
    }

    async fn run(&self, app: App) -> miette::Result<()> {
        let v = &app.version;
        println!("{} {}", app.metadata.name, v.version);
        if let Some(commit) = v.commit.as_deref() {
            println!("  commit: {commit}");
        }
        if let Some(date) = v.date.as_deref() {
            println!("  built:  {date}");
        }
        println!("  target: {}-{}", std::env::consts::ARCH, std::env::consts::OS);
        Ok(())
    }
}

#[distributed_slice(BUILTIN_COMMANDS)]
fn __register_version() -> Box<dyn Command> {
    Box::new(VersionCmd)
}

// =====================================================================
// doctor — runs HEALTH_CHECKS and reports.
// =====================================================================

/// The `doctor` subcommand.
pub struct DoctorCmd;

#[async_trait]
impl Command for DoctorCmd {
    fn spec(&self) -> &CommandSpec {
        static SPEC: CommandSpec = CommandSpec {
            name: "doctor",
            about: "Run diagnostic health checks",
            feature: Some(Feature::Doctor),
            ..CommandSpec::DEFAULT
        };
        &SPEC
    }

    async fn run(&self, app: App) -> miette::Result<()> {
        let report = health::run_all(&app).await;
        print!("{}", report.render());
        if report.is_ok() {
            Ok(())
        } else {
            Err(miette::miette!(
                code = "rtb::doctor::failed",
                help = "see the report above for which checks failed",
                "one or more health checks failed"
            ))
        }
    }
}

#[distributed_slice(BUILTIN_COMMANDS)]
fn __register_doctor() -> Box<dyn Command> {
    Box::new(DoctorCmd)
}

// =====================================================================
// init — iterates INITIALISERS.
// =====================================================================

/// The `init` subcommand.
pub struct InitCmd;

#[async_trait]
impl Command for InitCmd {
    fn spec(&self) -> &CommandSpec {
        static SPEC: CommandSpec = CommandSpec {
            name: "init",
            about: "Run first-time bootstrap and setup",
            feature: Some(Feature::Init),
            ..CommandSpec::DEFAULT
        };
        &SPEC
    }

    async fn run(&self, app: App) -> miette::Result<()> {
        if INITIALISERS.is_empty() {
            println!("no initialisers registered — nothing to do");
            return Ok(());
        }
        for factory in INITIALISERS {
            let init = factory();
            if init.is_configured(&app).await {
                println!("  [SKIP] {} — already configured", init.name());
                continue;
            }
            println!("  [RUN]  {}", init.name());
            init.configure(&app).await?;
        }
        Ok(())
    }
}

#[distributed_slice(BUILTIN_COMMANDS)]
fn __register_init() -> Box<dyn Command> {
    Box::new(InitCmd)
}

// The `config` subtree (show / get / set / schema / validate) lives
// in `crate::config_cmd`. The `update`, `docs`, and `mcp` stubs have
// been removed —
// `rtb-update`, `rtb-docs`, and `rtb-mcp` register the real
// commands. Downstream tools that disable the corresponding rtb
// features still get the stub-equivalent behaviour: no command
// registered, clap reports "unknown subcommand" if invoked.