# elegant-status

> Create elegant task status for CLI.

Latest version **1.1.0** (published 2016-05-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install elegant-status
pnpm add elegant-status
yarn add elegant-status
bun add elegant-status
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-05-20 |
| First published | 2015-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 131 |
| Author | Ivan Nikulin |
| Maintainers | inikulin |
| Keywords | status, elegant, spinner, cli, process, task |

## Links

- npm: https://www.npmjs.com/package/elegant-status
- Repository: https://github.com/inikulin/elegant-status
- Homepage: https://github.com/inikulin/elegant-status#readme
- Issues: https://github.com/inikulin/elegant-status/issues
- npm.io page: https://npm.io/package/elegant-status

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [os-family](https://npm.io/package/os-family.md) ^1.0.0
- [log-update](https://npm.io/package/log-update.md) ^1.0.2
- [elegant-spinner](https://npm.io/package/elegant-spinner.md) ^1.0.1

## 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

- 1.1.0 (latest) — 2016-05-20
- 1.0.0 — 2015-12-25

## README

# elegant-status
[![Build Status](https://api.travis-ci.org/inikulin/elegant-status.svg)](https://travis-ci.org/inikulin/elegant-status)

*Create elegant task status for CLI.*


```js
const elegantStatus = require('elegant-status');

const done = elegantStatus('Perform assessment');

setTimeout(() => done(true), 1000);
```

 ⬇

![success](https://raw.githubusercontent.com/inikulin/elegant-status/master/media/success.gif)


----


```js
const elegantStatus = require('elegant-status');

const done = elegantStatus('Set defense systems');

setTimeout(() => done(false), 1000);
```

 ⬇

![success](https://raw.githubusercontent.com/inikulin/elegant-status/master/media/fail.gif)

----

You can update status text while it's spinning using `done.updateText()` function:
```js
const elegantStatus = require('elegant-status');

const done = elegantStatus('Set defense systems');

setTimeout(() => done.updateText('1 second left'), 1000);
```


## Install
```
npm install elegant-status
```

## Author
[Ivan Nikulin](https://github.com/inikulin) (ifaaan@gmail.com)

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