Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyma-project/cli
Simple set of commands to manage a Kyma installation
https://github.com/kyma-project/cli
cli kyma
Last synced: 3 days ago
JSON representation
Simple set of commands to manage a Kyma installation
- Host: GitHub
- URL: https://github.com/kyma-project/cli
- Owner: kyma-project
- License: apache-2.0
- Created: 2018-11-12T09:28:32.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T13:35:16.000Z (7 months ago)
- Last Synced: 2024-05-29T01:47:18.153Z (7 months ago)
- Topics: cli, kyma
- Language: Go
- Homepage:
- Size: 4.55 MB
- Stars: 109
- Watchers: 25
- Forks: 118
- Open Issues: 13
-
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. We've started designing the `v3` commands that will be first released within the `alpha` command group.
> Read more about the decision [here](https://github.com/kyma-project/community/issues/872).
Kyma CLI is a command line tool which supports [Kyma](https://github.com/kyma-project/kyma) users.
## Install
> [!WARNING]
> `v3` is still in the prototyping stage. All commands are still considered alpha - use it at your own risk.
Download the latest build from the main branch from [v0.0.0-dev](https://github.com/kyma-project/cli/releases/tag/v0.0.0-dev) release assets.
To get Kyma CLI for MacOS or Linux, run the following script from the project's root folder:
```sh
curl -L "https://github.com/kyma-project/cli/releases/download/v0.0.0-dev/kyma_$(uname -s)_$(uname -m).tar.gz" | tar -zxvf - -C bin kyma && mv bin/kyma bin/kyma@v3
```
This script downloads a Linux/MacOS variant of Kyma CLI v3 binary into `bin/kyma@v3`.
Inspect the new available alpha commands by calling the `--help` option:
```sh
./bin/kyma@v3 alpha --help
```
## Usage
### Import Image Into Kyma's Internal Docker Registry
> [!NOTE]
> To use the following `image-import` command, you must [install the Docker Registry module](https://github.com/kyma-project/docker-registry?tab=readme-ov-file#install) on your Kyma runtime
```
docker pull kennethreitz/httpbin
./bin/kyma@v3 alpha image-import kennethreitz/httpbin:latest
```
Run a Pod from a locally hosted image
```
kubectl run my-pod --image=localhost:32137/kennethreitz/httpbin:latest --overrides='{ "spec": { "imagePullSecrets": [ { "name": "dockerregistry-config" } ] } }'
```
## Development
To build a Kyma CLI binary, run:
```
go build -o kyma-cli main.go
```
You can run the command directly from the go code. For example:
```
go run main.go provision --help
```
## 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.