ProgressLine 开源项目使用教程

ProgressLine 开源项目使用教程

ProgressLine ⏳Track commands progress in a compact one-line format 项目地址: https://gitcode.com/gh_mirrors/pr/ProgressLine

1. 项目介绍

ProgressLine 是一个用于在命令行中跟踪长时间运行命令进度的工具。它可以以紧凑的单行格式显示进度，并提供多种活动指示器样式，如点、蛇形、猫头鹰和旋转器等。ProgressLine 支持自定义文本替换日志输出，高亮显示重要行，并可以将原始日志保存到文件。

2. 项目快速启动

首先，确保您的系统中已安装了 ProgressLine。以下是几种安装方式：

使用 Homebrew (macOS/Linux)

brew install progressline

使用 Mint (macOS)

mint install kattouf/ProgressLine

使用 Mise (macOS)

mise use -g spm:kattouf/ProgressLine

手动安装 (macOS/Linux)

从发布页面下载适用于您平台的二进制文件，并将其放置在可执行路径中。

安装完成后，您可以通过以下命令使用 ProgressLine：

long-running-command | progressline

如果您的命令同时输出标准错误（stderr），您可能需要重定向 stderr 到 stdout，以便所有输出都通过 ProgressLine：

long-running-command 2>&1 | progressline

3. 应用案例和最佳实践

改变活动指示器样式

使用 --activity-style 选项，您可以改变 ProgressLine 的活动指示器样式：

long-running-command | progressline --activity-style snake

替换日志输出为自定义文本

如果您不需要在执行期间看到日志输出，可以使用 --static-text 选项替换为自定义文本：

long-running-command | progressline --static-text "正在更新源..."

高亮显示重要行

使用 --log-matches 选项，您可以指定正则表达式来匹配并高亮显示重要行：

long-running-command | progressline --log-matches "regex-1" --log-matches "regex-2"

保存原始日志

您可以使用以下任一方法来保存完整的原始日志：

• 使用 tee 命令：

long-running-command | tee original-log.txt | progressline

• 使用 --original-log-path 选项：

long-running-command | progressline --original-log-path original-log.txt

4. 典型生态项目

ProgressLine 是一个独立的工具，它可以在多种环境中使用。以下是一些可能与 ProgressLine 配合使用的典型生态项目：

• 命令行工具：与各种命令行工具配合使用，以提供更好的用户体验。
• 脚本和自动化：在自动化脚本中集成 ProgressLine，以实时监控任务进度。
• 持续集成/持续部署 (CI/CD)：在 CI/CD 流程中使用 ProgressLine 来跟踪构建和部署进度。

通过上述介绍，您应该能够开始使用 ProgressLine 并将其集成到您的项目中。祝您使用愉快！

ProgressLine ⏳Track commands progress in a compact one-line format 项目地址: https://gitcode.com/gh_mirrors/pr/ProgressLine