Skip to content

docs: document local install.sh script #16125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 21, 2025
Merged

docs: document local install.sh script #16125

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5d32ddd
docs: document local install.sh script
aslilac Jan 13, 2025
b80b3bf
>:(
aslilac Jan 13, 2025
753e258
Update docs/install/cli.md
aslilac Jan 15, 2025
7e7d0d6
Update docs/install/cli.md
aslilac Jan 15, 2025
3f0f460
Update docs/install/cli.md
aslilac Jan 15, 2025
7de4be8
Merge remote-tracking branch 'origin/main' into lilac/docs-local-inst…
EdwardAngert Jan 17, 2025
909d27c
Apply suggestions from code review
EdwardAngert Jan 21, 2025
46be360
minor tweaks
aslilac Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/install/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ A single CLI (`coder`) is used for both the Coder server and the client.
We support two release channels: mainline and stable - read the
[Releases](./releases.md) page to learn more about which best suits your team.

## Download the latest release from GitHub

<div class="tabs">

## Linux/macOS
Expand Down Expand Up @@ -54,6 +56,27 @@ To log in to an existing Coder deployment:
coder login https://coder.example.com
```

## Download the CLI from your deployment

<blockquote class="admonition note">

Available in Coder 2.19 and newer.

</blockquote>

Every Coder server hosts CLI binaries for all supported platforms. You can run a
script to download the appropriate CLI for your machine from your Coder
deployment.

```sh
curl -L https://coder.example.com/install.sh | sh
```

This script works within air-gapped deployments and ensures that the version of
the CLI you have installed on your machine matches the version of the server.

This script can be useful when authoring a template for installing the CLI.

### Next up

- [Create your first template](../tutorials/template-from-scratch.md)
Expand Down
Loading