canic_cli/
lib.rs

1mod backup;
2mod build;
3mod cli;
4mod cycles;
5mod deploy;
6mod endpoints;
7mod evidence;
8mod evidence_support;
9mod fleets;
10mod info;
11mod install;
12mod list;
13mod medic;
14mod metrics;
15mod output;
16mod replica;
17mod restore;
18mod scaffold;
19mod snapshot;
20mod status;
21mod support;
22#[cfg(test)]
23mod test_support;
24mod token;
25
26use crate::cli::{
27    clap::parse_matches,
28    globals::{
29        DISPATCH_ARGS, apply_global_icp, apply_global_network, command_local_global_option,
30        top_level_dispatch_command,
31    },
32    help::{first_arg_is_help, usage},
33};
34pub use cli::top_level_command;
35use std::ffi::OsString;
36use thiserror::Error as ThisError;
37
38const VERSION_TEXT: &str = concat!("canic ", env!("CARGO_PKG_VERSION"));
39
40///
41/// CliError
42///
43
44#[derive(Debug, ThisError)]
45pub enum CliError {
46    #[error("{0}")]
47    Usage(String),
48
49    #[error("backup: {0}")]
50    Backup(#[from] backup::BackupCommandError),
51
52    #[error("build: {0}")]
53    Build(#[from] build::BuildCommandError),
54
55    #[error("cycles: {0}")]
56    Cycles(#[from] cycles::CyclesCommandError),
57
58    #[error("deploy: {0}")]
59    Deploy(#[from] deploy::DeployCommandError),
60
61    #[error("endpoints: {0}")]
62    Endpoints(#[from] endpoints::EndpointsCommandError),
63
64    #[error("evidence: {0}")]
65    Evidence(#[from] evidence::EvidenceCommandError),
66
67    #[error("install: {0}")]
68    Install(#[from] install::InstallCommandError),
69
70    #[error("info: {0}")]
71    Info(#[from] info::InfoCommandError),
72
73    #[error("fleet: {0}")]
74    Fleets(#[from] fleets::FleetCommandError),
75
76    #[error("medic: {0}")]
77    Medic(#[from] medic::MedicCommandError),
78
79    #[error("metrics: {0}")]
80    Metrics(#[from] metrics::MetricsCommandError),
81
82    #[error("snapshot: {0}")]
83    Snapshot(#[from] snapshot::SnapshotCommandError),
84
85    #[error("scaffold: {0}")]
86    Scaffold(#[from] scaffold::ScaffoldCommandError),
87
88    #[error("restore: {0}")]
89    Restore(#[from] restore::RestoreCommandError),
90
91    #[error("replica: {0}")]
92    Replica(#[from] replica::ReplicaCommandError),
93
94    #[error("status: {0}")]
95    Status(#[from] status::StatusCommandError),
96
97    #[error("token: {0}")]
98    Token(#[from] token::TokenCommandError),
99}
100
101/// Run the CLI from process arguments.
102pub fn run_from_env() -> Result<(), CliError> {
103    run(std::env::args_os().skip(1))
104}
105
106/// Run the CLI from an argument iterator.
107pub fn run<I>(args: I) -> Result<(), CliError>
108where
109    I: IntoIterator<Item = OsString>,
110{
111    let args = args.into_iter().collect::<Vec<_>>();
112    if first_arg_is_help(&args) {
113        println!("{}", usage());
114        return Ok(());
115    }
116    if let Some(option) = command_local_global_option(&args) {
117        return Err(CliError::Usage(format!(
118            "{option} is a top-level option; put it before the command\n\n{}",
119            usage()
120        )));
121    }
122
123    let matches =
124        parse_matches(top_level_dispatch_command(), args).map_err(|_| CliError::Usage(usage()))?;
125    if matches.get_flag("version") {
126        println!("{}", version_text());
127        return Ok(());
128    }
129    let global_icp = matches.get_one::<String>("icp").cloned();
130    let global_network = matches.get_one::<String>("network").cloned();
131
132    let Some((command, subcommand_matches)) = matches.subcommand() else {
133        return Err(CliError::Usage(usage()));
134    };
135    let mut tail = subcommand_matches
136        .get_many::<OsString>(DISPATCH_ARGS)
137        .map(|values| values.cloned().collect::<Vec<_>>())
138        .unwrap_or_default();
139    apply_global_icp(command, &mut tail, global_icp);
140    apply_global_network(command, &mut tail, global_network);
141    let tail = tail.into_iter();
142
143    match command {
144        "backup" => backup::run(tail).map_err(CliError::from),
145        "build" => build::run(tail).map_err(CliError::from),
146        "cycles" => cycles::run(tail).map_err(CliError::from),
147        "deploy" => deploy::run(tail).map_err(CliError::from),
148        "endpoints" => endpoints::run(tail).map_err(CliError::from),
149        "evidence" => evidence::run(tail).map_err(CliError::from),
150        "fleet" => fleets::run(tail).map_err(CliError::from),
151        "info" => info::run(tail).map_err(CliError::from),
152        "install" => install::run(tail).map_err(CliError::from),
153        "medic" => medic::run(tail).map_err(CliError::from),
154        "metrics" => metrics::run(tail).map_err(CliError::from),
155        "replica" => replica::run(tail).map_err(CliError::from),
156        "scaffold" => scaffold::run(tail).map_err(CliError::from),
157        "snapshot" => snapshot::run(tail).map_err(CliError::from),
158        "status" => status::run(tail).map_err(CliError::from),
159        "token" => token::run(tail).map_err(CliError::from),
160        "restore" => restore::run(tail).map_err(CliError::from),
161        _ => unreachable!("top-level dispatch command only defines known commands"),
162    }
163}
164
165#[must_use]
166pub const fn version_text() -> &'static str {
167    VERSION_TEXT
168}
169
170#[cfg(test)]
171mod tests;
canic_cli/lib.rs

canic_cli/
lib.rs
