canic_cli/
lib.rs

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

canic_cli/
lib.rs
