Grouping CLI Options

[ryanmerolle]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

netcfgbu backup --help
                                                                                                                                        
 Usage: netcfgbu backup [OPTIONS]                                                                                                       
                                                                                                                                        
 Test logins to network devices, and reports the credential username that was used.                                                     
                                                                                                                                        
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --config            -C       TEXT     NETCFGBU Config File. [env var: NETCFGBU_CONFIG] [default: netcfgbu.toml]                      │
│ --inventory         -i       TEXT     NETCFGBU Inventory File. [env var: NETCFGBU_INVENTORY] [default: inventory.csv]                │
│ --exclude           -e       TEXT     Exclude from inventory. [default: None]                                                        │
│ --limit             -l       TEXT     Limit/Include in inventory. [default: None]                                                    │
│ --batch             -b       INTEGER  Inventory record processing batch size. [default: 100]                                         │
│ --help                                Show this message and exit.                                                                    │
│                                                                                                                                      │
│ --default_username  -du      TEXT     Default username to login with. [env var: NETCFGBU_DEFAULT_USERNAME] [default: None]           │
│ --default_password  -dp      TEXT     Default password to login with [env var: NETCFGBU_DEFAULT_PASSWORD] [default: None]            │
│ --configs_dir       -cd      TEXT     Location to backup device configs to. [env var: NETCFGBU_CONFIGSDIR] [default: configs]        │
│ --plugins_dir       -pd      TEXT     Location where plugins reside. [env var: NETCFGBU_PLUGINSSDIR] [default: plugins]              │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Description

Is there anyway to group cli options together in a manner sort of like the bash output I attached?

I'd like a way to separate out less common options to prevent cli input overload. I'd even be happy to deal separate out non-required options. I am search for ways to do this, and I am at a loss. Apologies if it's obvious or clearly not an option.

As always thanks for everything!
`

Operating System

Linux, Windows, macOS

Operating System Details

No response

Typer Version

0.12.1

Python Version

Python 3.9.18

Additional Context

No response

[NaitamG]

How did you override the default Usage: message?

[YuriiMotov]

Seems like this is what you need: https://typer.tiangolo.com/tutorial/commands/help/#help-panels-for-cli-parameters