apple / apple/swift-argument-parser

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

Open
#673 3 comments 1 reaction 1 assignee Claimed by @dickoff View on GitHub
enhancement good first issue
Dominant language
Swift
Stars
3.8k
Forks
411
Avg merge
7d 14h
Merged PRs (30d)
15

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.