# kuler

> Color your terminal using CSS/hex color codes

Latest version **2.0.0** (published 2019-06-06) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-06-06 |
| First published | 2014-05-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/kuler) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Arnout Kazemier |
| Maintainers | 3rdeden, v1 |
| Keywords | kuler, ansi, color, colour, chalk, css, hex, rgb, rgv |

## Links

- npm: https://www.npmjs.com/package/kuler
- Repository: https://github.com/3rd-Eden/kuler
- Issues: https://github.com/3rd-Eden/kuler/issues
- npm.io page: https://npm.io/package/kuler

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2019-06-06
- 1.0.1 — 2018-10-03
- 1.0.0 — 2018-04-30
- 0.0.0 — 2014-05-28

## README

# kuler

Kuler is small and nifty node module that allows you to create terminal based
colors using hex color codes, just like you're used to doing in your CSS. We're
in a modern world now and terminals support more than 16 colors so we are stupid
to not take advantage of this.

## Installation

The package is released in the public npm registry and can be installed by
running:

```
npm install --save kuler
```

## Usage

To color a string simply pass it the string you want to have colored as first
argument and the color as hex as second argument:

```js
'use strict';

const kuler = require('kuler');
const str = kuler('foo', '#FF6600');
```

The color code sequence is automatically terminated at the end of the string so
the colors do no bleed to other pieces of text. So doing:

```js
console.log(kuler('red', '#F00'), 'normal');
```

Will work without any issues.

## License

[MIT](LICENSE)

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