Skip to content

Conversation

sigoden
Copy link
Owner

@sigoden sigoden commented Jul 2, 2025

The PR removed the <name> <version> header from the generated help text.

Old help text

prog 1.0.0
This is a test CLI

USAGE: prog [OPTIONS] <COMMAND>

New help text

This is a test CLI

USAGE: prog [OPTIONS] <COMMAND>

@sigoden sigoden changed the title feat: adjust generated help text feat: remove <name> <version> header from help text Jul 2, 2025
@sigoden sigoden merged commit 5cb39f6 into main Jul 2, 2025
4 checks passed
@sigoden sigoden deleted the feat branch July 2, 2025 09:58
@pepa65
Copy link

pepa65 commented Jul 2, 2025

This is sad, you're sabotaging your own tool...

@sigoden
Copy link
Owner Author

sigoden commented Jul 2, 2025

This really depends on personal preference. However, I personally don't think it's necessary to display the command name and version in the first line. Well-known CLI frameworks, such as Rust's clap and Go's cobra, do the same.

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

Successfully merging this pull request may close these issues.

2 participants