[Request]: CLI help params to be a little more helpful

[paul-hammant]

Tell us the problem or your need

I'm new to flatpak and bottles. I've a Chromebook and a Ubuntu NUC with KVM VMs and LXC container for other things on both. I thought I'd learn about bottles.

paul@penguin:~$ flatpak run --command=bottles-cli com.usebottles.bottles --help
usage: bottles-cli [-h] [-v] [-j] {info,list,programs,add,tools,reg,edit,new,run,standalone,shell} ...

Bottles is a tool to manage your bottles

positional arguments:
  {info,list,programs,add,tools,reg,edit,new,run,standalone,shell}
                        sub-command help
    info                Show information about Bottles
    list                List entities
    programs            List programs
    add                 Add program
    tools               Launch Wine tools
    reg                 Manage registry
    edit                Edit a bottle configuration
    new                 Create a new bottle
    run                 Run a program
    standalone          Generate a standalone script to launch commands without passing trough Bottles
    shell               Launch commands in a Wine shell

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -j, --json            Outputs in JSON format
paul@penguin:~$ flatpak run --command=bottles-cli com.usebottles.bottles programs
usage: bottles-cli programs [-h] -b BOTTLE
bottles-cli programs: error: the following arguments are required: -b/--bottle
paul@penguin:~$ flatpak run --command=bottles-cli com.usebottles.bottles list
usage: bottles-cli list [-h] [-f FILTER] {bottles,components}
bottles-cli list: error: the following arguments are required: type
paul@penguin:~$ flatpak run --command=bottles-cli com.usebottles.bottles list -h
usage: bottles-cli list [-h] [-f FILTER] {bottles,components}

positional arguments:
  {bottles,components}  Type of entity

options:
  -h, --help            show this help message and exit
  -f FILTER, --filter FILTER
                        Filter bottles and components (e.g. '-f 'environment:gaming')
paul@penguin:~$ flatpak run --command=bottles-cli com.usebottles.bottles programs -h
usage: bottles-cli programs [-h] -b BOTTLE

options:
  -h, --help            show this help message and exit
  -b BOTTLE, --bottle BOTTLE
                        Bottle name

So I now know that programs and list are two sub commands. I have not yet learned of their differentiation. I am guessing one of the two is for local already-installed bottles and the other is for remote you-could-install-this possibilities.

Describe the solution you'd like

Bottles-cli would be even better if -h functionality would say a little more about the purpose of the sub command.

Other solutions?

No response

Additional context and references

No response

[paul-hammant]

GPT 3.5 doesn't know either: https://chat.openai.com/share/9bd033f0-593b-4d28-9049-04c856ed4da3 unfortunately