> For the complete documentation index, see [llms.txt](https://gigi206.gitbook.io/vscode-anywhere/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gigi206.gitbook.io/vscode-anywhere/install/advanced/windows-installation.md).

# Windows installation

## Installation

VSCode-Anywhere has been tested only with Windows 10 but it supposed to work also with the recent Windows version.

To install VSCode-Anywhere on Windows, you need have to have PowerShell installed.

Installation example:

{% tabs %}
{% tab title="Powershell" %}

```
Set-ExecutionPolicy Bypass -Scope Process -Force; Invoke-WebRequest -Uri https://raw.githubusercontent.com/gigi206/VSCode-Anywhere/V2/VSCode-Anywhere.ps1 -OutFile $env:TMP\VSCode-Anywhere.ps1; & $env:TMP\VSCode-Anywhere.ps1 -InstallDir <InstallDir> -Profile windows_user
```

{% endtab %}
{% endtabs %}

### Options

Installation options are:

* **Gitenv** *(optional)*: git branch to use for installation (**V2** by default)
* **InstallDir** *(optional)*: installation directory (`C:\VSCode-Anywhere` by default)
* **SaltVersion** *(optional)*: Saltstack version to use (value evolves with time). It is not recommended to change this value (only for testing purposes for developers).
* **Profile** *(optional)*: type of installation profile (**windows\_user** by default)
* **saltopts** *(optional)*: Salt options

#### Profiles

There are 3 kinds of `profile` (see **Profile** option) for different use cases :

* **windows\_admin**: require administrator rights (for local use)
* **windows\_user**: no administrator rights required (for local use)
* **windows\_portable**: no administrator rights required (for use with a portable device like an USB stick)

| **profile**           | **advantages**                                                                                                                                   | **disadvantages**                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **windows\_admin**    | <ul><li>Few modules need administrator rights for better compatibility (see the documentation of each module)</li><li>Good performance</li></ul> | <ul><li>Some applications will be installed on the system (outside the installation folder <code>InstallDir</code>)</li><li>Not recommended to run on another computer with a portable device like a USB stick (<code>tools/link.ps1</code> may have a high chance to install some missing components)</li><li>Add only a few possibilities, just some modules uses it (see the module documentation for know if it is a requirement)</li></ul> |
| **windows\_user**     | <ul><li>No administrator rights needed for the installation process and modules</li><li>Good performance</li></ul>                               | <ul><li>Not recommended to run on another computer with a portable device like a USB stick (<code>tools/link.ps1</code> may have a low chance to install some missing components)</li></ul>                                                                                                                                                                                                                                                     |
| **windows\_portable** | <ul><li>Can be installed on a portable device like a USB stick</li></ul>                                                                         | <ul><li>Could have performance issue and more possibility to encounter bugs</li></ul>                                                                                                                                                                                                                                                                                                                                                           |