# ora-min > Copy by ora, Elegant terminal spinner use turbocolor Latest version **1.0.0** (published 2018-08-20) · MIT license · 0 weekly downloads ## Install ```sh npm install ora-min pnpm add ora-min yarn add ora-min bun add ora-min ``` ## 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.0.0 | | Published | 2018-08-20 | | First published | 2018-08-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=6 | | Dependencies | 6 | | Unpacked size | 10 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | yobrave | | Maintainers | yobrave1995 | | Keywords | cli, spinner, spinners, terminal, term, console, ascii, unicode, loading, indicator, progress, busy, wait, idle | ## Links - npm: https://www.npmjs.com/package/ora-min - Repository: https://github.com/chinanf-boy/ora-min - Homepage: https://github.com/chinanf-boy/ora-min#readme - Issues: https://github.com/chinanf-boy/ora-min/issues - npm.io page: https://npm.io/package/ora-min ## Dependencies (6) - [wcwidth](https://npm.io/package/wcwidth.md) ^1.0.1 - [cli-cursor](https://npm.io/package/cli-cursor.md) ^2.1.0 - [strip-ansi](https://npm.io/package/strip-ansi.md) ^4.0.0 - [turbocolor](https://npm.io/package/turbocolor.md) * - [log-symbols](https://npm.io/package/log-symbols.md) ^2.2.0 - [cli-spinners](https://npm.io/package/cli-spinners.md) ^1.1.0 ## 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.0.0 (latest) — 2018-08-20 ## README # ora [![Build Status](https://travis-ci.org/sindresorhus/ora.svg?branch=master)](https://travis-ci.org/sindresorhus/ora) > Elegant terminal spinner



## Install ``` $ npm install ora ``` ## Usage ```js const ora = require('ora'); const spinner = ora('Loading unicorns').start(); setTimeout(() => { spinner.color = 'yellow'; spinner.text = 'Loading rainbows'; }, 1000); ``` ## API ### ora([options|text]) If a string is provided, it is treated as a shortcut for [`options.text`](#text). #### options Type: `Object` ##### text Type: `string` Text to display after the spinner. ##### spinner Type: `string` `Object`
Default: `dots` Name of one of the [provided spinners](https://github.com/sindresorhus/cli-spinners/blob/master/spinners.json). See `example.js` in this repo if you want to test out different spinners. Or an object like: ```js { interval: 80, // optional frames: ['-', '+', '-'] } ``` ##### color Type: `string`
Default: `cyan`
Values: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white` `gray` Color of the spinner. ##### hideCursor Type: `boolean`
Default: `true` Set to `false` to stop Ora from hiding the cursor. ##### interval 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. ##### stream Type: `WritableStream`
Default: `process.stderr` Stream to write the output. You could for example set this to `process.stdout` instead. ##### isEnabled 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. Note that `{isEnabled: false}` doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text. ### Instance #### .start([text]) Start the spinner. Returns the instance. Set the current text if `text` is provided. #### .stop() Stop and clear the spinner. Returns the instance. #### .succeed([text]) Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided. Returns the instance. See the GIF below. #### .fail([text]) Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided. Returns the instance. See the GIF below. #### .warn([text]) Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided. Returns the instance. #### .info([text]) Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided. Returns the instance. #### .isSpinning A boolean of whether the instance is currently spinning. #### .stopAndPersist([options]) Stop the spinner and change the symbol or text. Returns the instance. See the GIF below. ##### options Type: `Object` ###### symbol Type: `string`
Default: `' '` Symbol to replace the spinner with. ###### text Type: `string`
Default: Current text Text to be persisted. #### .clear() Clear the spinner. Returns the instance. #### .render() Manually render a new frame. Returns the instance. #### .frame() Get a new frame. #### .text Change the text. #### .color Change the spinner color. ### ora.promise(action, [options|text]) 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. #### action Type: `Promise` ## Related - [cli-spinners](https://github.com/sindresorhus/cli-spinners) - Spinners for use in the terminal - [listr](https://github.com/SamVerschueren/listr) - Terminal task list - [CLISpinner](https://github.com/kiliankoe/CLISpinner) - Terminal spinner library for Swift - [halo](https://github.com/ManrajGrover/halo) - Python port - [spinners](https://github.com/FGRibreau/spinners) - Terminal spinners for Rust - [marquee-ora](https://github.com/joeycozza/marquee-ora) - Scrolling marquee spinner for Ora ## License MIT © [Sindre Sorhus](https://sindresorhus.com) --- _Source: https://npm.io/package/ora-min · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._