Elegant terminal spinner

$ npm install --save ora

const ora = require('ora');

const spinner = ora('Loading unicorns').start();

setTimeout(() => {
	spinner.color = 'yellow';
	spinner.text = 'Loading rainbows';
}, 1000);

It will gracefully not do anything when there's no TTY or when in a CI.

If a string is provided, it is treated as a shortcut for options.text.

Type: Object

Type: string

Text to display after the spinner.

Type: string Object
Default: dots

Name of one of the provided spinners. See example.js in this repo if you want to test out different spinners.

Or an object like:

{
	interval: 80, // optional
	frames: ['-', '+', '-']
}

Type: string
Default: cyan
Values: black red green yellow blue magenta cyan white gray

Color of the spinner.

Type: number
Default: Provided by the spinner or 100

Interval between each frame.

Spinners provide their own recommended interval, so you don't really need to specify this.

Type: WritableStream
Default: process.stderr

Stream to write the output.

You could for example set this to process.stdout instead.

Type: boolean

Force enable/disable the spinner. If not specified, the spinner will be enabled if the stream is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.

Start the spinner. Returns the instance. Set the current text if text is provided.

Stop and clear the spinner. Returns the instance.

Stop the spinner, change it to a green ✔ and persist the current text, or text if provided. Returns the instance. See the GIF below.

Stop the spinner, change it to a red ✖ and persist the current text, or text if provided. Returns the instance. See the GIF below.

Stop the spinner, change it to a yellow ⚠ and persist the current text, or text if provided. Returns the instance.

Stop the spinner, change it to a blue ℹ and persist the current text, or text if provided. Returns the instance.

Stop the spinner and change the symbol or text. Returns the instance. See the GIF below.

Type: Object

Type: string
Default: ' '

Symbol to replace the spinner with.

Type: string
Default: Current text

Text to be persisted.

Clear the spinner. Returns the instance.

Manually render a new frame. Returns the instance.

Get a new frame.

Change the text.

Change the spinner color.

Starts a spinner for a promise. The spinner is stopped with .succeed() if the promise fulfills or with .fail() if it rejects. Returns the spinner instance.

Type: Promise

• cli-spinners - Spinners for use in the terminal
• listr - Terminal task list
• CLISpinner - Terminal spinner library for Swift

MIT © Sindre Sorhus