Skip to content

Commit a4241cb

Browse files
committed
fix: Correct cluster flag short form in help examples
Help text and man page examples showed '-c' for the cluster flag, but the actual short form is '-C'. Running the examples verbatim would fail with clap's 'unexpected argument' error.
1 parent 7eb4356 commit a4241cb

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/man/bssh.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1232,11 +1232,11 @@ Specify target hosts:
12321232
.TP
12331233
.B --filter
12341234
Include only matching hosts:
1235-
.B bssh -c cluster --filter "web[1-5]" "systemctl status nginx"
1235+
.B bssh -C cluster --filter "web[1-5]" "systemctl status nginx"
12361236
.TP
12371237
.B --exclude
12381238
Exclude matching hosts:
1239-
.B bssh -c cluster --exclude "node[1,3,5]" "df -h"
1239+
.B bssh -C cluster --exclude "node[1,3,5]" "df -h"
12401240

12411241
.SS Examples
12421242
.nf

src/cli/bssh.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ pub enum Commands {
387387
#[command(
388388
about = "Start interactive shell session",
389389
long_about = "Opens an interactive shell session with one or more remote hosts.\nSupports both single-node and multiplex modes for efficient cluster management.\nIn multiplex mode, commands are sent to all active nodes simultaneously.\n\nSpecial commands (default prefix '!'):\n !all - Activate all connected nodes\n !broadcast <cmd> - Execute on all nodes temporarily\n !node<N> - Switch to specific node (e.g., !node1)\n !list - List all nodes and connection status\n !status - Show currently active nodes\n !help - Show special commands help\n exit - Exit interactive mode\n\nSettings can be configured globally or per-cluster in config file.\nCLI arguments override configuration file settings.",
390-
after_help = "Examples:\n bssh interactive # Auto-detect or use defaults\n bssh -c prod interactive # Use production cluster\n bssh interactive --single-node # Connect to one node only\n bssh interactive --prompt-format '{user}>' # Custom prompt\n bssh interactive --work-dir /var/www # Set initial directory"
390+
after_help = "Examples:\n bssh interactive # Auto-detect or use defaults\n bssh -C prod interactive # Use production cluster\n bssh interactive --single-node # Connect to one node only\n bssh interactive --prompt-format '{user}>' # Custom prompt\n bssh interactive --work-dir /var/www # Set initial directory"
391391
)]
392392
Interactive {
393393
#[arg(

0 commit comments

Comments
 (0)