Welcome to Kip 🐔

Kip is an easy to use CLI for developing and deploying your kubernetes project.

Notice

Kip is under active development. We're open to suggestions and feedback, please feel free to open an issue

Description

TODO

Prerequisites

• kubectl (more info)
• helm (more info)
• docker (more info)

Install

from source

make install

from release

Download binary from: releases

Linux

mv kip ~/.local/bin/kip
chmod +x ~/.local/bin/kip

Mac

mv kip /usr/local/bin/kip
chmod +x /usr/local/bin/kip

Windows

1. Download binary
2. Add the binary to your $PATH

Commands

Command	Description
kip build	Builds one or more services
kip chart add	Adds a new helm chart to your project or service
kip chart list	Lists all charts
kip check	Checks if all dependencies are in available in $PATH
kip deploy	Deploys project or service
kip generators	Lists all available generators for creating services
kip help	List all available commands
kip new [NAME]	Creates a new kip project
kip run [SCRIPT_NAME]	Runs a script
kip script add	Add a new script to your project or service
kip script list	List all scripts
kip service add	Create a new service
kip service list	List all services
kip version	Print the client version information

kip new

This is the initialization command that creates a new project or service. Example:

kip new foobar

The following (optional) flags are available:

* -t, --template string        project | service. A project can contain multiple services(default "project")
* -g, --generator string       Generator used for creating service projects (ex:nestjs,angular)
* -h, --help                   Extra information about the kip new command

kip service

Generates a new service in your kip project. Example:

kip service add foobar

The following commands are available:

* add       generates a new service in your kip project
* list      lists all services in your kip project

kip build

Builds a service Example:

kip build foobar

The following (optional) flag is available:

* --all     Builds all services in your kip project

kip chart

Creates a Helm chart Example:

kip chart add foobar -s <servicename>

The following commands are available:

* add     Generates a new Helm chart in your kip project
* list    Lists all charts in your kip project

kip deploy

Deploys a helm chart Example:

kip deploy 

The following (optional) flags are available:

* -a, --all             deploy all charts (default true)
* -c, --charts stringArray charts to deploy
* -s, --service stringArray services to deploy
* -h, --help                   Extra information about the kip deploy command

Usage

1. Create project

TODO