bash-language-server icon indicating copy to clipboard operation
bash-language-server copied to clipboard

What is explainshell used for / should it be recommended to install as a dependency in the Readme?

Open jerabaul29 opened this issue 2 years ago • 1 comments

For now, explainshell is mentioned in passing in the readme, and it is not clear how important / useful it is to have it installed.

I guess explainshell is to provide documentation / explanations somehow either at hoover or when asking for help about elements? Is it also strongly recommended or not / should I also mention it in the dependencies section? Or is the functionality provided by explainshell already well covered by the package per se?

If this can be explained here, I can summarize the discussion in a short README extension PR :) .

jerabaul29 avatar Nov 07 '23 08:11 jerabaul29

explainshell will give you flag explanation on hover (hovering on -i from grep)

image

It's nice, but will remove man like pop-up when hovering over command

with explainshell disabled: image

with explainshell enabled: image

Would be great to have man like pop-up AND flag explanation

g-vdn avatar Aug 07 '24 09:08 g-vdn

@g-vdn what explainshell image are you using? None of what I tried have the /api/ endpoint.

Could you please check #1080 as it seems many many people have the same issue (i linked relevant tickets to that one)

gryffus avatar May 06 '25 11:05 gryffus