2017-05-28 00:38:50 +02:00
# cli-spinners [![Build Status](https://travis-ci.org/sindresorhus/cli-spinners.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-spinners)
> 60+ spinners for use in the terminal
2018-09-20 02:56:13 +02:00
< p align = "center" >
< img width = "700" src = "https://cdn.rawgit.com/sindresorhus/cli-spinners/dcac74b75e52d4d9fe980e6fce98c2814275739e/screenshot.svg" >
< / p >
2017-05-28 00:38:50 +02:00
The list of spinners is just a [JSON file ](spinners.json ) and can be used wherever.
You probably want to use one of these spinners through the [`ora` ](https://github.com/sindresorhus/ora ) module.
## Install
```
2017-12-27 19:33:54 +01:00
$ npm install cli-spinners
2017-05-28 00:38:50 +02:00
```
## Usage
```js
const cliSpinners = require('cli-spinners');
console.log(cliSpinners.dots);
/*
{
interval: 80,
frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
}
*/
```
## Preview
2017-12-27 19:33:54 +01:00
The header GIF is outdated. See all the [spinner at once ](http://jsfiddle.net/sindresorhus/2eLtsbey/embedded/result/ ) or [one at the time ](https://asciinema.org/a/95348?size=big ).
2017-05-28 00:38:50 +02:00
## API
Each spinner comes with a recommended `interval` and an array of `frames` .
[See the spinners. ](spinners.json )
## Related
- [ora ](https://github.com/sindresorhus/ora ) - Elegant terminal spinner
2017-12-27 19:33:54 +01:00
- [CLISpinner ](https://github.com/kiliankoe/CLISpinner ) - Terminal spinners for Swift
- [py-spinners ](https://github.com/ManrajGrover/py-spinners ) - Python port
2018-09-20 02:56:13 +02:00
- [spinners ](https://github.com/FGRibreau/spinners ) - Terminal spinners for Rust
2017-05-28 00:38:50 +02:00
## License
MIT © [Sindre Sorhus ](https://sindresorhus.com )