# perfume

> Stylize terminal output

Latest version **0.0.11** (published 2016-01-28) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

Provides the command `perfume`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2016-01-28 |
| First published | 2015-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Voyga |
| Maintainers | voyga |
| Keywords | color, colour, style, styles, stylize, text, cli, terminal, console, command-line, shell |

## Links

- npm: https://www.npmjs.com/package/perfume
- Repository: https://github.com/voyga/perfume
- Homepage: https://github.com/voyga/perfume#readme
- Issues: https://github.com/voyga/perfume/issues
- npm.io page: https://npm.io/package/perfume

## Dependencies (2)

- [emojilib](https://npm.io/package/emojilib.md) ^1.0.1
- [ansi-styles](https://npm.io/package/ansi-styles.md) ^2.1.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.11 (latest) — 2016-01-28
- 0.0.10 — 2016-01-28
- 0.0.9 — 2015-12-02
- 0.0.8 — 2015-11-16
- 0.0.7 — 2015-11-07
- 0.0.6 — 2015-11-06
- 0.0.5 — 2015-11-06
- 0.0.4 — 2015-11-06
- 0.0.3 — 2015-11-06
- 0.0.2 — 2015-10-01
- 0.0.1 — 2015-09-30
- 0.0.0 — 2015-09-29
- 1.0.1 — 2015-09-29

## README

# Perfume
> Stylize terminal output

## Install

```bash

$ npm install --save perfume

```

## Usage

```javascript

const perfume = require("perfume");

// "World" will be red and bold
console.log(perfume("Hello (World):red:bold"));

// The whole sentence will be bold
console.log(perfume("(Hello World):bold"));

// The whole sentence will be bold and "World" will be red and bold
console.log(perfume("Hello (World):red", "bold"));

// Add emojis into your string
console.log(perfume("Hello (:smile:)")); // => Hello 😀

// Doesn't support nested syntax yet
console.log(perfume("(Hello (World):bold):red")) // => error

```

## API

#### perfume(string[, style])
> `perfume("(This):red (is):green (really):blue (a):cyan (colorful):yellow (string):white (:smile:)", "bold")`

Parse a perfume string and apply `style` to the whole string

### Suppoted Styles

All in [ansi-styles](https://github.com/chalk/ansi-styles)

### Emojis

Search for emoji codes [here](http://emoji.muan.co/)

### CLI

``` bash

$ [sudo] npm install -g perfume

```

###### Usage
```bash

$ perfume "Hello (World):red"
$ echo "Hello (World):red" | perfume

```

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