# cursor-cli

> A library for toggling the CLI cursor in the terminal.

Latest version **1.0.0** (published 2022-03-30) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install cursor-cli
pnpm add cursor-cli
yarn add cursor-cli
bun add cursor-cli
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-03-30 |
| First published | 2022-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mhammed Talhaouy |
| Maintainers | tal7aouy |
| Keywords | cli, cursor, terminal, hide, show, toggle, toggle cursor |

## Links

- npm: https://www.npmjs.com/package/cursor-cli
- Repository: https://github.com/tal7aouy/cursor-cli
- Homepage: https://github.com/tal7aouy/cursor-cli#readme
- Issues: https://github.com/tal7aouy/cursor-cli/issues
- npm.io page: https://npm.io/package/cursor-cli

## Dependencies (1)

- [when-exit](https://npm.io/package/when-exit.md) ^1.0.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) — 2022-03-30

## README

# Cursor-cli

A library for toggling the CLI cursor in the terminal.

## Install

Get it on [npm](https://www.npmjs.com/package/cursor-cli)

```bash
npm install cursor-cli
```

Get it on [yarn](https://yarnpkg.com/package/cursor-cli)

```bash
yarn add  cursor-cli
```

## Usage

```ts
import Cursor from "cursor-cli";

Cursor.has(); // => true, the cursor is visible

Cursor.hide();

Cursor.has(); // => false, the cursor is not visible

Cursor.show();

Cursor.has(); // => true, the cursor is visible

Cursor.toggle();

Cursor.has(); // => false, the cursor is not visible
```

## License

[MIT © License](LICENSE)

---
_Source: https://npm.io/package/cursor-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._