https://github.com/kyma-project/cli
Simple set of commands to manage a Kyma cluster
https://github.com/kyma-project/cli
cli kyma
Last synced: about 1 year ago
JSON representation
Simple set of commands to manage a Kyma cluster
- Host: GitHub
- URL: https://github.com/kyma-project/cli
- Owner: kyma-project
- License: apache-2.0
- Created: 2018-11-12T09:28:32.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T19:43:50.000Z (about 1 year ago)
- Last Synced: 2025-05-12T20:49:41.581Z (about 1 year ago)
- Topics: cli, kyma
- Language: Go
- Homepage:
- Size: 5.35 MB
- Stars: 119
- Watchers: 24
- Forks: 119
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://api.reuse.software/info/github.com/kyma-project/cli)
# Kyma CLI
> [!WARNING]
> The Kyma CLI version `v2`, with all commands available within this version, is deprecated. Please start using alpha commands available as part of `v3` and please contribute with usecase ideas and general feedback.
Kyma CLI is a command-line interface tool designed to simplify the use of [Kyma](https://github.com/kyma-project/kyma) for application developers. It helps to manage Kyma modules and deploy simple applications, automating complex tasks with simple commands and accelerating development cycles.
## Install
For the installation instructions, see [How to Install](./docs/user/README.md#how-to-install).
## Usage
Inspect the new available alpha commands by calling the `--help` option:
```sh
kyma alpha --help
```
Run a simple app from the image on Kyma by calling:
```sh
kyma alpha app push --name my-first-kyma-app --image kennethreitz/httpbin --expose --container-port 80
Creating deployment default/my-first-kyma-app
Creating service default/my-first-kyma-app
Creating API Rule default/my-first-kyma-app
The `my-first-kyma-app` application is available under the https://my-first-kyma-app.{CLUSTER_DOMAIN}/ address
```
For more usage scenarios, see [user documentation](./docs/user/README.md).
## Development
To build a Kyma CLI binary, run:
```sh
go build -o kyma main.go
```
You can run the command directly from the go code. For example:
```sh
go run main.go alpha module list
```
## Contributing
See the [Contributing Rules](CONTRIBUTING.md).
## Code of Conduct
See the [Code of Conduct](CODE_OF_CONDUCT.md) document.
## Licensing
See the [license](LICENSE) file.