Install the Upsun CLI

Install

macOS (Homebrew)
Linux
Windows (Scoop)

Trust the Upsun tap, then install:

  brew install upsun/tap/upsun-cli

  curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash

Install the Scoop Extras bucket before proceeding:

  scoop bucket add extras

Then add the Upsun bucket and install the CLI:

  scoop bucket add upsun https://github.com/upsun/homebrew-tap.git
  scoop install upsun

To verify the installation, run:

upsun --version

Authenticate

Run the following command to authenticate and to manage your projects:

upsun

This command opens a browser tab for you to log in. It also creates certificates on your computer for SSH. After logging in, you see a list of your projects and tips for getting started. If you experience authentication issues or want to force a login, run upsun login. To install and authenticate the CLI in a CI system or app container using a build hook, see Authenticate using an API token.

Update the CLI

To update the CLI, run the appropriate command for your platform:

Homebrew
Linux
Scoop

  brew upgrade upsun-cli

  curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash

  scoop update upsun

Upgrade from the legacy CLI

Follow the installation instructions above. Once installed, the CLI guides you through removing the legacy CLI.

Getting started

Reference

Install

Authenticate

Update the CLI

Upgrade from the legacy CLI

​Install

​Authenticate

​Update the CLI

​Upgrade from the legacy CLI

Install

Authenticate

Update the CLI

Upgrade from the legacy CLI