Kyma CLI

Overview

Kyma CLI is a command line tool which supports Kyma developers. It provides a set of commands you can use to install, manage, and test Kyma.

Prerequisites

Kyma CLI requires the following software:

• kubectl
• Minikube

Installation

Use the following options to install Kyma CLI from the latest release.

Homebrew (macOS)

To install Kyma CLI using Homebrew, run:

brew tap kyma-incubator/kyma-incubator
brew install kyma-incubator/kyma-incubator/kyma-cli

macOS

To install Kyma CLI on macOS, run:

curl -Lo kyma.tar.gz "https://github.com/kyma-project/cli/releases/download/$(curl -s https://api.github.com/repos/kyma-project/cli/releases/latest | grep tag_name | cut -d '"' -f 4)/kyma_Darwin_x86_64.tar.gz" \
&& mkdir kyma-release && tar -C kyma-release -zxvf kyma.tar.gz && chmod +x kyma-release/kyma && sudo mv kyma-release/kyma /usr/local/bin \
&& rm -rf kyma-release kyma.tar.gz

Linux

To install Kyma CLI on Linux, run:

curl -Lo kyma.tar.gz "https://github.com/kyma-project/cli/releases/download/$(curl -s https://api.github.com/repos/kyma-project/cli/releases/latest | grep tag_name | cut -d '"' -f 4)/kyma_Linux_x86_64.tar.gz" \
&& mkdir kyma-release && tar -C kyma-release -zxvf kyma.tar.gz && chmod +x kyma-release/kyma && sudo mv kyma-release/kyma /usr/local/bin \
&& rm -rf kyma-release kyma.tar.gz

Windows

To install Kyma CLI on Windows, download and unzip the artifact. Remember to adjust your PATH environment variable.

NOTE: To install a different release, change the path to point to the desired version:

curl -Lo kyma.tar.gz https://github.com/kyma-project/cli/releases/download/1.2.0/kyma_Darwin_i386.tar.gz

Usage

Commands

Kyma CLI comes with a set of commands:

• version shows the Kyma cluster version and the Kyma CLI version.
• provision minikube initializes Minikube on a new cluster. It replaces the minikube.sh script.
• install installs Kyma to a cluster based on the current release. It replaces the ìnstaller.sh and is-installed.sh script.
• uninstall uninstalls all Kyma-related resources from a cluster.
• test runs tests on a provisioned Kyma cluster.
• completion generates and shows the bash completion script.
• help displays and explains the usage of a given command.

For details on particular commands and options, see this list.

Use Kyma CLI

Use the following syntax to run the commands from your terminal:

kyma {COMMAND} {FLAGS}

where:

• {COMMAND} specifies the operation you want to perform.
• {FLAGS} specify optional flags. For example, use -v or --verbose for additional information on performed operations.

Example:

kyma install --verbose

Further usage examples include:

• Install Kyma with Minikube on Mac:

  kyma provision minikube
  kyma install

• Install Kyma with Minikube on Windows:

  kyma provision minikube
  # follow instructions to add hosts
  kyma install

• Install Kyma with Minikube on Windows using HyperV:

  kyma provision minikube --vm-driver hyperv --hypervVirtualSwitch {YOUR_SWITCH_NAME}
  # follow instructions to add hosts
  kyma install

Kyma CLI as a kubectl plugin

NOTE: To use Kyma CLI as a kubectl plugin, use Kubernetes version 1.12.0 or higher.

A plugin is a standalone executable file with a name prefixed with kubectl- .To use the plugin, perform the following steps:

1. Rename the kyma binary to kubectl-kyma and place it anywhere in your {PATH}:

sudo mv ./kyma /usr/local/bin/kubectl-kyma

2. Run kubectl plugin list command to see your plugin on the list of all available plugins.

3. Invoke your plugin as a kubectl command:

$ kubectl kyma version
Kyma CLI version: v0.6.1
Kyma cluster version: 1.0.0

For more information on extending kubectl with plugins, read Kubernetes documentation.