|
| 1 | +# Install CLI on Windows |
| 2 | + |
| 3 | +_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_ |
| 4 | + |
| 5 | +This guide walks you through installing the Cortex CLI on a Windows 10 machine using the Linux Subsystem. |
| 6 | + |
| 7 | +The requirement is an x64 system with Windows 10 of **Version 1903** or higher, with **Build 18362** or higher. |
| 8 | + |
| 9 | +## Step 1 |
| 10 | + |
| 11 | +Install and configure the WSL (Windows Subsystem for Linux) version 2 on your machine following [this installation guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10). |
| 12 | + |
| 13 | +In our example, we assume the installation of the Ubuntu distribution. |
| 14 | + |
| 15 | +## Step 2 |
| 16 | + |
| 17 | +Install and configure the Docker Desktop Engine app to use WSL 2 as its backend by following the setps in the [Docker Desktop WSL 2 backend guide](https://docs.docker.com/docker-for-windows/wsl/). |
| 18 | + |
| 19 | +## Step 3 |
| 20 | + |
| 21 | +Run Ubuntu in the terminal on your Windows machine and right-click the window's bar and click on *Properties*: |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +In the *Font* category, set the font to one of the following fonts: **SimSun-ExtB** (recommended), **MS Gothic**, or **NSimSun**. Choosing one of these fonts helps render all Unicode characters correctly. Once selected, click *Okay*. |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +## Step 4 |
| 30 | + |
| 31 | +Within the Ubuntu terminal, install the Cortex CLI as you would on a Mac/Linux machine: |
| 32 | + |
| 33 | +### Install the CLI with Python Client |
| 34 | + |
| 35 | +```bash |
| 36 | +pip install cortex |
| 37 | +``` |
| 38 | + |
| 39 | +### Install the CLI without Python Client |
| 40 | + |
| 41 | +```bash |
| 42 | +# Replace `INSERT_CORTEX_VERSION` with the complete CLI version (e.g. 0.18.1): |
| 43 | +$ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/vINSERT_CORTEX_VERSION/get-cli.sh)" |
| 44 | + |
| 45 | +# For example to download CLI version 0.18.1 (Note the 'v'): |
| 46 | +$ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/v0.18.1/get-cli.sh)" |
| 47 | +``` |
| 48 | + |
| 49 | +## Step 5 |
| 50 | + |
| 51 | +Start using the Cortex CLI. The CLI commands are documented [here](../miscellaneous/cli.md#command-overview). |
| 52 | + |
| 53 | + |
0 commit comments