Skip to content
This repository was archived by the owner on Apr 27, 2026. It is now read-only.

Commit 66eae62

Browse files
pjcdawkinsclaude
pjcdawkins
and
claude
authored
docs: trim README to redirect to upsun/cli (#300)
* docs: trim README to redirect to upsun/cli The repository has been migrated to upsun/cli, but the README still duplicated the full install matrix, upgrade instructions, and build commands. Several sections also pointed at the old platformsh/* paths, contradicting the migration banner at the top of the file. Reduce the README to its post-migration job: title, migration banner, one-line description, the bash installer one-liner, a link to upsun/cli for everything else, and the PHP license note. Anything more invites drift between the two repositories. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: document install path for legacy platform binary Customers who depend on the platform binary (rather than upsun) need a clear install path. The upsun/cli installer only installs the upsun binary, so direct them at this repository's installer.sh, which still defaults to the platform binary. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: drop "Legacy" qualifier from platform binary heading The word "Legacy" is overloaded in this codebase — it also refers to github.com/platformsh/legacy-cli, which is a different thing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d61c748 commit 66eae62

1 file changed

Lines changed: 6 additions & 215 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 215 deletions
Original file line numberDiff line numberDiff line change
@@ -3,235 +3,26 @@
33
> [!IMPORTANT]
44
> **This repository has been migrated to [upsun/cli](https://github.com/upsun/cli).**
55
>
6-
> Please use the new repository for all future installations, updates, and issue reporting.
7-
>
8-
> To install the CLI from the new location:
9-
> ```console
10-
> curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash
11-
> ```
12-
>
13-
> Existing installations will continue to work, but we recommend migrating to the new repository.
6+
> Please use the new repository for installations, updates, and issue reporting. Existing installations will continue to work, but we recommend migrating to the new repository.
147
158
The **Upsun CLI** is the official command-line interface for [Upsun](https://upsun.com) (formerly Platform.sh).
169

17-
This repository hosts the source code and releases of the CLI.
18-
19-
> This product includes PHP software, freely available from [the PHP website](https://www.php.net/software)
20-
2110
## Install
2211

23-
To install the CLI, use either [Homebrew](https://brew.sh/) (on Linux, macOS, or the Windows Subsystem for Linux) or [Scoop](https://scoop.sh/) (on Windows):
24-
25-
### HomeBrew
26-
27-
```console
28-
brew install platformsh/tap/platformsh-cli
29-
```
30-
31-
> 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).
32-
33-
### Scoop
34-
35-
```console
36-
scoop bucket add platformsh https://github.com/platformsh/homebrew-tap.git
37-
scoop install platform
38-
```
39-
40-
### Bash installer
41-
42-
Use the bash installer for an automated installation, using the most preferable way for your system.
43-
4412
```console
4513
curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash
4614
```
4715

48-
The installer is configurable using the following environment variables:
49-
50-
* `INSTALL_LOG` - the install log file
51-
* `INSTALL_METHOD` - force a specific installation method, possible values are `brew` and `raw`
52-
* `INSTALL_DIR` - the installation directory for the `raw` installation method, for example you can use `INSTALL_DIR=$HOME/.local/bin` for a single user installation
53-
* `VERSION` - the version of the CLI to install, if you need a version other than the latest one
54-
55-
56-
### Nix profile
57-
58-
Refer to the [Nix
59-
documentation if you are not on NixOS](https://nix.dev/manual/nix/2.24/installation/installing-binary.html).
60-
61-
```console
62-
nix profile install nixpkgs#platformsh
63-
nix profile install nixpkgs#upsun
64-
```
65-
66-
#### Installation configuration examples
67-
68-
<details>
69-
<summary>Force the CLI to be installed using the raw method</summary>
70-
71-
curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | INSTALL_METHOD=raw bash
72-
</details>
16+
For other installation methods (Homebrew, Scoop, Alpine, Debian/Ubuntu, RHEL/Fedora, Nix), upgrade instructions, and documentation, see [upsun/cli](https://github.com/upsun/cli).
7317

74-
<details>
75-
<summary>Install a specific version</summary>
76-
77-
curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | VERSION=4.0.1 bash
78-
</details>
79-
80-
<details>
81-
<summary>Install the CLI in a user owned directory</summary>
82-
83-
curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | INSTALL_METHOD=raw INSTALL_DIR=$HOME/.local/bin bash
84-
</details>
85-
86-
### Alpine
87-
88-
```console
89-
sudo apk add --no-cache bash
90-
curl -1sLf \
91-
'https://dl.cloudsmith.io/public/platformsh/cli/setup.alpine.sh' \
92-
| sudo -E bash
93-
```
94-
95-
<details>
96-
<summary>Manual setup</summary>
97-
98-
apk add --no-cache curl
99-
curl -1sLf 'https://dl.cloudsmith.io/public/platformsh/cli/rsa.4F1C2AC5106DA770.key' > /etc/apk/keys/cli@platformsh-4F1C2AC5106DA770.rsa.pub
100-
curl -1sLf "https://dl.cloudsmith.io/public/platformsh/cli/config.alpine.txt" >> /etc/apk/repositories
101-
apk update
102-
103-
</details>
104-
105-
```console
106-
# Install the CLI
107-
apk add platformsh-cli
108-
```
109-
110-
### Ubuntu/Debian
111-
112-
```console
113-
apt-get update
114-
apt-get install -y apt-transport-https curl
115-
curl -1sLf \
116-
'https://dl.cloudsmith.io/public/platformsh/cli/setup.deb.sh' \
117-
| sudo -E bash
118-
```
119-
120-
<details>
121-
<summary>Manual setup</summary>
122-
123-
apt-get update
124-
125-
# Only needed for Debian
126-
apt-get install -y debian-keyring debian-archive-keyring
127-
128-
apt-get install -y apt-transport-https curl gnupg
129-
curl -1sLf 'https://dl.cloudsmith.io/public/platformsh/cli/gpg.6ED8A90E60ABD941.key' | gpg --dearmor >> /usr/share/keyrings/platformsh-cli-archive-keyring.gpg
130-
# If you use an Ubuntu derivative distro, such as Linux Mint, you may need to use UBUNTU_CODENAME instead of VERSION_CODENAME below.
131-
curl -1sLf "https://dl.cloudsmith.io/public/platformsh/cli/config.deb.txt?distro=$(. /etc/os-release && echo "$ID")&codename=$(. /etc/os-release && echo "$VERSION_CODENAME")" > /etc/apt/sources.list.d/platformsh-cli.list
132-
apt-get update
133-
134-
</details>
135-
136-
```console
137-
# Install the CLI
138-
apt-get install -y platformsh-cli
139-
```
18+
### The `platform` binary
14019

141-
### CentOS/RHEL/Fedora
20+
The `platform` binary remains available for users who depend on it. It is functionally close to `upsun` but the binary name differs and a few behaviors are subtly different. To install it, use this repository's installer:
14221

14322
```console
144-
curl -1sLf \
145-
'https://dl.cloudsmith.io/public/platformsh/cli/setup.rpm.sh' \
146-
| sudo -E bash
147-
148-
# Install the CLI
149-
yum install -y platformsh-cli
150-
```
151-
152-
### Manual installation
153-
154-
For manual installation, you can also [download the latest binaries](https://github.com/upsun/cli/releases/latest).
155-
156-
## Upgrade
157-
158-
Upgrade using the same tool:
159-
160-
### HomeBrew
161-
162-
```console
163-
brew update && brew upgrade platformsh/tap/platformsh-cli
164-
```
165-
166-
### Scoop
167-
168-
```console
169-
scoop update platform
170-
```
171-
172-
### Bash installer
173-
174-
```console
175-
curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash
176-
```
177-
178-
### Alpine
179-
180-
```console
181-
apk add -l platformsh-cli
182-
```
183-
184-
### Ubuntu/Debian
185-
186-
```console
187-
apt-get upgrade platformsh-cli
188-
```
189-
190-
### CentOS/RHEL/Fedora
191-
192-
```console
193-
yum upgrade -y platformsh-cli
194-
```
195-
196-
## Under the hood
197-
198-
## Building binaries, snapshots and releases
199-
200-
Build a single binary
201-
202-
```console
203-
make single
204-
```
205-
206-
Build a snapshot
207-
208-
```console
209-
make snapshot
210-
```
211-
212-
Build a snapshot for a vendor
213-
214-
```console
215-
# Download the config file at internal/config/embedded-config.yaml
216-
make vendor-snapshot VENDOR_NAME='Upsun staging' VENDOR_BINARY='upsunstg'
217-
```
218-
219-
Create a release
220-
221-
```console
222-
# First, create a new tag, if not already on a Git tag
223-
git tag -f -m 'Release v5.0.0' '5.0.0'
224-
225-
# Create a release
226-
# Expose a GITHUB_TOKEN to use for the release
227-
make release
228-
229-
# Create a release for a vendor with the default .gorelease.vendor.yaml.tpl
230-
# Download the config file at internal/config/embedded-config.yaml
231-
# Optionally, download the .goreleaser.vendor.yaml file to use a custom one
232-
make vendor-release VENDOR_NAME='Upsun staging' VENDOR_BINARY='upsunstg'
23+
curl -fsSL https://raw.githubusercontent.com/platformsh/cli/main/installer.sh | bash
23324
```
23425

23526
## Licenses
23627

237-
This binary redistributes PHP in a binary form, which comes with the [PHP License](https://www.php.net/license/3_01.txt).
28+
This binary redistributes PHP in a binary form, which comes with the [PHP License](https://www.php.net/license/3_01.txt). PHP is freely available from [the PHP website](https://www.php.net/software).

0 commit comments

Comments
 (0)