当前位置：首页 > news >正文

cli-progress：终极命令行进度条工具，让你的终端应用更专业

news 2026/3/27 0:25:54

cli-progress：终极命令行进度条工具，让你的终端应用更专业

【免费下载链接】cli-progress:hourglass: easy to use progress-bar for command-line/terminal applications项目地址: https://gitcode.com/gh_mirrors/cl/cli-progress

在开发命令行应用时，一个直观的进度条能极大提升用户体验。cli-progress 作为一款简单易用的命令行进度条工具，为 Node.js 开发者提供了强大的进度可视化能力，让你的终端应用瞬间变得更加专业和友好。

为什么选择 cli-progress？

cli-progress 是一个专为命令行/终端应用设计的进度条工具，它凭借以下特性在众多同类库中脱颖而出：

简单易用：无需复杂配置，几行代码即可实现专业进度条
高度可定制：支持自定义进度条格式、颜色和动画效果
多模式支持：同时提供单进度条和多进度条模式
预设主题：内置多种视觉风格，满足不同场景需求
轻量级：仅依赖 string-width 一个第三方库，安装快速，运行高效

快速开始：安装与基础使用

安装步骤

通过 npm 或 yarn 可以轻松安装 cli-progress：

npm install cli-progress --save # 或 yarn add cli-progress

如果你需要从源码构建，可以克隆仓库：

git clone https://gitcode.com/gh_mirrors/cl/cli-progress cd cli-progress npm install

基础示例

下面是一个最简单的使用示例，创建一个基本的进度条：

const cliProgress = require('cli-progress'); // 创建进度条实例，使用经典阴影主题 const bar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic); // 启动进度条，总进度值为 200，起始值为 0 bar.start(200, 0); // 在你的应用中更新进度值 bar.update(100); // 完成后停止进度条 bar.stop();

这段代码将创建一个美观的进度条，直观展示任务进度。

核心功能展示

1. 单进度条模式

单进度条模式适用于大多数简单场景，你可以自定义其外观和显示信息：

通过自定义格式字符串，你可以展示进度百分比、剩余时间、当前值/总值等信息：

const bar = new cliProgress.SingleBar({ format: '进度: |{bar}| {percentage}% | ETA: {eta}s | {value}/{total}', barCompleteChar: '\u2588', barIncompleteChar: '\u2591', hideCursor: true });

2. 多进度条模式

当你需要同时跟踪多个任务进度时，多进度条模式就能派上用场：

创建和管理多个进度条非常简单：

// 创建多进度条容器 const multibar = new cliProgress.MultiBar({ clearOnComplete: false, hideCursor: true, format: ' {bar} | {filename} | {value}/{total}', }, cliProgress.Presets.shades_grey); // 添加两个进度条 const bar1 = multibar.create(200, 0); const bar2 = multibar.create(1000, 0); // 分别更新进度 bar1.increment(); bar2.update(20, {filename: "data.txt"}); // 完成后停止所有进度条 multibar.stop();

3. 内置预设主题

cli-progress 提供了多种预设主题，满足不同的视觉需求：

legacy：cli-progress v1.3.0 风格
shades-classic：使用 Unicode 背景阴影的进度条
shades-grey：灰色背景阴影进度条
rect：Unicode 矩形进度条

你可以直接使用这些预设，也可以在其基础上进行自定义：

// 使用灰色阴影预设 const bar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_grey);

高级用法

自定义进度条格式

cli-progress 允许你通过格式字符串完全自定义进度条的显示内容，支持以下占位符：

{bar}：进度条主体
{percentage}：百分比进度
{total}：总进度值
{value}：当前进度值
{eta}：预计剩余时间（秒）
{duration}：已用时间（秒）
{eta_formatted}：格式化的预计剩余时间
{duration_formatted}：格式化的已用时间
{<payloadKey>}：自定义负载数据

示例：

const bar = new cliProgress.SingleBar({ format: '下载中 |{bar}| {percentage}% | {value}/{total} 字节 | 速度: {speed} KB/s' }); // 启动时设置初始负载数据 bar.start(1000, 0, {speed: "0.0"}); // 更新时更新负载数据 bar.update(500, {speed: "125.5"});

事件监听

cli-progress 实例继承自 EventEmitter，可以监听各种事件：

bar.on('progress', (value, total, payload) => { // 进度更新时触发 console.log(`当前进度: ${value}/${total}`); }); bar.on('complete', () => { // 进度完成时触发 console.log('任务完成！'); });

更多事件详情请参考事件文档。