kotlinx-cli icon indicating copy to clipboard operation
kotlinx-cli copied to clipboard

Option to add program description to the help text.

Open dmitry-ryadnenko-izettle opened this issue 3 years ago • 1 comments

It would be nice to be able to add a more detailed program description to the help text. Like this.

Name: example
Description: runs example
Usage: example options_list
Arguments: 
    input -> Input file { String }
    output -> Output file name (optional) { String }

Python's argparse (https://docs.python.org/3/library/argparse.html) has description and epilog, I suggest to implement something similar in kotlinx-cli as well.

parser = argparse.ArgumentParser(
    prog='ProgramName',
    description='What the program does',
    epilog='Text at the bottom of help'
)

codeape2 avatar Jul 06 '23 09:07 codeape2