# @kui-shell/plugin-editor

> Kui plugin that integrates the monaco-editor component

Latest version **8.4.3** (published 2020-04-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @kui-shell/plugin-editor
pnpm add @kui-shell/plugin-editor
yarn add @kui-shell/plugin-editor
bun add @kui-shell/plugin-editor
```

Provides the commands `@kui-shell/plugins/editor/webpack/pre`, `@kui-shell/plugins/editor/webpack/post`.

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.4.3 |
| Published | 2020-04-14 |
| First published | 2019-01-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 128.5 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2892 |
| Author | Nick Mitchell |
| Maintainers | oliviaruan, starpit |
| Keywords | kui, plugin |

## Links

- npm: https://www.npmjs.com/package/@kui-shell/plugin-editor
- Repository: https://github.com/IBM/kui
- Homepage: https://github.com/IBM/kui#readme
- Issues: https://github.com/IBM/kui/issues/new
- npm.io page: https://npm.io/package/@kui-shell/plugin-editor

## Dependencies (4)

- [tmp](https://npm.io/package/tmp.md) 0.1.0
- [debug](https://npm.io/package/debug.md) 4.1.1
- [monaco-editor](https://npm.io/package/monaco-editor.md) 0.18.1
- [monaco-editor-webpack-plugin](https://npm.io/package/monaco-editor-webpack-plugin.md) 1.7.0

## Recent versions

- 8.4.3 (latest) — 2020-04-14
- 4.5.1-dev.5777.247 (dev) — 2019-12-09
- 5.1.14 (stable) — 2019-11-07
- 4.5.1 (legacy) — 2019-11-01
- 4.5.1-nightly.4954.94 (nightly) — 2019-10-16
- 8.4.2 — 2020-04-10
- 8.4.1 — 2020-04-10
- 8.4.0 — 2020-04-10
- 8.3.0 — 2020-04-10
- 6.0.21 — 2020-04-07
- 8.1.1 — 2020-04-06
- 8.1.0 — 2020-04-04
- 8.0.12 — 2020-04-03
- 8.0.11 — 2020-04-03
- 6.0.20 — 2020-04-01
- … 551 more at https://npm.io/package/@kui-shell/plugin-editor/versions

## README

[![GitHub Stars](https://badgen.net/github/stars/IBM/kui)](https://github.com/IBM/kui/stargazers)
[![GitHub Forks](https://badgen.net/github/forks/IBM/kui)](https://github.com/IBM/kui/network/members)
![ts](https://flat.badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)
![Electron](https://flat.badgen.net/badge/Electron/22/orange)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
[![test](https://github.com/kubernetes-sigs/kui/actions/workflows/test.yaml/badge.svg)](https://github.com/kubernetes-sigs/kui/actions/workflows/test.yaml)

[**Blogs**](https://medium.com/the-graphical-terminal) **|** [**PDF Summary**](docs/presentations/kui-cloudnative-devx-2021.pdf) **|** [**Installation**](#install) **|** [**API**](docs/api/README.md) **|** [**Custom Graphical CLIs**](#custom)

# Kui: a Framework for Enhancing CLIs with Graphics

<img width="600" align="right" src="docs/readme/images/kui-experience.gif">

We love CLIs, and think they are critical for interacting in a
flexible way with the cloud. We need the power to go off the
rails. But ASCII is tedious.

Kui takes your normal `kubectl` command line requests and **responds
with graphics**. Instead of ASCII tables, you are presented with
sortable ones. Instead of copying and pasting long auto-generated
resource names, in Kui **you just click**.

Kui is also fast. It launches in seconds, and can process `kubectl`
commands **2-3 times faster** than `kubectl` itself.

<img height="185" src="docs/readme/images/grid-watch.gif"><img height="185" src="docs/readme/images/sequence-diagram.png"><img height="185" src="docs/readme/images/pod.png">

> Help us make Kubernetes tools better by filling out a [quick 2
> minute survey](https://forms.gle/BMvpscU9Yi5Horp29) on your tool
> preferences. Thanks!

<a name="install">

## Installing Kui for Kubernetes

We offer prebuilt images optimized for an enhanced Kubernetes CLI
experience.

<img width="575" align="right" src="docs/readme/images/minisplits.png">

#### MacOS (Intel and Apple Silicon)

```bash
brew install kui
kubectl kui get pods
open /Applications/Kui.app
```

#### Windows and Linux

[Download and
unzip](https://github.com/kubernetes-sigs/kui/releases/latest), then
add the unzipped directory to your PATH. Now use `kubectl kui` or
launch the `Kui` executable to use Kui's built-in REPL.

> **Windows Warning**: Please use forward slashes for filepaths, e.g. c:/users, not c:\users.

#### I don't trust the prebuilts

We hear you. Choose your platform (e.g. `mac:amd64`), execute the
following, then look in `./dist/electron`.

```sh
git clone git@github.com:kubernetes-sigs/kui.git && cd kui && npm ci && \
    npm run build:electron:mac:amd64
```

<a name="custom">

## I Want to Make a Custom Graphical CLI

Kui is a framework for adding graphics to CLIs. Kui allows for either
a hosted client-server architecture, or the distribution of
double-clickable applications (via [Electron](https://electronjs.org)).

Using the Kui framework, you can design your own Kubernetes
enhancements, set a custom theme or custom icon, and enhance the
commands of your favorite CLI. Check out the [template
repo](https://github.com/kui-shell/KuiClientTemplate). If your
enhancements would be generally valuable, please PR them back here,
e.g. awesome Kubernetes enhancements can be integrated with the [core
Kubernetes plugin](plugins/plugin-kubectl).

## Code of Conduct

Participation in the Kubernetes community is governed by the [Kubernetes Code
of Conduct](https://github.com/kubernetes-sigs/krew/blob/master/code-of-conduct.md).

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