diff --git a/lsp/README.md b/lsp/README.md index cb775ca..4274a73 100644 --- a/lsp/README.md +++ b/lsp/README.md @@ -2,6 +2,39 @@ As mentioned in the release notes, the `.vsix` file described here provides early access to features that we are proposing to be contributed into the official Docker vscode extension. +## Installing + +### Step 1: Download Extension File +Two VSCode extensions are available: +- Dockerfile Language Features: https://github.com/docker/docker-vscode/releases/tag/lsp-v1.29.6-alpha +- Generate runnable makefile in markdown: https://github.com/docker/docker-vscode/releases/tag/runbook-v0.0.3 + +Download the `.vsix` bundle. + +### Step 2: Enable Extension in VSCode + +#### CLI: + +Must have VSCode [code](https://code.visualstudio.com/docs/editor/command-line#_code-is-not-recognized-as-an-internal-or-external-command) command in PATH: + +```bash +code --install-extension /my/path/to/docker-bundle.vsix --force +``` + +#### GUI: + +Extensions -> `...` menu -> `Install from VSIX` + +Screenshot of docker install menu + +#### GUI (command palette): + +1. Type `>` into top search bar +**Shortcut: Press ⇧⌘P (OSX) or CTRL⇧P (Win/Linux)** +2. Select `Extensions: Install from VSIX...` +3. Select `.vsix` file downloaded +4. Hit the “Reload Now” button in the notification at the bottom right corner + ## Dependencies These updates require a local [Docker Desktop](https://www.docker.com/products/docker-desktop/) and a running docker engine.