Skip to content

Commit f95ae60

Browse files
committed
Update documentation around explainshell
Related #180
1 parent 12688a6 commit f95ae60

File tree

2 files changed

+3
-12
lines changed

2 files changed

+3
-12
lines changed

vscode-client/README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,15 @@ Visual Studio Code extension utilizing the [bash language server](bash-lsp), tha
1616

1717
## Configuration
1818

19-
To get documentation for flags on hover (thanks to explainshell), run the [explainshell Docker container][codeintel-bash-with-explainshell]:
20-
21-
```
22-
docker run --rm --name bash-explainshell -p 5000:5000 chrismwendt/codeintel-bash-with-explainshell
23-
```
24-
25-
And add this to your VS Code settings:
19+
To get documentation for flags on hover (thanks to explainshell), run a explainshell server and update your VS Code settings:
2620

2721
```
2822
"bashIde.explainshellEndpoint": "http://localhost:5000",
2923
```
3024

31-
For security reasons, it defaults to `""`, which disables explainshell integration. When set, this extension will send requests to the endpoint and displays documentation for flags.
32-
33-
Once https://github.com/idank/explainshell/pull/125 is merged, it would be possible to set this to `"https://explainshell.com"`, however doing this is **not recommended** as it will leak *all your shell scripts* to a third party — do this at your own risk, or better always use a locally running Docker image.
25+
For security reasons, it defaults to `""`, which disables explainshell integration. When set, this extension will send requests to the endpoint and displays documentation for flags. We recommend using a local Docker image (see https://github.com/bash-lsp/bash-language-server/issues/180).
3426

3527
[bash-lsp]: https://github.com/bash-lsp/bash-language-server/tree/master/server
3628
[tree-sitter]: https://github.com/tree-sitter/tree-sitter
3729
[tree-sitter-bash]: https://github.com/tree-sitter/tree-sitter-bash
3830
[explainshell]: https://explainshell.com/
39-
[codeintel-bash-with-explainshell]: https://hub.docker.com/r/chrismwendt/codeintel-bash-with-explainshell/

vscode-client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"bashIde.explainshellEndpoint": {
4545
"type": "string",
4646
"default": "",
47-
"description": "Set this to https://explainshell.com (once https://github.com/idank/explainshell/pull/125 is merged in) in order to get hover documentation on flags and options."
47+
"description": "Configure explainshell server in order to get hover documentation on flags and options."
4848
}
4949
}
5050
}

0 commit comments

Comments
 (0)