Enhance CLI command formatting and fix section name parsing

[sadesguy]

Refactor the CLI command structure to utilize a custom help formatter, improving the display of command help. Fixes issues with section name parsing in the help formatter for better clarity.

[jingkaihe]

Hi, again thanks for looking into improving the help doc based on our discussion. I just checked it out, and gave it try. It looks very impressive! Will give it detailed review later today.

So far this is my initial feedback:

• Can you leave the default options as it is as it is something useful to know?
• I really like the cli colours, but at the same time I'd prefer not having it, as all the the cli I use do not have colours in the options, and I'd prefer sticking to the convention.

[sadesguy]

• Can you leave the default options as it is as it is something useful to know?

can you elaborate?

I’ve created a "—no-color" flag (true by default) with OPSMATE_COLOR env var if users want to use colors

[jingkaihe]

@sadesguy e.g.

  -c, --context TEXT
      The context to use for the session. Run `opsmate list-contexts` to see the available
contexts. (env: OPSMATE_CONTEXT)

vs

  -c, --context TEXT              The context to use for the session. Run
                                  `opsmate list-contexts` to see the available
                                  contexts. (env: OPSMATE_CONTEXT)  [default:
                                  cli]

^ the existing behaviour where there is a [default: cli] that suggests the default option

[jingkaihe]

I like the implementation of docker context.

that being said can you raise it in a separate PR to avoid scope creeping (as this irrelevant to the help formatting?

[jingkaihe]

TIL mount cache! 👍

[jingkaihe]

I gave this a thought. I'm impressed by the format, but have to say I prefer the orthodox name ... description format for the --help option

for example the docker one:

docker ps --help
Usage:  docker ps [OPTIONS]

List containers

Aliases:
  docker container ls, docker container list, docker container ps, docker ps

Options:
  -a, --all             Show all containers (default shows just running)
  -f, --filter filter   Filter output based on conditions provided
      --format string   Format output using a custom template:
                        'table':            Print output in table format with column headers (default)
                        'table TEMPLATE':   Print output in table format using the given Go template
                        'json':             Print in JSON format
...

[sadesguy]

I gave this a thought. Have to say I prefer the orthodox name ... description format for the --help option

for example the docker one:

docker ps --help
Usage:  docker ps [OPTIONS]

List containers

Aliases:
  docker container ls, docker container list, docker container ps, docker ps

Options:
  -a, --all             Show all containers (default shows just running)
  -f, --filter filter   Filter output based on conditions provided
      --format string   Format output using a custom template:
                        'table':            Print output in table format with column headers (default)
                        'table TEMPLATE':   Print output in table format using the given Go template
                        'json':             Print in JSON format
...

Don’t you think it will be a little cramped with all of the description each option has? For me it hits a little on my eyes with all of the text