Skip to content

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

@dickoff

Description

@dickoff

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions