From 2760a582af33300758aea5a6682bb386348ce100 Mon Sep 17 00:00:00 2001 From: Theo Chatzimichos Date: Wed, 7 May 2025 18:41:35 +0200 Subject: [PATCH] docs: Add a note about installing the compressed file for the CLI Since v1.18.0 there are compressed files available under the `bundle/` directory in releases.crossplane.io. This commit adds the functionality of downloading the compressed file and unpacking it, instead of downloading the binary, which would save some bandwidth. This commit documents this functionality. Related PR: https://github.com/crossplane/crossplane/pull/6436 Signed-off-by: Theo Chatzimichos --- content/master/cli/_index.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/content/master/cli/_index.md b/content/master/cli/_index.md index b6f2e6ec9..c2f75c65f 100644 --- a/content/master/cli/_index.md +++ b/content/master/cli/_index.md @@ -33,12 +33,26 @@ curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.s [The script](https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh) detects your CPU architecture and downloads the latest stable release. +### Download the compressed file instead of the binary + +Since v1.18.0 there are also compressed files available. You can ask the +install script to download and unpack the compressed files instead, which +should save some bandwidth. Below is an example on how to do that: + +```shell +curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | COMPRESSED=True sh +``` + {{}} If you don't want to run shell script you can manually download a binary from the Crossplane releases repository at https://releases.crossplane.io/stable/current/bin +If you prefer to download a compressed file from the Crossplane releases +repository, they are available at +https://releases.crossplane.io/stable/current/bundle + {{}} The CLI is named `crank` in the release repository. Download this file.