From 384cf49337cd215eefc20140e443b5bc7c886dad Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Thu, 16 Sep 2021 10:03:51 +0100 Subject: [PATCH] docs: cli: add information about coder update command (#606) * docs: cli: add information about coder update * fixup! docs: cli: add information about coder update * condense instructions * Apply suggestions from code review Co-authored-by: Katie Horne --- cli/installation.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/cli/installation.md b/cli/installation.md index a08417a9a..198a7ccc5 100644 --- a/cli/installation.md +++ b/cli/installation.md @@ -55,3 +55,20 @@ Generate a static authentication token with the following command: ```console coder tokens create my-token ``` + +## Update + +To update the CLI to the version corresponding to your current Coder deployment, +run (you will be asked to confirm all changes before they're performed): + +```console +coder update +``` + +The `coder update` command accepts the following arguments: + +- `--coder`: specify the Coder instance the CLI should use to query the version +- `--version`: specify the version that the CLI should download and upgrade to +- `--force`: omit prompts asking for change confirmations + +**Note:** Coder CLI will not update if it is located under `/var/tmp/coder` or `C:\Windows`.