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

Add EXAMPLES table to help output #4

Open
johndugan opened this issue Sep 17, 2023 · 0 comments
Open

Add EXAMPLES table to help output #4

johndugan opened this issue Sep 17, 2023 · 0 comments

Comments

@johndugan
Copy link

When executing myapp --help, a nice table is presented with the information provided in cli.js.

I believe the meow API allows for an examples object to be defined. It would be great to have this added to the help text tables.

// cli.js

//...code

const examples = {
    'Greet by first name': 'myapp greet --first-name Bob'
};

const helpText = meowHelp({
    name: 'content',
    flags: flags,
    commands: commands,
    examples: examples
});

// ...rest of code
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

1 participant