title | type |
---|---|
Use Kyma CLI |
Details |
Kyma CLI comes with a set of commands, each of which has its own specific set of flags. Use them to provision the cluster locally or using a chosen cloud provider, install, and test Kyma.
For the commands and flags to work, they need to follow this syntax:
kyma {COMMAND} {FLAGS}
- {COMMAND} specifies the operation you want to perform, such as provisioning the cluster or installing Kyma.
- {FLAGS} specifies optional flags you can use to enrich your command.
See the example:
kyma install -s latest
TIP: Documentation for particular commands is generated automatically with the code. See the full list of commands and flags.
Command | Child commands | Description | Example |
---|---|---|---|
completion |
None | Generates and displays the bash or zsh completion script. | kyma completion |
console |
None | Launches Kyma Console in a browser window. | kyma console |
install |
None | Installs Kyma on a cluster based on the current or specified release. | kyma install |
provision |
minikube gardener gke aks |
Provisions a new cluster on a platform of your choice. Currently, this command supports cluster provisioning on GCP, Azure, Gardener, and Minikube. | kyma provision minikube |
test |
definitions delete list run status logs |
Runs and manages tests on a provisioned Kyma cluster. Using child commands, you can run tests, view test definitions, list and delete test suites, display test status, and fetch the logs of the tests. | kyma test run |
version |
None | Shows the cluster version and the Kyma CLI version. | kyma version |