# cli-colors

> CLI colors

Latest version **0.0.2** (published 2016-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install cli-colors
pnpm add cli-colors
yarn add cli-colors
bun add cli-colors
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2016-10-29 |
| First published | 2016-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ivan Kleshnin |
| Maintainers | ivan-kleshnin |

## Links

- npm: https://www.npmjs.com/package/cli-colors
- npm.io page: https://npm.io/package/cli-colors

## Dependencies (1)

- [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ^1.0.5

## Recent versions

- 0.0.2 (latest) — 2016-10-29
- 0.1.0 — 2016-10-28

## README

# CLI colors

*Under development, don't use*

## Why

[Marak/colors](https://github.com/Marak/colors.js) – modifies `String` prototype... [facepalm](https://github.com/yeoman/yo/issues/68).

[SindreSorhus/chalk](https://github.com/chalk) – overengineered, fluent API sucks at composition

## Usage

```js
let {blue, red} = require("./index")

console.log("one " + red("two " + blue("three ") + "four " + blue("five ") + "six ") + "seven")
```

![Sample](./sample.gif)

## API

```js
let colors = require("cli-colors")
// or import * as colors from "cli-colors"
```

### Modifiers

```
colors.bold
colors.hidden
colors.inverse
colors.italic
colors.strikethrough
colors.underline
```

### Colors

```js
colors.black
colors.blue
colors.cyan
colors.gray
colors.green
colors.grey (alias)
colors.magenta
colors.red
colors.yellow
colors.white
```

### Backgrounds

```js
colors.bgBlack
colors.bgBlue
colors.bgCyan
colors.bgGreen
colors.bgMagenta
colors.bgRed
colors.bgYellow
colors.bgWhite
```

### Special

```
colors.reset
colors.styles
```

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