|
| 1 | +## Introduction |
| 2 | + |
| 3 | +This page contains more information about the error: |
| 4 | + |
| 5 | +> The .NET Core SDK cannot be located. .NET Core debugging will not be enabled. Make sure the .NET Core SDK is installed and is on the path. |
| 6 | +
|
| 7 | +What this error means is that this extension ran the command `dotnet` and `dotnet` was **NOT** found on the `PATH` within the extension's process. |
| 8 | + |
| 9 | +If you don't have the .NET Core SDK installed, fixing this error is usually simple enough: visit https://dot.net/core-sdk-vscode to download and install the .NET Core SDK. |
| 10 | + |
| 11 | +If you do have the .NET Core SDK installed, then this means that the directory containing `dotnet` (Linux and macOS) or `dotnet.exe` (Windows) is not on your `PATH`, at least in this extension's process. The rest of this page will provide advice on understanding why. |
| 12 | + |
| 13 | +## Known issues |
| 14 | + |
| 15 | +Before we get to a list of troubleshooting steps, lets first enumerate a few known reasons why this error happens: |
| 16 | + |
| 17 | +1. If you very recently installed the .NET SDK -- |
| 18 | + * If you had Visual Studio Code open at the time you installed the .NET SDK, and you haven't restarted it, you should do so. |
| 19 | + * On Windows, on some machines, environment variable changes don't immediately take effect. Restart your computer to see if that resolves this problem. |
| 20 | +2. If the .NET SDK was installed through Linux Snap - see [Linux Snap instructions](#linux-snap-instructions) |
| 21 | + |
| 22 | +## General troubleshooting steps on Linux/Mac |
| 23 | + |
| 24 | +The first step in troubleshooting this problem is to see if this problem also happens is a terminal/shell. After you have launched a terminal or shell, type in `which dotnet`. |
| 25 | + |
| 26 | +If `which dotnet` produces a PATH, then the .NET SDK was able to successfully modify the PATH, but VS Code isn't picking it up. VS Code attempts to scrape the environment by launching the default shell under the covers. But this process can be fragile. You can attempt to work around this by starting VS Code from your Terminal. Alternatively, you can attempt to debug VS Code to understand what is going wrong -- at this time at least, the function to debug is [`getUnixShellEnvironment`](https://github.com/microsoft/vscode/blob/ab10e26096a5494b68bc709a405a0dddeb227e0b/src/vs/code/node/shellEnv.ts#L13). Lastly, you could manually add a symbolic link from within a directory which is on the PATH in all processes to wherever `dotnet` is installed (see below for instructions). |
| 27 | + |
| 28 | +If `which dotnet` produces no output, then this means the .NET SDK wasn't able to modify the `PATH` or add a symbolic link, or the .NET SDK for your platform doesn't do so. You can fix this by either adding a symbolic link yourself (example: `sudo ln -s /usr/share/dotnet/dotnet /usr/bin/dotnet` where `/usr/share/dotnet/dotnet` should be replaced with wherever the .NET SDK installer for your platform was installed to), or by modifying your `PATH` manually (example: modify ~/.bashrc add add something like `export PATH=$PATH:/new/directory/here`). |
| 29 | + |
| 30 | +## General troubleshooting steps on Windows |
| 31 | + |
| 32 | +First, as mentioned above, if you installed the .NET SDK since you last rebooted Windows, you might start by just rebooting to see if that fixes things. |
| 33 | + |
| 34 | +Otherwise, you can start troubleshooting this problem is to see if this problem also happens is a command prompt: |
| 35 | + |
| 36 | +* Start a command prompt: |
| 37 | + * Hit `WinKey+R` to bring up the Windows run dialog |
| 38 | + * Type in `cmd.exe` |
| 39 | +* When the command prompt starts, type in `where.exe dotnet`. |
| 40 | + |
| 41 | +If the result of running `where.exe` is that a path to dotnet.exe is printed (example: `C:\Program Files\dotnet\dotnet.exe`) then the .NET SDK has successfully added itself to the Windows Path. There are no known reasons why PATH wouldn't be propagated to the VS Code process. You could try starting VS Code from the command prompt to see if that helps. |
| 42 | + |
| 43 | +If the result of running `where.exe` is a message like `INFO: Could not find files for the given pattern(s).` then the .NET SDK wasn't able to add itself to the PATH. You could try uninstalling and reinstalling the .NET SDK. You could also try examining the default path with the following steps: |
| 44 | + |
| 45 | +* Bring up System Properties: |
| 46 | + * Windows 10 - On the Start Menu, search for 'This PC' and bring up properties |
| 47 | + * Before - On the Start Menu, search for 'My Computer' and bring up properties |
| 48 | +* Go to the Advanced settings |
| 49 | +* Click the button for 'Environment Variables' |
| 50 | +* Find 'Path' in either the user or system list |
| 51 | +* See if the dotnet.exe directory (example: `C:\Program Files\dotnet`) is in the list. If not you could add it. |
| 52 | +* If it is in the list, you could see if maybe another directory has added it self incorrectly (example: added an opening quote without a trailing quote), or if the set of environment variables has grown very large -- there is a limit of 32,767 total characters. |
| 53 | + |
| 54 | +### Note about 64-bit installs of the .NET SDK |
| 55 | + |
| 56 | +In 64-bit environments the .NET SDK will fail to be discovered if the 32-bit dotnet path comes before the 64-bit dotnet path in the Environment PATH variable. Try removing the 32-bit path entirely from your PATH variable and relaunch VS Code to see if your issue is resolved. |
| 57 | + |
| 58 | +## Special instructions |
| 59 | + |
| 60 | +#### Linux Snap instructions |
| 61 | + |
| 62 | +The Linux Snap packages for the .NET Core SDK, by default, will not create the `dotnet` link. To do so, run `sudo snap alias dotnet-sdk.dotnet dotnet`. More information about this can be found in [the .NET Core SDK release notes](https://github.com/dotnet/core/blob/master/release-notes/3.1/3.1.0/3.1.0-install-instructions.md#install-using-snap). |
| 63 | + |
| 64 | +Note that, as of the time of this writing, there are also other incompatibilities between this extension and the .NET Core SDK Snap package beyond the `dotnet` PATH issue. This incompatibility may result in: |
| 65 | + |
| 66 | +> Some projects have trouble loading. Please review the output for more details. |
| 67 | +> It was not possible to find any installed .NET Core SDKs |
| 68 | +> Did you mean to run .NET Core SDK commands? Install a .NET Core SDK from: |
| 69 | +> https://aka.ms/dotnet-download |
| 70 | +
|
| 71 | +More information about this problem can be found in [dotnet/cli#12110](https://github.com/dotnet/cli/issues/12110). |
| 72 | + |
| 73 | +Another possible workaround is to add the following to `~/.omnisharp/omnisharp.json`. |
| 74 | + |
| 75 | +```json |
| 76 | +{ |
| 77 | + "MSBuild": { |
| 78 | + "UseLegacySdkResolver": true |
| 79 | + } |
| 80 | +} |
| 81 | +``` |
| 82 | + |
| 83 | +Instead, you also may create a symbolic link to your dotnet install like so: |
| 84 | + |
| 85 | +`ln -s /snap/dotnet-sdk/current/dotnet /usr/local/bin/dotnet` |
0 commit comments