Search for CLI commands and samples from the command line

[waldekmastykarz]

Would it be helpful if we offered a way to search for CLI commands and samples directly from the command line? Currently, if you want to find a command but you don't know its name, or if you're looking for samples, the only way for you to do is to use CLI's docs on the web. We're shipping docs together with CLI already just don't expose a way to search through them. Would that be a helpful addition?

[garrytrinder]

I'm not sure about a specific search command, but making it easier to get the right command would be a good idea.

I like how git gives you suggested options when you use a command name that doesn't exist, example

➜ git stat
git: 'stat' is not a git command. See 'git --help'.

The most similar commands are
	status
	stage
	stash

[waldekmastykarz]

In our case, would that much just the current level of the command (ends with) or any part of the command (contains)?

[garrytrinder]

I would say that we check the ends with, this is the behaviour that I think would work well.

➜ m365 team
m365: 'team' is not a m365 command. See 'm365 --help'.

The most similar commands are
	teams

➜ m365 teams teams
m365: 'teams' is not a m365 teams command. See 'm365 teams --help'.

The most similar commands are
	team

[waldekmastykarz]

If we look at ends with, then you wouldn't get any results, because each command name ends with a verb and team is a noun. We could come up with an algorithm that breaks user input into words and finds the last matching work to match the segment and then inside the segment lookup the similar matches, but I wonder if that's not too complicated for the added value it offers.

[garrytrinder]

Good catch, I guess the question is do we see value in changing the current behaviour which lists all possible commands, probably not.

[waldekmastykarz]

I've been thinking to keep the current behavior as-is and then introduce a separate command like cli search to let people find relevant command and samples