# @comandeer/cli-spinner 中文文档

规范地址：https://npmcn.com/package/%40comandeer/cli-spinner/

版本：1\.0\.2
npm 元数据更新时间：2023-08-02T18:16:49.088Z
中文译文更新时间：2026-11-10T11:38:44.386Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：9.4 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0\.0
- 运行依赖：3 个
- 首次发布：2021-09-29T22:04:53.333Z
- 最新版本发布：2023-08-02T18:16:48.983Z
- 近 30 天下载量：6890（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

简单的 CLI 旋转器

## 安装

```sh
npm install @comandeer/cli-spinner
```

也可以使用：`pnpm add @comandeer/cli-spinner`、`yarn add @comandeer/cli-spinner`、`bun add @comandeer/cli-spinner`

## README

# @ comandeer/ cli- spinner

[![Build Status](https://github.com/Comandeer/cli-spinner/workflows/CI/badge.svg)](https://github.com/Comandeer/cli-spinner/actions) [![codecov](https://codecov.io/gh/Comandeer/cli-spinner/branch/main/graph/badge.svg)](https://codecov.io/gh/Comandeer/cli-spinner) [![npm (scoped)](https://img.shields.io/npm/v/@comandeer/cli-spinner.svg)](https://npmjs.com/package/@comandeer/cli-spinner)

超级简单的CLI自旋器.

## 安装

```bash
npm install @comandeer/cli-spinner --save
```

## 使用量

```javascript
import Spinner from '@comandeer/cli-spinner';

const spinner = new Spinner( {
    label: 'Working…'
} );

await spinner.show();

//do something

await spinner.hide();
```

## 配置

您可以通过 : `options` 构造器中的对象 :

```javascript
const spinner = new Spinner( options );
```

现有备选方案清单如下:

| 名称 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| `stdout` | [`Stream`](https://nodejs.org/api/stream.html#stream) | [`process.stderr`](https://nodejs.org/api/process.html#processstderr) | 流将输出出旋转器. |
| `label` | `string` | `''` | 将在旋转器旁边显示的额外文本标签 . |
| `spinner` | `Array<string>` | 见 [`src/defaultSpinner.js`](https://github.com/Comandeer/cli-spinner/blob/main/src/defaultSpinner.js) | 包含用于激活自旋器的帧的阵列 . |
| `interval` | `number` | 80个 | 说明旋转器的帧应改变多少次. |

## 我为什么要用它而不是X?

事实是,你可能不应该。 这个软件包的创建是因为我受不了 [`gauge`](https://github.com/npm/gauge) 财务报告和审定财务报表 [`ora`](https://github.com/sindresorhus/ora) 没有为我工作的原因。 因为我很认真 [NIH综合症](https://en.wikipedia.org/wiki/Not_invented_here)我决定建立我自己的,非常天真 执行CLI旋转器.

所以,如果你寻找一个经过战斗测试的解决方案 并且不要介意更多的混乱 API,使用 `gauge`。如果您更喜欢经过战斗测试但真正方便用户的API,请使用 `ora`如果出于某种原因,这些解决方案对你不起作用,你还是不应该使用这个包.

## 许可证

见 [自由主义](https://npmcn.com/package/%40comandeer/cli-spinner/LICENSE) 详细文件.

## 常见问题

### @comandeer/cli-spinner 是什么？

简单的 CLI 旋转器

### 如何安装 @comandeer/cli-spinner？

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

### @comandeer/cli-spinner 支持 TypeScript 吗？

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

### @comandeer/cli-spinner 支持 ESM 还是 CommonJS？

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

### @comandeer/cli-spinner 需要什么版本的 Node\.js？

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

### @comandeer/cli-spinner 可以商用吗？

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

### @comandeer/cli-spinner 的下载量有多少？

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

### @comandeer/cli-spinner 还在维护吗？

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