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 Support For Title? #46

Closed
busticated opened this issue Jan 24, 2012 · 1 comment
Closed

Add Support For Title? #46

busticated opened this issue Jan 24, 2012 · 1 comment
Milestone

Comments

@busticated
Copy link

Hey there -
Wondering if there's a way to set a title for the help screen - something like:

< misc title text goes here >

Usage: log [options]

Options:

  -h, --help         output usage information
  -V, --version      output the version number
  -a, --addr <addr>  bind to the given address

Right now i'm using the .on('--help') option to include it... but it puts it down below the instructions (oh, the horror!)...

Thanks!
-matt

p.s. I realize this is a fairly superfluous feature so feel free to file / ignore accordingly!

@thethomaseffect
Copy link
Collaborator

Generally you should aim to make your CLI look as standard as possible e.g. cd: usage: cd [-L|[-P [-e]] [-@]] [dir]. If you don't want to you should overwrite with your own custom help. I understand you probably wouldn't like updating your custom help every time the API changes but I don't think a lot of people would use this.

@shadowspawn shadowspawn added this to the v7.0.0 milestone Sep 9, 2020
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Sep 9, 2020
@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Jan 15, 2021
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

3 participants