Skip to content

Conversation

@lexming
Copy link
Collaborator

@lexming lexming commented Jan 29, 2026

By using a custom help option we can:

  • control where is displayed in the help panel
  • control shortcuts in all subcommands

Currently, the custom help option displays the default typer help panel. But in the future it could be customized if needed.

We go from

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version             -v        Show version of eessi CLI                                                                                                                                │
│ --install-completion            Install completion for the current shell.                                                                                                                │
│ --show-completion               Show completion for the current shell, to copy it or customize the installation.                                                                         │
│ --help                -h        Show this message and exit.                                                                                                                              │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

To

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help                -h        Show this message and exit.                                                                                                                              │
│ --version             -v        Show version of eessi CLI.                                                                                                                               │
│ --install-completion            Install completion for the current shell.                                                                                                                │
│ --show-completion               Show completion for the current shell, to copy it or customize the installation.                                                                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

And -h us usable in all sub-comamnds:

 $ eessi init -h

 Usage: eessi init [OPTIONS]

 Initialize shell environment for using EESSI

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help  -h        Show this message and exit.                                                                                                                                            │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

@lexming lexming changed the title add custom help option to control its placement and behaviour use custom help option to control its placement and behaviour Jan 29, 2026
@boegel boegel merged commit e22928c into EESSI:main Jan 30, 2026
6 checks passed
@lexming lexming deleted the version branch January 30, 2026 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants