Skip to content

fix: Correct cluster flag short form in help examples#174

Merged
inureyes merged 1 commit into
mainfrom
fix/cluster-flag-help-short
Apr 13, 2026
Merged

fix: Correct cluster flag short form in help examples#174
inureyes merged 1 commit into
mainfrom
fix/cluster-flag-help-short

Conversation

@inureyes
Copy link
Copy Markdown
Member

Summary

  • The cluster flag is defined with short = 'C' (uppercase) in src/cli/bssh.rs, but help examples and the man page showed -c (lowercase)
  • Running the examples verbatim (e.g. bssh -c prod interactive) would fail with clap's "unexpected argument" error
  • Fixed three occurrences: one in the interactive subcommand's after_help, two in docs/man/bssh.1

Test plan

  • cargo fmt / cargo clippy clean
  • Verify bssh interactive --help now shows -C prod in 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.
@inureyes inureyes added type:bug Something isn't working type:docs Improvements or additions to documentation labels Apr 13, 2026
@inureyes inureyes merged commit 293217f into main Apr 13, 2026
2 checks passed
@inureyes inureyes deleted the fix/cluster-flag-help-short branch April 13, 2026 04:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:bug Something isn't working type:docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant