help command is not working

[prajjwalkapoor]

Describe the bug

asyncapi help is not recognized as a command. The functionality for the help is working with asyncapi --help but the recommendation says to use asyncapi help .

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[Souvikns]

Yeah, we used to have a help command and then we removed it and now only allow help with the --help flag. With the new update with oclif to have an extra help command we have to use a plugin, so by default, we should have only the --help flag.

https://oclif.io/docs/help_classes

[sambhavgupta0705]

@Souvikns so we should remove the suggestion of help ? or add the plugin

[Souvikns]

I don't think we have any suggestions, for help, I am looking at the usage docs and I don't think we have anywhere specified about help command.

[derberg]

yeah, problem is I guess that we do not have control over the warning message that says asyncapi help

[sambhavgupta0705]

yes I searched for it in the repo but didn't find any instance.

[kaushik-rishi]

@Souvikns So we are not planning to add the help command right ?

[Souvikns]

Ok so the warning is coming from a package that we use called @oclif/plugin-not-found where it creates a log message for help command https://github.com/oclif/plugin-not-found/blob/470096ba538e89fea043fa7a712404a450da6204/src/index.ts#L18 I don't think we can change that and it is misleading to the user to have a warning saying them to use asyncapi help command which does not exist so we have two options really

• create a help command
• it is actually a hook and we can write one for our use case and control the warning

what would be a good option?

[sambhavgupta0705]

IMHO

it is actually a hook and we can write one for our use case and control the warning

it is good to have only one command of help

[derberg]

I think we should go with the hook

[kaushik-rishi]

if we are decided on going with the hook, can i please work on this ? @derberg @Souvikns

[sambhavgupta0705]

@kaushik-rishi I would also like to work on this ,have gone through oclif docs and cli structure

[kaushik-rishi]

it is actually a hook and we can write one for our use case and control the warning

will we be hooking to the command_not_found event and then check if the command run was asyncapi help and then handle it ? If yes, how will we be handling it ?
@Souvikns

[derberg]

since @sambhavgupta0705 was first in the issue, he is allowed to take it first

@kaushik-rishi you can pick this one #549 as it will also require digging into CLI and figuring how to provide meaningful error

[kaushik-rishi]

Sure thing 🙂

[Priyansh61]

Hey @kaushik-rishi are you working on this issue ?

[kaushik-rishi]

@sambhavgupta0705 is.

[sambhavgupta0705]

@sambhavgupta0705 is.

Yes,I am working on it .
We are waiting for @derberg approval

[ayushnau]

Hi @sambhavgupta0705 are you still working on this.

[ayushnau]

@fmvilas
can you tell me how should i go about this. means i need to update on pluggin-not-found. of which i dont have direct control.

[derberg]

@sambhavgupta0705

We are waiting for @derberg approval

sorry but what approval?

@ayushnau
did you have a chance to see #559 (comment) ?

[ayushnau]

@sambhavgupta0705

We are waiting for @derberg approval

sorry but what approval?

@ayushnau did you have a chance to see #559 (comment) ?

yes i started working on it.

[ayushnau]

#843 @derberg
also i came across this pr #593 i would like to cover all the cases of command not found pluggin.

[AyushNautiyalDeveloper]

@Souvikns

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[peter-rr]

@prajjwalkapoor @Souvikns @derberg
Should we considered this issue as solved by #843 and then proceed to close it?