# krane

> The Krane CLI

Latest version **0.4.26** (published 2021-08-18) · 0 weekly downloads

## Install

```sh
npm install krane
pnpm add krane
yarn add krane
bun add krane
```

Provides the command `krane`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.26 |
| Published | 2021-08-18 |
| First published | 2021-01-14 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 8 |
| Unpacked size | 60.6 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Krane |
| Maintainers | davidcastaneda |
| Keywords | containers, docker, deployments, container management |

## Links

- npm: https://www.npmjs.com/package/krane
- Repository: https://github.com/krane/cli
- Issues: https://github.com/krane/cli/issues
- npm.io page: https://npm.io/package/krane

## Dependencies (8)

- [cli-ux](https://npm.io/package/cli-ux.md) ^5.5.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [inquirer](https://npm.io/package/inquirer.md) ^7.1.0
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.5.1
- [@krane/common](https://npm.io/package/@krane/common.md) 0.5.96
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.15.1
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.8.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^2.2.3

## Recent versions

- 0.4.26 (latest) — 2021-08-18
- 0.4.25 — 2021-08-18
- 0.4.24 — 2021-08-18
- 0.4.23 — 2021-08-18
- 0.4.21 — 2021-05-13
- 0.4.20 — 2021-05-09
- 0.4.19 — 2021-05-09
- 0.4.18 — 2021-05-09
- 0.4.17 — 2021-05-09
- 0.4.16 — 2021-05-09
- 0.4.15 — 2021-05-07
- 0.4.14 — 2021-05-06
- 0.4.13 — 2021-05-06
- 0.4.12 — 2021-02-28
- 0.4.11 — 2021-02-16
- … 8 more at https://npm.io/package/krane/versions

## README

<img src="https://github.com/krane/krane/blob/main/docs/assets/krane-wordmark.png?raw=true" width="350">

> A command-line tool for managing insfrastructure running on [Krane](https://github.com/krane/krane)

[![npm version](https://img.shields.io/npm/v/krane?color=#D0BB79&label=npm)](https://www.npmjs.com/package/krane)

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

### Install

You can install the Krane CLI using [npm](https://www.npmjs.com/package/krane). 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.

```sh
npm i -g krane
```

### Update 

```sh
npm update -g krane
```

### Examples

```sh
# 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](https://docs.krane.sh/#/docs/cli) for the complete list of available commands.

## Contributing

The Krane CLI is written in Typescript using the [OCLIF](https://oclif.io/) framework.

Commands are located under the [/src/commands](https://github.com/krane/cli/tree/master/src/commands) directory

---
_Source: https://npm.io/package/krane · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._