krane

The Krane CLI

Usage no npm install needed!

<script type="module">
  import krane from 'https://cdn.skypack.dev/krane';
</script>

README

A command-line tool for managing insfrastructure running on Krane

npm version

Official Documentation: https://docs.krane.sh/#/docs/cli

Install

You can install the Krane CLI using npm. The following command will install the cli globally allowing you to run krane commands from anywhere on your machine. Note that this requires node to be installed on your machine.

npm i -g krane

Update

npm update -g krane

Examples

# Display CLI usage and commands
$ krane help 

# Authenticate with a Krane instance
$ krane login https://krane.example.com

# List all deployments
$ krane list 

# Returns information about the containers for a deployment
$ krane status <deployment>

# Stream realtime deployment logs
$ krane logs <deployment>

Checkout the official docs site for the complete list of available commands.

Contributing

The Krane CLI is written in Typescript using the OCLIF framework.

Commands are located under the /src/commands directory