Skip to content

Lightweight brand updates for install docs #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

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

Lightweight brand updates for install docs #292

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
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To install the CLI, use either [Homebrew](https://brew.sh/) (on Linux, macOS, or
### HomeBrew

```console
brew install platformsh/tap/platformsh-cli
brew install platformsh/tap/upsun-cli
```

> If you have issues with missing libraries on a Mac, see how to [troubleshoot CLI installation on M1/M2 Macs](https://community.platform.sh/t/troubleshoot-cli-installation-on-m1-macs/1202).
Expand All @@ -22,15 +22,15 @@ brew install platformsh/tap/platformsh-cli

```console
scoop bucket add platformsh https://github.com/platformsh/homebrew-tap.git
scoop install platform
scoop install upsun
```

### Bash installer

Use the bash installer for an automated installation, using the most preferable way for your system.

```console
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | bash
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | VENDOR=upsun bash
```

The installer is configurable using the following environment variables:
Expand All @@ -56,19 +56,19 @@ nix profile install nixpkgs#upsun
<details>
<summary>Force the CLI to be installed using the raw method</summary>

curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | INSTALL_METHOD=raw bash
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | VENDOR=upsun INSTALL_METHOD=raw bash
</details>

<details>
<summary>Install a specific version</summary>

curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | VERSION=4.0.1 bash
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | VENDOR=upsun VERSION=4.0.1 bash
</details>

<details>
<summary>Install the CLI in a user owned directory</summary>

curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | INSTALL_METHOD=raw INSTALL_DIR=$HOME/.local/bin bash
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | VENDOR=upsun INSTALL_METHOD=raw INSTALL_DIR=$HOME/.local/bin bash
</details>

### Alpine
Expand All @@ -92,7 +92,7 @@ curl -1sLf \

```console
# Install the CLI
apk add platformsh-cli
apk add upsun-cli
```

### Ubuntu/Debian
Expand Down Expand Up @@ -123,7 +123,7 @@ curl -1sLf \

```console
# Install the CLI
apt-get install -y platformsh-cli
apt-get install -y upsun-cli
```

### CentOS/RHEL/Fedora
Expand All @@ -134,7 +134,7 @@ curl -1sLf \
| sudo -E bash

# Install the CLI
yum install -y platformsh-cli
yum install -y upsun-cli
```

### Manual installation
Expand All @@ -148,37 +148,37 @@ Upgrade using the same tool:
### HomeBrew

```console
brew update && brew upgrade platformsh/tap/platformsh-cli
brew update && brew upgrade platformsh/tap/upsun-cli
```

### Scoop

```console
scoop update platform
scoop update upsun
```

### Bash installer

```console
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | bash
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | VENDOR=upsun bash
```

### Alpine

```console
apk add -l platformsh-cli
apk add -l upsun-cli
```

### Ubuntu/Debian

```console
apt-get upgrade platformsh-cli
apt-get upgrade upsun-cli
```

### CentOS/RHEL/Fedora

```console
yum upgrade -y platformsh-cli
yum upgrade -y upsun-cli
```

## Under the hood
Expand Down