Skip to content

docs: Add a note about installing the compressed file for the CLI #929

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Add a note about installing the compressed file for the CLI #929

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
14 changes: 14 additions & 0 deletions content/master/cli/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

{{<expand "Manually install the Crossplane CLI" >}}

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

{{<hint "important" >}}
<!-- vale write-good.Passive = NO -->
The CLI is named `crank` in the release repository. Download this file.
Expand Down