nd_300/
cli.rs

1use clap::{Args, Parser, Subcommand, ValueEnum};
2
3use crate::speedtest::TestDuration;
4
5/// ND-300: Cross-platform network diagnostic tool
6#[derive(Parser)]
7#[command(
8    name = "nd300",
9    author,
10    version,
11    disable_version_flag = true,
12    about = "ND-300 Network Diagnostic - QubeTX Developer Tools",
13    long_about = "ND-300 Network Diagnostic - QubeTX Developer Tools\n\n\
14        Cross-platform network diagnostics with 25+ concurrent checks,\n\
15        multi-stage network repair, and DNS configuration management.",
16    after_long_help = "EXAMPLES:\n\
17        \x20 nd300              Run standard diagnostics\n\
18        \x20 nd300 -t           Technician mode (deep diagnostics)\n\
19        \x20 nd300 dns          Change DNS servers and verify connectivity\n\
20        \x20 nd300 -d           Same as 'nd300 dns' (legacy flag form)\n\
21        \x20 nd300 fix          Diagnostic-driven triage and recovery loop\n\
22        \x20 nd300 -f           Same as 'nd300 fix' (legacy flag form)\n\
23        \x20 nd300 update       Check for updates and install\n\
24        \x20 nd300 clear-dns    Reset DNS cache\n\
25        \x20 nd300 uninstall    Remove nd300 from this system\n\
26        \x20 nd300 --fast       Skip speed test for faster execution\n\
27        \x20 nd300 --json       Output results as JSON\n\n\
28        Run 'nd300 --help' for full details, or 'nd300 -h' for a summary."
29)]
30pub struct Nd300Cli {
31    /// Technician mode - full technical report with deep diagnostics
32    #[arg(
33        short = 't',
34        long = "tech",
35        alias = "technician",
36        help_heading = "Modes",
37        global = true
38    )]
39    pub tech: bool,
40
41    /// Custom title for the report header
42    #[arg(short = 'T', long, help_heading = "Modes", global = true)]
43    pub title: Option<String>,
44
45    /// Output results as JSON
46    #[arg(long, help_heading = "Output", global = true)]
47    pub json: bool,
48
49    /// Use ASCII characters instead of Unicode box-drawing
50    #[arg(long, help_heading = "Output", global = true)]
51    pub ascii: bool,
52
53    /// Disable colored output
54    #[arg(long, help_heading = "Output", global = true)]
55    pub no_color: bool,
56
57    /// Show additional debug/trace information
58    #[arg(long, help_heading = "Output", global = true)]
59    pub verbose: bool,
60
61    /// Skip the speed test (faster execution)
62    #[arg(long, help_heading = "Speed Test", global = true)]
63    pub fast: bool,
64
65    /// Speed test duration in seconds (per direction, per provider)
66    #[arg(long, default_value = "15", help_heading = "Speed Test", global = true)]
67    pub speed_duration: u64,
68
69    /// Change DNS servers and verify connectivity
70    #[arg(short = 'd', long = "dns", help_heading = "Actions")]
71    pub dns: bool,
72
73    /// Diagnostic-driven triage and recovery loop (legacy flag form of `nd300 fix`)
74    #[arg(short = 'f', long = "fix", help_heading = "Actions")]
75    pub fix: bool,
76
77    /// Clear DNS cache and exit (legacy flag form of `nd300 clear-dns`)
78    #[arg(short = 'c', long = "clear-dns", help_heading = "Actions")]
79    pub clear_dns: bool,
80
81    /// Uninstall nd300 from this system (legacy flag form of `nd300 uninstall`)
82    #[arg(long = "uninstall", help_heading = "Actions")]
83    pub uninstall: bool,
84
85    /// Check for updates and install the latest version (legacy flag form of `nd300 update`)
86    #[arg(long = "update", help_heading = "Actions")]
87    pub update: bool,
88
89    /// Auto-confirm Medium-cost prompts when running the fix flow. Does NOT
90    /// bypass High-risk action prompts (Y/N is always required for those).
91    #[arg(
92        short = 'y',
93        long = "yes",
94        alias = "non-interactive",
95        help_heading = "Actions",
96        global = true
97    )]
98    pub yes: bool,
99
100    /// Print version
101    #[arg(short = 'v', long = "version", action = clap::ArgAction::Version)]
102    pub version: (),
103
104    /// Action subcommand. If present, takes precedence over the legacy action flags.
105    #[command(subcommand)]
106    pub command: Option<Nd300Command>,
107}
108
109/// Action subcommands. These are equivalent to the long-running action flags
110/// (`-d`, `-f`, `--update`, `--clear-dns`, `--uninstall`) — both forms are
111/// supported and mean the same thing. The subcommand form is the preferred way
112/// going forward; the flag form is kept so existing scripts continue to work.
113#[derive(Subcommand, Debug, Clone)]
114pub enum Nd300Command {
115    /// Diagnostic-driven triage loop: tests → identifies failures → applies
116    /// targeted fixes → re-tests → repeats. Bounded by iteration count, wall
117    /// clock, and per-action attempt caps. Works for technical and non-technical
118    /// users; high-risk actions always require Y/N confirmation.
119    Fix(FixArgs),
120
121    /// Change DNS servers and verify connectivity. On success, falls through to
122    /// running standard diagnostics (identical to the legacy `-d`/`--dns` flag).
123    Dns,
124
125    /// Check for updates and install the latest release.
126    Update,
127
128    /// Clear the DNS cache and exit.
129    #[command(name = "clear-dns")]
130    ClearDns,
131
132    /// Uninstall nd300 from this system.
133    Uninstall,
134
135    /// Cross-method install cleanup (HIDDEN). Invoked by the Windows installers
136    /// (and the silent self-update path) to consolidate to a single install:
137    /// remove a shadowing older `cargo install` copy and/or the other Windows
138    /// edition. Safe to run anywhere — it never deletes the running install,
139    /// cargo/rustup, the `.cargo\bin` PATH entry, or anything outside the
140    /// nd300/speedqx allowlist, and it always exits 0 (cleanup is advisory).
141    #[command(name = "migrate-cleanup", hide = true)]
142    MigrateCleanup(MigrateArgs),
143}
144
145/// Per-subcommand arguments for `fix`. Currently a placeholder — the `--yes`
146/// flag lives at the top level (global), so `nd300 fix --yes`,
147/// `nd300 --yes fix`, `nd300 -f -y`, and `nd300 -y -f` all work and share the
148/// same field on `Nd300Cli`. New fix-specific options can be added here later
149/// without affecting the legacy `-f` flag form.
150#[derive(Args, Debug, Clone, Default)]
151pub struct FixArgs {}
152
153/// Arguments for the hidden `migrate-cleanup` subcommand. With NO target flag,
154/// the command defaults to `--cargo-copy` only (the safest, never-needs-admin
155/// consolidation). All flags are tool-agnostic so this contract can be mirrored
156/// to TR-300 unchanged.
157#[derive(Args, Debug, Clone, Default)]
158pub struct MigrateArgs {
159    /// Remove a shadowing older `cargo install` / cargo-dist copy in `.cargo\bin`.
160    #[arg(long = "cargo-copy")]
161    pub cargo_copy: bool,
162
163    /// Remove the OTHER Windows edition (Global perMachine <-> Corporate perUser).
164    #[arg(long = "other-edition")]
165    pub other_edition: bool,
166
167    /// Suppress human output (installer invokes this so the wizard stays clean).
168    /// Ignored when `--json` is set.
169    #[arg(long = "quiet")]
170    pub quiet: bool,
171
172    /// Detect and report what WOULD be removed without deleting anything.
173    #[arg(long = "dry-run")]
174    pub dry_run: bool,
175
176    /// Emit a machine-readable JSON report instead of human text.
177    #[arg(long = "json")]
178    pub json: bool,
179
180    /// The invoking user's profile dir (e.g. `C:\Users\alice`). Used to resolve
181    /// that user's `.cargo\bin` and `%LocalAppData%` when this process runs as a
182    /// different user (a perMachine installer launched elevated / as SYSTEM).
183    #[arg(long = "user-profile", value_name = "PATH")]
184    pub user_profile: Option<String>,
185
186    /// The invoking user's CARGO_HOME (e.g. `C:\Users\alice\.cargo`). Takes
187    /// precedence over `--user-profile` for locating the cargo-bin directory.
188    #[arg(long = "cargo-home", value_name = "PATH")]
189    pub cargo_home: Option<String>,
190
191    /// Installer-declared origin for classifying custom install locations.
192    /// This is an internal installer contract, not a user-facing option.
193    #[arg(long = "install-origin", value_enum, hide = true)]
194    pub install_origin: Option<MigrateInstallOrigin>,
195}
196
197/// Valid installer origins accepted by the hidden migration helper.
198///
199/// Keep these values in lockstep with the four Windows installers and
200/// `actions::update::InstallOrigin::json_id`.
201#[derive(ValueEnum, Debug, Clone, Copy, PartialEq, Eq)]
202pub enum MigrateInstallOrigin {
203    MsiGlobal,
204    MsiCorporate,
205    ExeGlobal,
206    ExeCorporate,
207}
208
209/// SpeedQX Internet Speed Test - QubeTX Developer Tools
210///
211/// Eight-provider speed test (SpeedQX Methodology v4) using Cloudflare, M-Lab
212/// NDT7, M-Lab MSAK, LibreSpeed, fast.com, CacheFly, Vultr, and Apple
213/// networkQuality.
214#[derive(Parser)]
215#[command(
216    name = "speedqx",
217    author,
218    version,
219    disable_version_flag = true,
220    about = "SpeedQX Internet Speed Test - QubeTX Developer Tools",
221    long_about = "SpeedQX Internet Speed Test - QubeTX Developer Tools\n\n\
222        Eight-provider speed test (SpeedQX Methodology v4) using Cloudflare, M-Lab NDT7,\n\
223        M-Lab MSAK (multi-stream), LibreSpeed, fast.com (Netflix), CacheFly, Vultr, and\n\
224        Apple networkQuality. Providers run sequentially and are merged (capacity +\n\
225        consensus with confidence intervals) for maximum accuracy. --fast runs a quick\n\
226        three-provider subset with early stopping.",
227    after_long_help = "EXAMPLES:\n\
228        \x20 speedqx                     Run the full 8-provider test\n\
229        \x20 speedqx --fast              Quick run (Cloudflare + NDT7 + MSAK, early-stop)\n\
230        \x20 speedqx --duration 60       60s per direction for the fixed-duration providers\n\
231        \x20 speedqx --fastcom-duration 30  Override fast.com to 30s/dir\n\
232        \x20 speedqx --skip-msak --skip-apple  Drop MSAK + Apple from the full run\n\
233        \x20 speedqx update              Check for updates and install\n\
234        \x20 speedqx --update            Same as 'speedqx update' (legacy flag form)\n\
235        \x20 speedqx --json              Output results as JSON\n\n\
236        Run 'speedqx --help' for full details, or 'speedqx -h' for a summary."
237)]
238pub struct SpeedQXCli {
239    /// Output results as JSON
240    #[arg(long, help_heading = "Output", global = true)]
241    pub json: bool,
242
243    /// Use ASCII characters instead of Unicode box-drawing
244    #[arg(long, help_heading = "Output", global = true)]
245    pub ascii: bool,
246
247    /// Disable colored output
248    #[arg(long, help_heading = "Output", global = true)]
249    pub no_color: bool,
250
251    /// Test duration per direction for CF/NDT7/LibreSpeed: seconds or "auto"
252    #[arg(
253        long,
254        default_value = "30",
255        value_parser = parse_duration,
256        help_heading = "Speed Test"
257    )]
258    pub duration: TestDuration,
259
260    /// Test duration per direction for fast.com: seconds or "auto" (default: auto)
261    #[arg(
262        long,
263        default_value = "auto",
264        value_parser = parse_duration,
265        help_heading = "Speed Test"
266    )]
267    pub fastcom_duration: TestDuration,
268
269    /// Number of latency probes (advisory; the dense engine is duration-scaled)
270    #[arg(long, default_value = "20", help_heading = "Speed Test")]
271    pub latency_probes: u32,
272
273    /// FAST mode: Cloudflare + NDT7 + MSAK with early-stop (default is the full
274    /// 8-provider run)
275    #[arg(long = "fast", help_heading = "Speed Test")]
276    pub fast: bool,
277
278    /// Skip the M-Lab MSAK multi-stream provider
279    #[arg(long = "skip-msak", help_heading = "Speed Test")]
280    pub skip_msak: bool,
281
282    /// Skip the Apple networkQuality provider
283    #[arg(long = "skip-apple", help_heading = "Speed Test")]
284    pub skip_apple: bool,
285
286    /// Check for updates and install the latest version (legacy flag form of `speedqx update`)
287    #[arg(long = "update", help_heading = "Actions")]
288    pub update: bool,
289
290    /// Print version
291    #[arg(short = 'v', long = "version", action = clap::ArgAction::Version)]
292    pub version: (),
293
294    /// Action subcommand. If present, takes precedence over the legacy `--update` flag.
295    #[command(subcommand)]
296    pub command: Option<SpeedQXCommand>,
297}
298
299/// Action subcommands for `speedqx`. Mirrors the `nd300` pattern: subcommand
300/// form is preferred, legacy `--update` flag is kept so existing scripts work.
301#[derive(Subcommand, Debug, Clone)]
302pub enum SpeedQXCommand {
303    /// Check for updates and install the latest release.
304    Update,
305}
306
307fn parse_duration(s: &str) -> Result<TestDuration, String> {
308    if s.eq_ignore_ascii_case("auto") {
309        Ok(TestDuration::Auto)
310    } else {
311        s.parse::<u64>()
312            .map(TestDuration::Seconds)
313            .map_err(|_| format!("invalid duration '{}': expected a number or \"auto\"", s))
314    }
315}
nd_300/cli.rs

nd_300/
cli.rs
