Starship
CLI
Introduction

Client

Install the Cli

npm install -g @starship-ci/cli

or use npx

npx @starship-ci/cli

Install dependencies

Following command will install all the dependencies required to run the starship.

starship install

If all dependencies are installed successfully, you will see the following message:

No name specified, using default name: starship
No version specified, using default version: v1.5.0
Checking docker...
Checking kubectl...
Checking helm...

Run starship setp-by-step

  1. Setup helm chart
starship setup
  1. Deploy starship, run pods, services, and ingress
starship deploy --config ./config/config.yaml
  1. Wait for pods to be ready and running
starship wait-for-pods --config ./config/config.yaml
  1. Start port-forwarding to be able to connect to ports
starship start-ports --config ./config/config.yaml

Or you can run all the above commands in one go

starship start --config ./config/config.yaml  # will run setup, deploy, wait-for-pods, start-ports

Teardown starship

  1. Stop port-forwarding
starship stop-ports --config ./config/config.yaml
  1. Delete starship kubernetes resources
starship delete --config ./config/config.yaml

Or you can run both commands in one go

starship stop --config ./config/config.yaml  # will run stop-ports, delete