Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Option to add program description to the help text. #90

Open
dmitry-ryadnenko-izettle opened this issue Oct 27, 2022 · 1 comment
Open

Comments

@dmitry-ryadnenko-izettle

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 }
@codeape2
Copy link

codeape2 commented Jul 6, 2023

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'
)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants