diff --git a/docs/demo.cast b/docs/demo.cast index 7053a24..e000d76 100644 --- a/docs/demo.cast +++ b/docs/demo.cast @@ -12,7 +12,7 @@ [0.0,"o","--h"] [0.15,"i","elp\r"] [0.0,"o","elp\r\n"] -[0.25,"o","A Bluetooth headset intercom for Linux\r\n\r\nUsage: bt-intercom [OPTIONS] \r\n\r\nCommands:\r\n scan Scan for nearby Bluetooth devices\r\n pair Pair, trust, and connect a headset\r\n remove Remove a headset from the saved intercom network\r\n status Show Bluetooth headset audio status\r\n run Route configured headset microphones to one another\r\n completions Generate shell completion definitions\r\n panel Open the interactive terminal control panel\r\n help Print this message or the help of the given subcommand(s)\r\n\r\nOptions:\r\n --verbose Enable detailed diagnostics on stderr (unless RUST_LOG is set)\r\n -V, --version \r\n -h, --help Print help\r\n"] +[0.25,"o","A Bluetooth headset intercom for Linux\r\n\r\nUsage: bt-intercom [OPTIONS] \r\n\r\nCommands:\r\n scan Scan for nearby Bluetooth devices\r\n pair Pair, trust, and connect a headset\r\n remove Remove a headset from the saved intercom network\r\n status Show Bluetooth headset audio status\r\n run Route configured headset microphones to one another, optionally showing the live dashboard\r\n completions Generate shell completion definitions\r\n panel Open the interactive terminal control panel\r\n help Print this message or the help of the given subcommand(s)\r\n\r\nOptions:\r\n --verbose Enable detailed diagnostics on stderr (unless RUST_LOG is set)\r\n -V, --version \r\n -h, --help Print help\r\n"] [0.5,"o","$ "] [0.15,"i","bt-"] [0.0,"o","bt-"] diff --git a/src/main.rs b/src/main.rs index d81db89..b5c329d 100644 --- a/src/main.rs +++ b/src/main.rs @@ -125,7 +125,7 @@ enum CliCommand { #[arg(required = true, value_parser = address)] addresses: Vec, }, - /// Route configured headset microphones to one another. + /// Route configured headset microphones to one another, optionally showing the live dashboard. Run { #[arg(value_parser = address)] addresses: Vec, @@ -1221,6 +1221,13 @@ mod tests { assert!(short.contains(env!("BT_INTERCOM_BUILD_DATETIME"))); } + #[test] + fn top_level_help_mentions_dashboard_and_control_panel() { + let help = cli_command().render_help().to_string(); + assert!(help.contains("dashboard")); + assert!(help.contains("control panel")); + } + #[test] fn parses_ptt_without_changing_default_mode() { let address = "AA:BB:CC:DD:EE:01".to_string();