Kyma CLI
Overview
Kyma CLI is a command line tool which supports Kyma developers. It provides a set of commands you can use to provision clusters as well as install, manage, and test Kyma.
TIP: This document briefly describes the concept of Kyma CLI. Read the complete documentation to learn more.
Installation
To install the latest release of Kyma CLI on MacOS using Homebrew, run:
brew install kyma-cli
To install the latest release of Kyma CLI on Windows using Chocolatey, run:
choco install kyma-cli
Read more about installation options.
Use Kyma CLI
Once you have installed the CLI, you can use its set of commands and flags to provision a cluster and start working with Kyma.
In a nutshell, this is the syntax you can use to run the commands from your terminal:
kyma {COMMAND} {FLAGS}
where:
- {COMMAND} specifies the operation you want to perform.
- {FLAGS} specifies optional flags.
Example:
kyma install -s main
TIP: Read more about the available commands and flags.You can also try out Kyma CLI using these examples.
Kyma CLI as kubectl plugin
To learn how to use Kyma CLI as a kubectl plugin, follow this tutorial.
Development
Build from Sources
Alternatively, you can also build the Kyma CLI from the sources:
- To clone the Kyma CLI repository, run:
mkdir -p $GOPATH/src/github.com/kyma-project/
git clone git@github.com:kyma-project/cli.git $GOPATH/src/github.com/kyma-project/cli
- Enter the root folder of the cloned repository:
cd $GOPATH/src/github.com/kyma-project/cli
- Run
make build
for your target OS:- Mac OSX:
make build-darwin
- Windows:
make build-windows
- Linux:
make build-linux
- Mac OSX:
The binary is saved to the bin
folder in the Kyma CLI repository.
Kyma CLI stable binaries
Kyma CLI is used in CI jobs that install or test Kyma or provision clusters. To effectively support this process, we publish the stable binaries created from the stable
tag which corresponds to the latest stable version of Kyma CLI.
To download the binaries, run:
curl -Lo kyma https://storage.googleapis.com/kyma-cli-stable/kyma-darwin # kyma-linux or kyma.exe
chmod +x kyma