Print help message if no parameters present about clikt HOT 5 CLOSED

Thanks for the detailed description. I can see that feature being useful. For now, as a workaround, you can check if all of your options are empty, and throw PrintHelpMessage(this) yourself in your command's run method.

CliktCommand.main will catch that and display the help for your subcommand for you.

from clikt.

The current behavior is to only print the help message automatically for commands with subcommands (and only if invokeWithoutSubcommand = false). The reason being that, if all of a command's parameters are optional, there's no way to know if the user is trying to see the help message, or invoke the command with default values.

from clikt.

Yes I know, that is why I asked for an explicit option (or flag).

If you don't want to include that, what would be the best way to check for this condition myself (even on sub-commands)?

from clikt.

One situation where I think it might be good to print the help message instead of the error is when you have required arguments and no values on the command line. Parsing is unambiguous in this case. Would that cover your use case, or do you have subcommands with no required arguments and you still want the help message to print instead of parsing successfully?

from clikt.

Sorry if I'm not precise enough. With option/flag I meant a constructor argument, similar to invokeWithoutSubcommand = false, for example printHelpOnEmptyArguments = false.

My use-case is that the program needs some input to run successfully and if no input is provided the help message is shown. One example would be java itself (it prints the help message if no argument is present).

The same is true for subcommands.

My specific use-case:
I wrote a CLI to compute scores for Android unlock patterns (and their features) and a user can provide patterns directly and/or in files, some examples:
apc --pattern 1.2.3.4
apc --file /path/to/file1
apc --pattern 1.2.3.4 --file /path/to/file1 --pattern 4.0.8.1.7.2 --file /path/to/file2

Thus I can mark neither --pattern nor --file as required.

Now there are certainly more complex scenarios, but since such functionality is---from what I experienced---quite common, my suggestion was to add such an option. However I also can understand if you don't want to add such functionality.

from clikt.