Reformats every Markdown page under `docs/install` to the [one-sentence-per-line convention](https://github.com/coder/coder/blob/main/docs/.style/style-guide/formatting.md#one-sentence-per-line). Addresses DOCS-668. This is a source-layout change only: 28 of the 36 pages change, and rendered HTML is identical for all of them except three wording fixes. Three pre-existing em dashes sat on reflowed lines, which `lint/emdash` flags as new, so they're rewritten with commas or a sentence break (`operate/upgrade/esr-2.24-2.29-upgrade.md`, `operate/upgrade/best-practices.md`). Front matter, fenced code, tables, HTML blocks, and headings are untouched. `Coder.OneSentencePerLine` is not enabled for `docs/install` in `.vale.ini`: the 39 remaining findings are all table rows or code, which the guide puts out of scope, and enabling the rule would break the zero-baseline doctrine. <details> <summary>Implementation and verification notes</summary> **Approach.** A throwaway script reflowed each paragraph. Bullet items, numbered entries, and blockquote lines (including `> [!NOTE]` callouts) are each their own paragraph; extra sentences in a list item continue on indented lines, matching `docs/.style/content-guidelines.md`. Sentence breaks are never inserted inside inline code, link text, URLs, or HTML tags, and abbreviations such as `e.g.` and `etc.` don't count as sentence ends. Images that started their own source line stay on their own line. The script is idempotent: a second pass produces no changes. **Merge with main.** `main` restructured `docs/install` into plan, prepare, server, validate, and operate sections after this branch was cut. The merge takes `main`'s tree and re-runs the reflow over every page now under `docs/install`, so the branch diff against `main` is reflow only. `releases/index.md` and `releases/feature-stages.md` moved out of `docs/install` on `main` and are no longer in scope. **Verification.** - Rendered every page with `marked` from `main` and from this branch and compared normalized HTML: identical except the three em-dash rewrites. - Vale with `Coder.OneSentencePerLine` forced on for `docs/install`: 277 findings on `main`, 39 on this branch, all in table rows or fenced code. - A broader sweep for mid-line sentence boundaries and for false splits (lines starting lowercase, lines ending in an abbreviation) found no prose hits. - `markdownlint-cli2`, `markdown-table-formatter --check`, `make lint/emdash`, and `make pre-commit-light` pass. </details> --- *Generated by Coder Agents on behalf of @ianjevans.*
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
---
|
|
title: Install the Coder CLI
|
|
---
|
|
|
|
A single CLI (`coder`) is used for both the control plane and the client.
|
|
|
|
We support two release channels: mainline and stable - read the [Releases](../reference/releases.md) page to learn more about which best suits your team.
|
|
|
|
## Download the latest release from GitHub
|
|
|
|
<div class="tabs">
|
|
|
|
## Linux/macOS
|
|
|
|
Our install script is the fastest way to install Coder on Linux/macOS:
|
|
|
|
```sh
|
|
curl -fsSL https://coder.com/install.sh | sh
|
|
```
|
|
|
|
Refer to [GitHub releases](https://github.com/coder/coder/releases) for alternate installation methods (e.g. standalone binaries, system packages).
|
|
|
|
To run the Coder control plane on a Red Hat Enterprise Linux host or another RHEL-family distribution, refer to [Install Coder on RHEL-family Linux](./server/rpm.md).
|
|
|
|
## Windows
|
|
|
|
If you plan to use the built-in PostgreSQL database, ensure that the [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) is installed.
|
|
|
|
Use [GitHub releases](https://github.com/coder/coder/releases) to download the Windows installer (`.msi`) or standalone binary (`.exe`).
|
|
|
|

|
|
|
|
Alternatively, you can use the [`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget) package manager to install Coder:
|
|
|
|
```ps1
|
|
winget install Coder.Coder
|
|
```
|
|
|
|
</div>
|
|
|
|
To start the control plane:
|
|
|
|
```sh
|
|
coder server
|
|
```
|
|
|
|

|
|
|
|
To log in to an existing Coder deployment:
|
|
|
|
```sh
|
|
coder login https://coder.example.com
|
|
```
|
|
|
|
## Download the CLI from your deployment
|
|
|
|
> [!NOTE]
|
|
> Available in Coder 2.19 and newer on macOS and Linux clients only.
|
|
|
|
Every control plane hosts CLI binaries for all supported platforms.
|
|
You can run a script to download the appropriate CLI for your machine from your Coder deployment.
|
|
|
|

|
|
|
|
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 control plane.
|
|
|
|
This script can be useful when authoring a template for installing the CLI.
|
|
|
|
### Next up
|
|
|
|
- [Create your first template](../tutorials/template-from-scratch.md)
|
|
- [Control plane configuration](../admin/setup/index.md)
|