Skip to content

Latest commit

 

History

History
executable file
·
93 lines (60 loc) · 2.91 KB

README.md

File metadata and controls

executable file
·
93 lines (60 loc) · 2.91 KB
Raw

Kyma CLI

Overview

Kyma CLI is a command line tool which supports Kyma developers. It provides a set of commands and flags you can use to:

  • Provision a cluster locally or on cloud providers, such as GCP or Azure, or use Gardener to set up and easily manage your clusters.
  • Deploy, manage, and undeploy Kyma.
  • Manage your Functions.

TIP: This document briefly describes the concept of Kyma CLI. Read the Kyma 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.

For the commands and flags to work, they must follow this syntax:

kyma {COMMAND} {FLAGS}
  • {COMMAND} specifies the operation you want to perform, such as provisioning the cluster or deploying Kyma.
  • {FLAGS} specifies optional flags you can use to enrich your command.

See the example:

kyma deploy -s main

TIP: Read more about the available commands and flags.

Development

Build from Sources

Alternatively, you can also build the Kyma CLI from the sources:

  1. To clone the Kyma CLI repository, run:
mkdir -p $GOPATH/src/github.com/kyma-project/
git clone [email protected]:kyma-project/cli.git $GOPATH/src/github.com/kyma-project/cli
  1. Enter the root folder of the cloned repository:
cd $GOPATH/src/github.com/kyma-project/cli
  1. Run make build for your target OS:
    • Mac OSX: make build-darwin
    • Windows: make build-windows
    • Linux: make build-linux

The binary is saved to the bin folder in the Kyma CLI repository.

Kyma CLI 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, kyma-linux-arm, kyma.exe, or kyma-arm.exe
chmod +x kyma

In addition to the stable binaries, we also provide binaries using the latest reconciler version. We try to build those binaries daily.

To download the binaries using the latest reconciler version, run:

curl -Lo kyma https://storage.googleapis.com/kyma-cli-unstable/kyma-darwin # kyma-linux, kyma-linux-arm, kyma.exe, or kyma-arm.exe
chmod +x kyma