Toggle the CLI cursor
Toggle the CLI cursor
The cursor is gracefully restored if the process exits.
npm install cli-cursor
import cliCursor from 'cli-cursor';
cliCursor.hide();
const unicornsAreAwesome = true;
cliCursor.toggle(unicornsAreAwesome);
Useful for showing or hiding the cursor based on a boolean.
Type: stream.Writable
Default: process.stderr
cli-cursor 共发布 9 个版本，首次发布于 2014/08/31；过去 12 个月发布了 0 个版本。
| 版本 | 发布日期 | 距今 |
|---|---|---|
5.0.0latest | 2024/07/26 | 2 年前 |
4.0.0 | 2021/08/24 | 5 年前 |
3.1.0 | 2019/06/12 | 7 年前 |
3.0.0 | 2019/04/09 | 7 年前 |
2.1.0 | 2017/01/10 | 9 年前 |
2.0.0 | 2017/01/10 | 9 年前 |
Toggle the CLI cursor
在项目目录运行 npm install cli-cursor，或使用 pnpm add / yarn add / bun add。
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
cli-cursor 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
根据 npm 官方下载统计，cli-cursor 在 2026/10/05 – 2026/11/03 这 30 天内被下载 513,462,710 次，日均约 17,115,424 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
最新版本 5.0.0 发布于 2024/07/26（2 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2014/08/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。