-
Notifications
You must be signed in to change notification settings - Fork 158
Add CLI v2.4 documentation #1119
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.
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
Merged
+2,875
−2
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| --- | ||
|
|
||
| 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 | ||
| ``` | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.