cli-spinners

What is cli-spinners?

The cli-spinners package provides a collection of spinners for command-line interface (CLI) applications. These spinners can be used to indicate loading or processing status in a visually appealing way to the users of CLI applications.

What are cli-spinners's main functionalities?

Displaying Spinners

This feature allows you to display various spinner animations in the terminal. The code sample shows how to require the cli-spinners package and log one of the spinner types, in this case, 'dots'.

const cliSpinners = require('cli-spinners');
console.log(cliSpinners.dots);

Integrating with CLI Applications

This feature demonstrates how to integrate cli-spinners with another package like 'ora' to manage the spinner's lifecycle, including starting, stopping, and displaying success or failure messages.

const ora = require('ora');
const spinner = ora({
  text: 'Loading unicorns',
  spinner: cliSpinners.dots
}).start();

setTimeout(() => {
  spinner.succeed('Unicorns loaded');
}, 1000);

Other packages similar to cli-spinners

ora

Ora is a popular package that provides spinner functionality for CLI applications. It includes a wide variety of spinner styles and offers an easy-to-use API for controlling the spinner's lifecycle. Compared to cli-spinners, ora is more feature-rich and provides a higher-level API for managing spinners.

node-spinner

Node-spinner is another package that offers spinner functionality for Node.js applications. It is a simpler and more lightweight alternative to cli-spinners, with a focus on simplicity and ease of use. However, it may not have as many spinner options or features as cli-spinners.

clui

CLUI is a collection of Node.js command line UI components, which includes spinner functionality as one of its features. While it provides a broader set of CLI tools beyond just spinners, it can be used in a similar way to cli-spinners for displaying loading indicators in the terminal.

README

cli-spinners

70+ spinners for use in the terminal

The list of spinners is just a JSON file and can be used wherever.

You probably want to use one of these spinners through the ora package.

Install

npm install cli-spinners

Usage

import cliSpinners from 'cli-spinners';

console.log(cliSpinners.dots);
/*
{
	interval: 80,
	frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
}
*/

Preview

The header GIF is outdated. See all the spinner at once or one at the time.

API

cliSpinners

Each spinner comes with a recommended interval and an array of frames.

See the spinners.

randomSpinner()

Get a random spinner.

import {randomSpinner} from 'cli-spinners';

console.log(randomSpinner());
/*
{
	interval: 80,
	frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
}
*/

Related

• ora - Elegant terminal spinner
• CLISpinner - Terminal spinners for Swift
• py-spinners - Python port
• spinners - Terminal spinners for Rust
• go-spinners - Go port