https://github.com/marcenacp/kubeasy

⛅️ Immersive command-line interface to manage Kubernetes cloud clusters
https://github.com/marcenacp/kubeasy

cli command-line-tool google-cloud-platform kubectl kubernetes

Last synced: 3 months ago
JSON representation

⛅️ Immersive command-line interface to manage Kubernetes cloud clusters

• Host: GitHub
• URL: https://github.com/marcenacp/kubeasy
• Owner: marcenacp
• Created: 2019-05-18T12:42:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T17:48:25.000Z (almost 2 years ago)
• Last Synced: 2024-06-15T13:33:12.667Z (5 months ago)
• Topics: cli, command-line-tool, google-cloud-platform, kubectl, kubernetes
• Language: JavaScript
• Homepage:
• Size: 966 KB
• Stars: 49
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-repositories - marcenacp/kubeasy - ⛅️ Immersive command-line interface to manage Kubernetes cloud clusters (JavaScript)

README

        
# kubeasy

[![Build Status](https://travis-ci.org/marcenacp/kubeasy.svg?branch=master)](https://travis-ci.org/marcenacp/kubeasy)

`kubeasy` is an interactive wrapper around [kubectl](https://kubernetes.io/docs/reference/kubectl/kubectl/)

to help you manage your Kubernetes clusters.

![](./public/kubeasy.gif)

## Installation

- Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)

- Install `kubeasy` by downloading the latest version from Github

```bash

git clone https://github.com/marcenacp/kubeasy.git

cd kubeasy/

npm install

npm link

```

- Use it with the command: `kubeasy`

## Development

### Development pattern

I use [blessed](https://github.com/chjj/blessed) to render the command-line interface,

and Node's [EventEmitter](https://nodejs.org/api/events.html) to propagate data between hooks and widgets.

- **Hooks** (in `src/hooks`) get data from Kubernetes using `kubectl` and store it in the state.

- **Widgets** (in `src/widgets`) watch inputs from user and render the command-line interface according to the state.

### Useful commands

- `npm run dev`: launch application with [nodemon](https://github.com/remy/nodemon)

- `npm run test`: launch unit tests and check syntax in Javascript files using [prettier](https://github.com/prettier/prettier) (run in CI)

- `npm run test:watch`: launch unit tests in watch mode