Skip to content

Commit 7b76721

Browse files
authored
Add guide on how to install the CLI on a Win10 machine (#1476)
1 parent bd0cfb6 commit 7b76721

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

docs/guides/windows-cli.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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+
![step-3a](https://user-images.githubusercontent.com/26958764/96926494-493cdf80-14be-11eb-9fac-4c81e1fac55c.png)
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+
![step-3b](https://user-images.githubusercontent.com/26958764/96926763-adf83a00-14be-11eb-9584-4eff3faf2377.png)
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+
![step-5](https://user-images.githubusercontent.com/26958764/96927485-ca48a680-14bf-11eb-909c-f15dbc52af08.png)

docs/miscellaneous/cli.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ pip install cortex
1010

1111
## Install the CLI without Python Client
1212

13+
### Mac/Linux OS
14+
1315
```bash
1416
# Replace `INSERT_CORTEX_VERSION` with the complete CLI version (e.g. 0.18.1):
1517
$ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/vINSERT_CORTEX_VERSION/get-cli.sh)"
@@ -18,6 +20,10 @@ $ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/vINSER
1820
$ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/v0.18.1/get-cli.sh)"
1921
```
2022

23+
### Windows
24+
25+
To install the Cortex CLI on a Windows machine, follow [this guide](../guides/windows-cli.md).
26+
2127
## Command overview
2228

2329
### deploy

docs/summary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@
7272
* [Single node deployment](guides/single-node-deployment.md)
7373
* [Set up kubectl](guides/kubectl-setup.md)
7474
* [Private docker registry](guides/private-docker.md)
75+
* [Install CLI on Windows](guides/windows-cli.md)
7576

7677
## Contributing
7778

0 commit comments

Comments
 (0)