# tiny-spinner

> A simple, yet beautiful, CLI spinner.

Latest version **2.0.5** (published 2025-01-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install tiny-spinner
pnpm add tiny-spinner
yarn add tiny-spinner
bun add tiny-spinner
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.5 |
| Published | 2025-01-20 |
| First published | 2022-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Maintainers | fabiospampinato |
| Keywords | cli, terminal, spinner, loading, tiny, pretty |

## Links

- npm: https://www.npmjs.com/package/tiny-spinner
- Repository: https://github.com/fabiospampinato/tiny-spinner
- Homepage: https://github.com/fabiospampinato/tiny-spinner#readme
- Issues: https://github.com/fabiospampinato/tiny-spinner/issues
- npm.io page: https://npm.io/package/tiny-spinner

## Dependencies (4)

- [tiny-colors](https://npm.io/package/tiny-colors.md) ^2.2.2
- [tiny-cursor](https://npm.io/package/tiny-cursor.md) ^2.0.1
- [stdin-blocker](https://npm.io/package/stdin-blocker.md) ^2.0.1
- [tiny-truncate](https://npm.io/package/tiny-truncate.md) ^1.0.3

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

- 2.0.5 (latest) — 2025-01-20
- 2.0.4 — 2024-09-15
- 2.0.3 — 2023-08-25
- 2.0.2 — 2023-08-11
- 2.0.1 — 2023-08-11
- 2.0.0 — 2022-05-06
- 1.1.0 — 2022-02-09
- 1.0.0 — 2022-02-08

## README

<p align="center">
  <img src="resources/demo.gif" width="522" alt="Demo">
</p>

# Tiny Spinner

A simple, yet beautiful, CLI spinner.

## Install

```sh
npm install tiny-spinner
```

## Usage

```ts
import Spinner from 'tiny-spinner';

// Create spinner

const spinner = new Spinner ();

// Start spinner with initial message

spinner.start ( 'Doing something' );

// Update message

spinner.update ( 'Still doing something' );

// Exit with a warning message

spinner.warning ( 'Some warning message' );

// Exit with an error message

spinner.error ( 'Some error message' );

// Exit with a success message

spinner.success ( 'Some success message' );

// Exit with a custom message (no prefix symbol)

spinner.stop ( 'Some stop message' );

// Exit without a message

spinner.stop ();
```

## License

MIT © Fabio Spampinato

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