Skip to content

Commit ac842ea

Browse files
johnstcnKatie Horne
and
Katie Horne
authored
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 <katie@coder.com>
1 parent 3706fa9 commit ac842ea

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

cli/installation.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,20 @@ Generate a static authentication token with the following command:
5555
```console
5656
coder tokens create my-token
5757
```
58+
59+
## Update
60+
61+
To update the CLI to the version corresponding to your current Coder deployment,
62+
run (you will be asked to confirm all changes before they're performed):
63+
64+
```console
65+
coder update
66+
```
67+
68+
The `coder update` command accepts the following arguments:
69+
70+
- `--coder`: specify the Coder instance the CLI should use to query the version
71+
- `--version`: specify the version that the CLI should download and upgrade to
72+
- `--force`: omit prompts asking for change confirmations
73+
74+
**Note:** Coder CLI will not update if it is located under `/var/tmp/coder` or `C:\Windows`.

0 commit comments

Comments
 (0)