Socket
Socket
Sign inDemoInstall

cli-cursor

Package Overview
Dependencies
4
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

cli-cursor

Toggle the CLI cursor

    4.0.0latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
39,347,214
increased by3.21%

Weekly downloads

Package description

What is cli-cursor?

The cli-cursor npm package allows developers to show or hide the cursor in command-line interfaces. This can be useful when creating CLI tools or applications that require a clean, distraction-free interface, or when the cursor needs to be temporarily hidden during spinner animations or other CLI graphics.

What are cli-cursor's main functionalities?

Hide Cursor

This feature hides the cursor in the terminal. It is useful when you want to prevent the cursor from interfering with CLI graphics or output.

const cliCursor = require('cli-cursor');
cliCursor.hide(process.stdout);

Show Cursor

This feature shows the cursor in the terminal after it has been hidden. It is useful for restoring the cursor once a CLI operation that required hiding it is complete.

const cliCursor = require('cli-cursor');
cliCursor.show(process.stdout);

Toggle Cursor

This feature toggles the visibility of the cursor based on a boolean value. It provides a convenient way to switch between showing and hiding the cursor.

const cliCursor = require('cli-cursor');
const isVisible = true; // This should be a dynamic value based on the current cursor state
cliCursor.toggle(process.stdout, isVisible);

Other packages similar to cli-cursor

Readme

Source

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


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Keywords

FAQs

Last updated on 23 Aug 2021

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc