Skip to content

docs: tell partner CLI users to upgrade with their partner installer #198

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

Open
vrobert78 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: tell partner CLI users to upgrade with their partner installer #198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,12 @@ docker run --rm -it ghcr.io/upsun/cli

## Upgrade

> [!NOTE]
> **Using a partner's branded CLI?** If you installed it from a partner installer
> (`https://cli.<partner>/installer`), upgrade it by running that installer again:
> `curl -fsSL https://cli.<partner>/installer | sh`. Your provider's documentation

@upsun-dispatch upsun-dispatch Bot Oct 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Warning — Partner users may end up with a second binary and an old CLI still on PATH.

The note tells partner users to run curl -fsSL https://cli.<partner>/installer | sh with no settings. A partner installer built from installer.sh then picks its own method and folder. On Linux it picks apt, yum or apk when one is present, and on macOS it picks Homebrew. Its install folder defaults to /usr/bin or ~/.local/bin (check_install_method/check_directories).

  • A user who first installed with a custom INSTALL_DIR ends up with a second copy elsewhere. The old binary they actually run is not upgraded.
  • If the partner didn't change BREW_TAP, package and the repository URLs, the apt or Homebrew path installs upsun-cli from Upsun's sources. That is the same problem the PR describes.

The CLI's own tailored command (upgradeCommandFor, commands/root.go:270-272) adds INSTALL_METHOD=raw INSTALL_DIR=<dir of current binary> for exactly this reason, as its comment says. The note leaves both out.

> has the exact URL. The commands below upgrade the Upsun CLI, not a partner CLI.

Upgrade using the same tool:

### HomeBrew
Expand All @@ -140,6 +146,8 @@ scoop update upsun

### Bash installer

This upgrades the Upsun CLI. A partner CLI is upgraded with its own installer (see the note above).

```console
curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash
```
Expand Down
Loading