From 8a17e4d883d1edb7476df52a48db891729dd1554 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 27 Jan 2022 09:21:23 -0600 Subject: [PATCH 1/4] update Windows installation --- cli/installation.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/cli/installation.md b/cli/installation.md index e83c5ddf6..e8cf57417 100644 --- a/cli/installation.md +++ b/cli/installation.md @@ -23,15 +23,25 @@ version number. brew install cdr/coder/coder-cli ``` -### Download (Windows, Linux, Mac) +### Download (Linux, Mac) Download releases [from GitHub](https://github.com/coder/coder-cli/releases): 1. Click a release and download the tar file for your operating system (ex: - coder-cli-linux-amd64.tar.gz) + `coder-cli-linux-amd64.tar.gz`) 1. Extract the `coder` binary and copy it to a location you've added to your `PATH` environment variable +### Download (Windows) + +1. Click a release (e.g., `coder-cli-windows.zip`) and download the file +1. Unzip the file +1. Copy the file to `%USERPROFILE%\bin` +1. On the command-line interface, execute `coder.exe login` + +> Make sure that you have a user variable `PATH` that's set to +> `%USERPROFILE%\bin`. + ## Authenticate Once you've installed the CLI, authenticate the client with your Coder account. From ddacc400c1c70c2c594c4e14eee19d0390bb3768 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 27 Jan 2022 09:55:14 -0600 Subject: [PATCH 2/4] chore: apply suggestions from review Co-authored-by: Cian Johnston --- cli/installation.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/cli/installation.md b/cli/installation.md index e8cf57417..5ab3c1a64 100644 --- a/cli/installation.md +++ b/cli/installation.md @@ -36,10 +36,11 @@ Download releases [from GitHub](https://github.com/coder/coder-cli/releases): 1. Click a release (e.g., `coder-cli-windows.zip`) and download the file 1. Unzip the file -1. Copy the file to `%USERPROFILE%\bin` +1. Copy the file to a location of your choosing (for example, `%USERPROFILE%\bin`). 1. On the command-line interface, execute `coder.exe login` -> Make sure that you have a user variable `PATH` that's set to +> Make sure that your user's `PATH` environment variable +> contains the location you chose. > `%USERPROFILE%\bin`. ## Authenticate From 9d9e4bdb5d4f0b45177d13131892efef6ed97bdc Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 27 Jan 2022 09:55:51 -0600 Subject: [PATCH 3/4] chore: clarify PATH --- cli/installation.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/cli/installation.md b/cli/installation.md index 5ab3c1a64..0a5168791 100644 --- a/cli/installation.md +++ b/cli/installation.md @@ -36,12 +36,11 @@ Download releases [from GitHub](https://github.com/coder/coder-cli/releases): 1. Click a release (e.g., `coder-cli-windows.zip`) and download the file 1. Unzip the file -1. Copy the file to a location of your choosing (for example, `%USERPROFILE%\bin`). +1. Copy the file to a location of your choosing (e.g., `%USERPROFILE%\bin`). 1. On the command-line interface, execute `coder.exe login` > Make sure that your user's `PATH` environment variable -> contains the location you chose. -> `%USERPROFILE%\bin`. +> contains the location you chose in step 3. ## Authenticate From fea001fa040598c5db9162e4ab984f12026952be Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 27 Jan 2022 10:29:04 -0600 Subject: [PATCH 4/4] chore: lint --- cli/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/installation.md b/cli/installation.md index 0a5168791..d0d0c377b 100644 --- a/cli/installation.md +++ b/cli/installation.md @@ -39,8 +39,8 @@ Download releases [from GitHub](https://github.com/coder/coder-cli/releases): 1. Copy the file to a location of your choosing (e.g., `%USERPROFILE%\bin`). 1. On the command-line interface, execute `coder.exe login` -> Make sure that your user's `PATH` environment variable -> contains the location you chose in step 3. +> Make sure that your user's `PATH` environment variable contains the location +> you chose in step 3. ## Authenticate