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

Provide a way to search the various command names and help text via the builtin help command. #673

Open
dickoff opened this issue Oct 1, 2024 · 0 comments

Comments

@dickoff
Copy link

dickoff commented Oct 1, 2024

As a cli tool grows in capabilities and complexity it becomes harder and hard to find out which command, subcommand, or option might be helpful to accomplish a task.

As one idea to help solve this, we could introduce something like a -s | --search option to the help command which could search the underlying command tree for anything relevant. my-command help -s "jargon" would output all subcommands and options of my-command that contain the string "jargon" in their name or help text. This search could be narrowed to a subcommand as well like my-command sub-command help -s "jargon". Ideally this could be a fuzzy find to help people find commands that are similar to what they typed. SAP already does something similar with edit distance accounting for mispellings.

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