Skip to content

docs: trim the README's install methods #292

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
pjcdawkins merged 3 commits into from
Nov 2, 2026
Merged

docs: trim the README's install methods #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f806160
docs: trim the README's install methods
pjcdawkins Nov 2, 2026
35e6204
docs: note the npm package's requirements in docs/install.md
pjcdawkins Nov 2, 2026
323e5c9
docs: link to the npm package's requirements from the README
pjcdawkins Nov 2, 2026
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
12 changes: 3 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The command-line interface for [Upsun](https://upsun.com).

Use it to manage Upsun projects from the terminal: create and branch environments, deploy with Git, SSH into apps, view logs, open tunnels to services, and manage backups, variables, domains and users.
Use it to manage Upsun projects from the terminal: generate and validate project configuration, create and branch environments, deploy with Git, SSH into apps, view logs, open tunnels to services, and manage backups, variables, domains and users.

## Install

Expand Down Expand Up @@ -36,26 +36,20 @@ brew install upsun/tap/upsun-cli

### npm

If you have Node.js 18 or later, you can install the CLI with npm:

```console
npm install -g upsun
```

There is no npm build for 32-bit Linux or Windows on ARM. npm installs don't set up shell completion.

### Nix profile
npm installs don't set up shell completion. For the package's requirements, see [docs/install.md](docs/install.md#npm).

Refer to the [Nix documentation if you are not on NixOS](https://nix.dev/manual/nix/2.24/installation/installing-binary.html).
### Nix

```console
nix profile install nixpkgs#upsun
```

### Docker

The CLI is also available as a Docker image:

```console
docker run --rm -it ghcr.io/upsun/cli
```
Expand Down
4 changes: 4 additions & 0 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,7 @@ To upgrade:
```console
sudo dnf upgrade -y upsun-cli
```

## npm

The npm package needs Node.js 18 or later. It has builds for Linux (x64 and arm64), macOS, and Windows (x64), so not for 32-bit Linux or Windows on ARM.
Loading