No help is displayed for branched commands

[ygeerts]

Branched commands are not being displayed when the help option is used on the root level of an application.

In the following example setup, only information about the RootCommand will be shown when the app is invoked like this: app.exe --help

Example setup

app.Configure(config =>
{
    _ = config.AddCommand<RootCommand>("root")
              .WithDescription("The root command.");

    _ = config.AddBranch("sub", gitConfig =>
              {
                  _ = gitConfig.AddCommand<BranchedCommand>("branch")
                               .WithDescription("The branched command.");
              });
});

Output

...
COMMANDS:
      root          The root command
      sub

Would it be possible to also include all the branched commands in the help text when the help option is invoked on the root level of an app?

Desired output

...
COMMANDS:
      root                         The root command
      sub
             branch                The branched command

[patriksvensson]

You will only get help for the current branch that you're on.

If you want help for branch in your example above, you will need to write ./app.exe sub branch --help.

This is by design.

[ygeerts]

Thanks for the quick reply!

I'm wondering if it wouldn't be better to show a list of all commands in the current branch and all "child" branches (including their description) by default when you're invoking help?

I'm happy to contribute these changes if needed.

[patriksvensson]

The way it currently works is pretty much standard for CLI applications, and how we want it. If you want to provide help in a customized way, you can implement IHelpProvider. There is some documentation about that here: https://spectreconsole.net/cli/command-help