|
1 | 1 | # Windows Installation |
2 | 2 |
|
3 | | -## Supported OS versions: |
| 3 | +## Requirements |
| 4 | + |
| 5 | +### Supported OS Versions |
| 6 | +mssql-cli is supported on Windows with: |
4 | 7 | * Windows (x86/x64) 8.1 |
5 | 8 | * Windows (x86/x64) 10 |
6 | 9 | * Windows Server 2012+ |
7 | 10 |
|
| 11 | +### Python Installation |
| 12 | + |
8 | 13 | Python is required for installation of mssql-cli and is not installed by default on Windows. To install Python, follow these instructions: |
9 | 14 | 1. Open the latest Python installer package from [here](https://www.python.org/downloads/). |
10 | 15 | 2. Select **Add Python [Version] to PATH** option before installation. Python must be in the PATH environment variable. |
11 | 16 | 3. Install Python. |
12 | 17 |
|
13 | | -**Note:** If Python was installed into the "Program Files" directory, you may need to open the command prompt as an administrator for the above command to succeed. |
| 18 | +> If Python was installed into the "Program Files" directory, you may need to open the command prompt as an administrator for the above command to succeed. |
14 | 19 |
|
15 | | -Once Python is installed and in the PATH environment variable, open a command prompt, and install mssql-cli using the below command. |
| 20 | +Proceed to the next section once Python is installed and in the PATH environment variable. |
16 | 21 |
|
17 | | -## Installation via pip |
18 | | -```shell |
19 | | -C:\> pip install mssql-cli |
20 | | -``` |
21 | | -Or, use the following command if you encounter a launcher error: |
22 | | -```shell |
23 | | -C:\> python -m pip install mssql-cli |
24 | | -``` |
| 22 | +## Installing mssql-cli |
| 23 | +> Note: your path to Python may be different from the listed command. For example, instead of `python` you may need to call `python3`. |
25 | 24 |
|
26 | | -## Installation with daily preview build |
27 | | -Daily preview builds are dropped in our storage account. To install the latest available version of mssql-cli, use the below command: |
28 | | -```shell |
29 | | -C:\> pip install --pre --no-cache --extra-index-url https://mssqlcli.blob.core.windows.net/daily/whl mssql-cli |
| 25 | +mssql-cli is installed using `pip` on Windows: |
| 26 | +```sh |
| 27 | +python -m pip install mssql-cli |
30 | 28 | ``` |
31 | 29 |
|
32 | | -## Uninstallation via pip |
33 | | -```shell |
34 | | -C:\> pip uninstall mssql-cli |
| 30 | +## Uninstalling mssql-cli |
| 31 | +Uninstall mssql-cli using `pip`: |
| 32 | +```sh |
| 33 | +pip uninstall mssql-cli |
35 | 34 | ``` |
36 | 35 |
|
37 | | -## Installation behind a proxy |
| 36 | +## Installation Behind a Proxy |
38 | 37 | Set two environment variables: |
39 | | -```shell |
40 | | -C:\>set http_proxy=domain\username:password@proxy_server:port |
41 | | -C:\>set https_proxy=domain\username:password@proxy_server:port |
| 38 | +```sh |
| 39 | +set http_proxy=domain\username:password@proxy_server:port |
| 40 | +set https_proxy=domain\username:password@proxy_server:port |
42 | 41 | ``` |
43 | | -If the Password contains special characters like @,$,! (e.g. Password: P@ssword) then replace the special characters by their hex code equivalents with % prefix like this: |
44 | | -@==>%40 |
45 | | -$==>%24 |
46 | | -!==>%21 |
47 | | -Example: username:p%40ssword@proxy_server:port |
| 42 | +If the Password contains special characters like `@,$,!` (e.g. `password:p@ssword`) then replace the special characters by their hex code equivalents with `%` prefix, as exemplified below: |
| 43 | +* `@`: `%40` |
| 44 | +* `$`: `%24` |
| 45 | +* `!`: `%21` |
| 46 | + |
| 47 | +Example: `username:p%40ssword@proxy_server:port` |
48 | 48 |
|
49 | | -after this steps try install again |
| 49 | +You may attempt installation after completing these steps: |
50 | 50 |
|
51 | | -```shell |
52 | | -C:\>pip install mssql-cli |
| 51 | +```sh |
| 52 | +pip install mssql-cli |
53 | 53 | ``` |
0 commit comments