# cli-cursor 中文文档

规范地址：https://npmcn.com/package/cli-cursor/

版本：5\.0\.0
npm 元数据更新时间：2024-07-26T14:02:26.439Z
中文译文更新时间：2026-11-05T03:06:59.009Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/cli-cursor
原文对照：https://npmcn.com/package/cli-cursor/?lang=original
项目主页：https://github.com/sindresorhus/cli-cursor#readme
源码仓库：https://github.com/sindresorhus/cli-cursor

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：4.1 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：1 个
- 首次发布：2014-08-31T11:48:41.699Z
- 最新版本发布：2024-07-26T14:02:26.233Z
- 近 30 天下载量：513462710（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

切换CLI光标

## 安装

```sh
npm install cli-cursor
```

也可以使用：`pnpm add cli-cursor`、`yarn add cli-cursor`、`bun add cli-cursor`

## README

# cli-cursor

> 切换CLI光标

光标是 [优雅地恢复](https://github.com/sindresorhus/restore-cursor) 如果进程退出。

## 安装

```sh
npm install cli-cursor
```

## 用法

```js
import cliCursor from 'cli-cursor';

cliCursor.hide();

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

## API

### ,告诉(流?)

### hide(流?)

### .toggle(力?,流?)

#### 力

用于根据布尔值显示或隐藏游标。

#### 流

类型: `stream.Writable`  
默认值: `process.stderr`

## 常见问题

### cli-cursor 是什么？

切换CLI光标

### 如何安装 cli-cursor？

在项目目录运行 npm install cli-cursor，或使用 pnpm add / yarn add / bun add。

### cli-cursor 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### cli-cursor 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### cli-cursor 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### cli-cursor 可以商用吗？

cli-cursor 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### cli-cursor 的下载量有多少？

根据 npm 官方下载统计，cli-cursor 在 2026/10/05 – 2026/11/03 这 30 天内被下载 513,462,710 次，日均约 17,115,424 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### cli-cursor 还在维护吗？

最新版本 5\.0\.0 发布于 2024/07/26（2 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2014/08/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。