Merge pull request #907 from jbw976/v2-cli

v2: use XP_CHANNEL=preview for CLI install
This commit is contained in:
Nic Cope 2025-03-31 12:18:59 -07:00 committed by GitHub
commit e9d1cf8b31
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 11 deletions

View File

@ -17,17 +17,17 @@ The Crossplane CLI includes:
The Crossplane CLI is a single standalone binary with no external dependencies. The Crossplane CLI is a single standalone binary with no external dependencies.
{{<hint "note" >}} {{<hint "note" >}}
Install the Crossplane CLI on a user's computer. Install the Crossplane CLI on a user's computer.
Most Crossplane CLI commands are independent of Kubernetes and Most Crossplane CLI commands are independent of Kubernetes and
don't require access to a Crossplane pod. don't require access to a Crossplane pod.
{{< /hint >}} {{< /hint >}}
To download the latest version for your CPU architecture with the Crossplane To download the latest version for your CPU architecture with the Crossplane
install script. install script.
```shell ```shell
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | sh curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_CHANNEL=preview sh
``` ```
[The script](https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh) [The script](https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh)
@ -35,13 +35,13 @@ detects your CPU architecture and downloads the latest stable release.
{{<expand "Manually install the Crossplane CLI" >}} {{<expand "Manually install the Crossplane CLI" >}}
If you don't want to run shell script you can manually download a binary from If you don't want to run shell script you can manually download a binary from
the Crossplane releases repository at the Crossplane releases repository at
https://releases.crossplane.io/stable/current/bin https://releases.crossplane.io/stable/current/bin
{{<hint "important" >}} {{<hint "important" >}}
<!-- vale write-good.Passive = NO --> <!-- vale write-good.Passive = NO -->
The CLI is named `crank` in the release repository. Download this file. The CLI is named `crank` in the release repository. Download this file.
<!-- vale write-good.Passive = YES --> <!-- vale write-good.Passive = YES -->
The `crossplane` binary is the Kubernetes Crossplane pod image. The `crossplane` binary is the Kubernetes Crossplane pod image.
@ -53,12 +53,12 @@ Move the binary to a location in your `$PATH`, for example `/usr/local/bin`.
### Download other CLI versions ### Download other CLI versions
Download different Crossplane CLI versions or different release branches with Download different Crossplane CLI versions or different release branches with
the `XP_CHANNEL` and `XP_VERSION` environmental variables. the `XP_CHANNEL` and `XP_VERSION` environmental variables.
By default the CLI installs from the `XP_CHANNEL` named `stable` and the By default the CLI installs from the `XP_CHANNEL` named `stable` and the
`XP_VERSION` of `current`, matching the most recent stable release. `XP_VERSION` of `current`, matching the most recent stable release.
For example, to install CLI version `v1.14.0` add `XP_VERSION=v1.14.0` to the For example, to install CLI version `v1.14.0` add `XP_VERSION=v1.14.0` to the
download script curl command: download script curl command:
`curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_VERSION=v1.14.0 sh` `curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_VERSION=v1.14.0 sh`