Skip to content

Commit 2760a58

Browse files
committed
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: crossplane/crossplane#6436 Signed-off-by: Theo Chatzimichos <tampakrap@gmail.com>
1 parent bd70135 commit 2760a58

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

content/master/cli/_index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,26 @@ curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.s
3333
[The script](https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh)
3434
detects your CPU architecture and downloads the latest stable release.
3535

36+
### Download the compressed file instead of the binary
37+
38+
Since v1.18.0 there are also compressed files available. You can ask the
39+
install script to download and unpack the compressed files instead, which
40+
should save some bandwidth. Below is an example on how to do that:
41+
42+
```shell
43+
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | COMPRESSED=True sh
44+
```
45+
3646
{{<expand "Manually install the Crossplane CLI" >}}
3747

3848
If you don't want to run shell script you can manually download a binary from
3949
the Crossplane releases repository at
4050
https://releases.crossplane.io/stable/current/bin
4151

52+
If you prefer to download a compressed file from the Crossplane releases
53+
repository, they are available at
54+
https://releases.crossplane.io/stable/current/bundle
55+
4256
{{<hint "important" >}}
4357
<!-- vale write-good.Passive = NO -->
4458
The CLI is named `crank` in the release repository. Download this file.

0 commit comments

Comments
 (0)