Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ params:
# The current "latest" version. Used in the version dropdown
latest: "2.3"
# The current "latest" version of the CLI docs. Used in the CLI version
# dropdown. Tracked separately from the core "latest" so the two can diverge.
cliLatest: "2.3"
# dropdown.
cliLatest: "2.4"
docs: true
anchors:
# Generate heading anchors for any heading between min and max
Expand Down
74 changes: 74 additions & 0 deletions content/cli/v2.4/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
weight: 50
title: CLI Overview
description: "Command-line tools for Crossplane development"
cascade:
version: "2.4"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does something also need to be set so this version is now "latest"? should that be in this PR or a follow-up?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - need to add that to the release checklist.

---

The Crossplane CLI helps simplify some development and administration aspects of
Crossplane.

The Crossplane CLI includes commands for:

* building, installing, updating and pushing Crossplane Packages
* building platforms using Crossplane Projects
* testing and rendering standalone Composition Functions without the need to
access a Kubernetes cluster running Crossplane
* troubleshooting Crossplane Compositions, Composite Resources and Managed
Resources

## Installing the CLI

The Crossplane CLI is a single standalone binary with no external
dependencies. Some commands, such as `crossplane composition render` and
`crossplane project build`, do require a Docker compatible container runtime.

{{<hint "note" >}}
Install the Crossplane CLI on a user's computer.

Most Crossplane CLI commands are independent of Kubernetes and
don't require access to a Crossplane pod.
{{< /hint >}}

You can download the latest version using the install script:

```shell
curl -sfL "https://cli.crossplane.io/install.sh" | sh
```

[The script](https://raw.githubusercontent.com/crossplane/cli/main/install.sh)
detects your operating system and CPU architecture and downloads the appropriate
binary to the current directory. Note that it doesn't attempt to place the
binary in your shell's `$PATH`, so you may want to move it.

{{<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://cli.crossplane.io/stable/current/bin

Move the binary to a location in your `$PATH`, for example `/usr/local/bin`.
{{< /expand >}}

### Download other CLI versions

You can download different Crossplane CLI versions or different release branches
with the `XP_CHANNEL` and `XP_VERSION` environmental variables.

By default the CLI installs from the `XP_CHANNEL` named `stable` and the
`XP_VERSION` of `current`, matching the most recent stable release.

For example, to install CLI version `v2.3.0` add `XP_VERSION=v2.3.0` to the
download script curl command:

```shell
curl -sfL "https://cli.crossplane.io/install.sh" | XP_VERSION=v2.3.0 sh
```

To install the latest build from the `main` branch, use the `master` channel by
adding `XP_CHANNEL=master`:

```shell
curl -sfL "https://cli.crossplane.io/install.sh" | XP_CHANNEL=master sh
```
Loading
Loading