Skip to content

Commit 6c77350

Browse files
committed
Update Windows setup
1 parent 15f93a0 commit 6c77350

File tree

1 file changed

+69
-56
lines changed

1 file changed

+69
-56
lines changed

docs/setup/windows.md

Lines changed: 69 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -11,60 +11,91 @@ MetaDescription: Get Visual Studio Code up and running on Windows
1111

1212
## Installation
1313

14-
1. Download the [Visual Studio Code installer](https://go.microsoft.com/fwlink/?LinkID=534107) for Windows.
15-
2. Once it is downloaded, run the installer (VSCodeUserSetup-{version}.exe). This will only take a minute.
16-
3. By default, VS Code is installed under `C:\Users\{Username}\AppData\Local\Programs\Microsoft VS Code`.
14+
1. [Download and install Visual Studio Code](#install-vs-code-on-windows)
1715

18-
Alternatively, you can also download a [Zip archive](/docs/?dv=winzip), extract it and run Code from there.
16+
> [!NOTE]
17+
> VS Code ships monthly releases and supports [auto-update](#updates) when a new release is available.
1918
20-
>**Tip:** Setup will add Visual Studio Code to your `%PATH%`, so from the console you can type 'code .' to open VS Code on that folder. You will need to restart your console after the installation for the change to the `%PATH%` environmental variable to take effect.
19+
1. [Install additional components](/docs/setup/additional-components.md)
2120

22-
## User setup versus system setup
21+
Install Git, Node.js, TypeScript, language runtimes, and more.
2322

24-
VS Code provides both Windows **user** and **system** level setups.
23+
1. [Install VS Code extensions from the Visual Studio Marketplace](https://marketplace.visualstudio.com/VSCode)
24+
25+
Customize VS Code with themes, formatters, language extensions and debuggers for your favorite languages, and more.
26+
27+
1. [Set up AI-assisted coding with GitHub Copilot](/docs/copilot/setup-simplified.md)
28+
29+
> [!TIP]
30+
> If you don't yet have a Copilot subscription, you can use Copilot for free by signing up for the [Copilot Free plan](https://github.com/github-copilot/signup) and get a monthly limit of completions and chat interactions.
31+
32+
1. [Get started with the VS Code tutorial](/docs/getstarted/getting-started.md)
33+
34+
Discover the user interface and key features of VS Code.
35+
36+
## Install VS Code on Windows
2537

26-
The [user setup](https://go.microsoft.com/fwlink/?LinkID=534107) does not require Administrator privileges to run as the location will be under your user Local AppData (`LOCALAPPDATA`) folder. Since it requires no elevation, the user setup is able to provide a smoother background update experience. This is the preferred way to install VS Code on Windows.
38+
### Use the Windows installer
2739

28-
>**Note:** When running VS Code as Administrator in a user setup installation, updates will be disabled.
40+
1. Download the [Visual Studio Code installer](https://go.microsoft.com/fwlink/?LinkID=534107) for Windows
2941

30-
The [system setup](https://go.microsoft.com/fwlink/?linkid=852157) requires elevation to Administrator privileges to run and will place the installation under the system's Program Files. The in-product update flow will also require elevation, making it less streamlined than the user setup. On the other hand, installing VS Code using the system setup means that it will be available to all users in the system.
42+
1. Once it is downloaded, run the installer (VSCodeUserSetup-{version}.exe)
43+
44+
By default, VS Code is installed under `C:\Users\{Username}\AppData\Local\Programs\Microsoft VS Code`.
45+
46+
> [!TIP]
47+
> Setup adds Visual Studio Code to your `%PATH%` environment variable, to let you type 'code .' in the console to open VS Code on that folder. You need to restart your console after the installation for the change to the `%PATH%` environmental variable to take effect.
48+
49+
### Use the ZIP file
50+
51+
1. Download the [Visual Studio Code Zip archive](/docs/?dv=winzip)
52+
53+
1. Extract the Zip archive, and run VS Code from there
54+
55+
## User setup versus system setup
56+
57+
VS Code provides both Windows **user** and **system** level setups.
58+
59+
| Setup Type | Description |
60+
|------------|-------------|
61+
| [User setup](https://go.microsoft.com/fwlink/?LinkID=534107) | Does not require administrator privileges to run, as the location is under your user Local AppData (`LOCALAPPDATA`) folder. Since it requires no elevation, the user setup is able to provide a smoother background update experience.<br/>This is the preferred way to install VS Code on Windows. <br/> **Note:** When running VS Code as Administrator in a user setup installation, updates are disabled. |
62+
| [System setup](https://go.microsoft.com/fwlink/?linkid=852157) | Requires elevation to administrator privileges to run and places the installation under the system's `Program Files`. The in-product update flow also requires elevation, making it less streamlined than the user setup. On the other hand, installing VS Code using the system setup means that it is available to all users in the system. |
3163

3264
See the [Download Visual Studio Code](/download) page for a complete list of available installation options.
3365

3466
## Updates
3567

3668
VS Code ships monthly [releases](/updates) and supports auto-update when a new release is available. If you're prompted by VS Code, accept the newest update and it will be installed (you won't need to do anything else to get the latest bits).
3769

38-
>**Note:** You can [disable auto-update](/docs/supporting/faq.md#how-do-i-opt-out-of-vs-code-autoupdates) if you prefer to update VS Code on your own schedule.
70+
> [!NOTE]
71+
> You can [disable auto-update](/docs/supporting/faq.md#how-do-i-opt-out-of-vs-code-autoupdates) if you prefer to update VS Code on your own schedule.
3972
40-
## Windows Subsystem for Linux
73+
## Windows as a developer machine
4174

42-
Windows is a popular operating system and it can be a great cross-platform development environment. This section describes cross-platform features such as the [Windows Subsystem for Linux](https://learn.microsoft.com/windows/wsl/install) (WSL) and the new Windows Terminal.
75+
Windows is a popular operating system and it can also be a great cross-platform development environment. This section describes cross-platform features such as the [Windows Subsystem for Linux](https://learn.microsoft.com/windows/wsl/install) (WSL) and the Windows Terminal.
4376

44-
### Recent Windows build
77+
> [!NOTE]
78+
> Make sure you are on a recent Windows build. Check **Settings** > **Windows Update** to see if you are up-to-date.
4579
46-
Make sure you are on a recent Windows 10 build. Check **Settings** > **Windows Update** to see if you are up-to-date.
80+
### Windows Subsystem for Linux
4781

48-
### Windows as a developer machine
49-
50-
With WSL, you can install and run Linux distributions on Windows. This enables you to develop and test your source code on Linux while still working locally on your Windows machine.
82+
With WSL, you can install and run Linux distributions on Windows to develop and test your source code on Linux, while still working locally on your Windows machine.
5183

5284
When coupled with the [WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) extension, you get full VS Code editing and debugging support while running in the context of WSL.
5385

54-
See the [Developing in WSL](/docs/remote/wsl.md) documentation to learn more or try the [Working in WSL](/docs/remote/wsl-tutorial.md) introductory tutorial.
86+
See the [Developing in WSL](/docs/remote/wsl.md) documentation to learn more, or try the [Working in WSL](/docs/remote/wsl-tutorial.md) introductory tutorial.
5587

56-
### New Windows Terminal
88+
### Windows Terminal
5789

58-
Available from the Microsoft Store, the [Windows Terminal (Preview)](https://www.microsoft.com/p/windows-terminal-preview/9n0dx20hk701?SilentAuth=1&wa=wsignin1.0&activetab=pivot%3Aoverviewtab) lets you easily open PowerShell, Command Prompt, and WSL terminals in a multiple tab shell.
90+
The [Windows Terminal](https://apps.microsoft.com/detail/9n0dx20hk701), available from the Microsoft Store, is a terminal application for users of command-line tools and shells like Command Prompt, PowerShell, and WSL. Its main features include multiple tabs, panes, Unicode and UTF-8 character support, a GPU accelerated text rendering engine, and custom themes, styles, and configurations.
5991

6092
## Next steps
6193

62-
Once you have installed VS Code, these topics will help you learn more about VS Code:
94+
Once you have installed VS Code, these topics will help you learn more about it:
6395

64-
* [Additional Components](/docs/setup/additional-components.md) - Learn how to install Git, Node.js, TypeScript, and tools like Yeoman.
65-
* [User Interface](/docs/getstarted/userinterface.md) - A quick orientation to VS Code.
66-
* [User/Workspace Settings](/docs/getstarted/settings.md) - Learn how to configure VS Code to your preferences through settings.
67-
* [Tips and Tricks](/docs/getstarted/tips-and-tricks.md) - Lets you jump right in and learn how to be productive with VS Code.
96+
* [VS Code tutorial](/docs/getstarted/getting-started.md) - A quick hands-on tour of the key features of VS Code.
97+
* [Tips and Tricks](/docs/getstarted/tips-and-tricks.md) - A collection of productivity tips for working with VS Code.
98+
* [AI-assisted coding](/docs/copilot/overview.md) - Learn about using GitHub Copilot in VS Code to help you write code faster.
6899

69100
## Common questions
70101

@@ -75,34 +106,12 @@ for Windows. Thus, all the [Inno Setup command-line switches](https://www.jrsoft
75106

76107
Additionally, you can prevent the Setup from launching VS Code after completion with `/mergetasks=!runcode`.
77108

78-
### Scrolling is laggy and not smooth
79-
80-
On certain devices, editor scrolling is not smooth but laggy for an unpleasant experience. If you notice this issue, make sure you install the Windows 10 October 2018 update where this issue is fixed.
81-
82109
### I'm having trouble with the installer
83110

84111
Try using the [zip file](/docs/?dv=winzip) instead of the installer. To use this, unzip VS Code in your `AppData\Local\Programs` folder.
85112

86-
>**Note:** When VS Code is installed via a Zip file, you will need to manually update it for each [release](/updates).
87-
88-
### Icons are missing
89-
90-
I installed Visual Studio Code on my Windows 8 machine. Why are some icons not appearing in the workbench and editor?
91-
92-
VS Code uses [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icons and we have found instances where the .SVG file extension is associated with something other than `image/svg+xml`. We're considering options to fix it, but for now here's a workaround:
93-
94-
Using the Command Prompt:
95-
96-
1. Open an Administrator Command Prompt.
97-
2. Type `REG ADD HKCR\.svg /f /v "Content Type" /t REG_SZ /d image/svg+xml`.
98-
99-
Using the Registry Editor (regedit):
100-
101-
1. Start `regedit`.
102-
2. Open the `HKEY_CLASSES_ROOT` key.
103-
3. Find the `.svg` key.
104-
4. Set its `Content Type` Data value to `image/svg+xml`.
105-
5. Exit `regedit`.
113+
> [!NOTE]
114+
> When VS Code is installed via a Zip file, you will need to manually update it for each [release](/updates).
106115
107116
### Unable to run as admin when AppLocker is enabled
108117

@@ -122,13 +131,17 @@ Subscribe to [issue #122951](https://github.com/microsoft/vscode/issues/122951)
122131

123132
### Working with UNC paths
124133

125-
Beginning with version `1.78.1`, VS Code on Windows will only allow to access UNC paths (these begin with a leading `\\`) that were either approved by the user on startup or where the host name is configured to be allowed via the new `setting(security.allowedUNCHosts)` setting.
134+
As of version `1.78.1`, VS Code on Windows only allows access to UNC paths (these begin with a leading `\\`) that were either approved by the user on startup or where the host name is configured to be allowed via the `setting(security.allowedUNCHosts)` setting.
135+
136+
If you rely on using UNC paths in VS Code, you can either:
137+
138+
* Configure the host to be allowed via the `setting(security.allowedUNCHosts)` setting. For example, add `server-a` when you open a path such as `\\server-a\path`.
139+
140+
* [Map the UNC path as a network drive](https://support.microsoft.com/en-us/windows/map-a-network-drive-in-windows-29ce55d1-34e3-a7e2-4801-131475f9557d), and use the drive letter instead of the UNC path.
126141

127-
If you rely on using UNC paths in VS Code, you can either
128-
* configure the host to be allowed via the `setting(security.allowedUNCHosts)` setting (for example add `server-a` when you open a path such as `\\server-a\path`)
129-
* map the UNC path as network drive and use the drive letter instead of the UNC path ([documentation](https://support.microsoft.com/en-us/windows/map-a-network-drive-in-windows-29ce55d1-34e3-a7e2-4801-131475f9557d))
130-
* define a global environment variable `NODE_UNC_HOST_ALLOWLIST` with the backslash-separated list of hostnames to allow, for example: `server-a\server-b` to allow the hosts `server-a` and `server-b`.
142+
* Define a global environment variable `NODE_UNC_HOST_ALLOWLIST` with the backslash-separated list of host names to allow. For example, `server-a\server-b` to allow the hosts `server-a` and `server-b`.
131143

132-
*Note:* if you are using any of the remote extensions to connect to a workspace remotely (such as SSH), the `setting(security.allowedUNCHosts)` has to be configured on the remote machine and not the local machine.
144+
> [!NOTE]
145+
> If you are using any of the remote extensions to connect to a workspace remotely (such as SSH), the `setting(security.allowedUNCHosts)` has to be configured on the remote machine and not the local machine.
133146
134147
This change was done to improve the security when using VS Code with UNC paths. Please refer to the associated [security advisory](https://github.com/microsoft/vscode/security/advisories/GHSA-mmfh-4pv3-39hr) for more information.

0 commit comments

Comments
 (0)