cli-cursor

cli-cursor

Toggle the CLI cursor

The cursor is gracefully restored if the process exits.

Install

npm install cli-cursor

Usage

import cliCursor from 'cli-cursor';

cliCursor.hide();

const unicornsAreAwesome = true;
cliCursor.toggle(unicornsAreAwesome);

API

.show(stream?)

.hide(stream?)

.toggle(force?, stream?)

force

Useful for showing or hiding the cursor based on a boolean.

stream

Type: stream.Writable
Default: process.stderr

Similar packages

Other packages similar to cli-cursor

ansi-escapes

The ansi-escapes package provides a collection of ANSI escape codes, including codes to hide and show the cursor. It offers more general functionality for manipulating the terminal, whereas cli-cursor is specifically focused on cursor visibility.

terminal-kit

Terminal-kit is a full-featured terminal handling library that includes methods for cursor visibility, among many other terminal manipulation features. It is a more comprehensive solution compared to the focused functionality of cli-cursor.

inquirer

Inquirer is a library for creating interactive command-line user interfaces. While it does not directly provide methods to hide or show the cursor, it manages cursor visibility internally as part of its UI rendering process, which can be considered a similar functionality in a broader context.