Repolode
提交项目
Shopify

Shopify/cli-ui

一个用于构建交互式命令行界面的 Ruby 小型框架，提供提示、加载动画和进度条等组件。

在 GitHub 查看
Star
1,130
Fork
57
未关闭 Issue
23
最近提交
上个月

这是什么？

CLI UI 是一个 Ruby 库，用于在命令行工具中输出结构清晰、视觉美观的终端界面。它提供了常见交互需求的组件，例如让用户从选项中选择或输入自由文本，以及展示长时间运行任务的状态。

框架支持嵌套的输出框架，用于把相关日志归组显示；加载组可以并发运行多个任务，并在无错误时隐藏其输出；另外还有进度条组件。文本可以通过 {{red:文字}}、{{*}} 等简单标记设置颜色和符号。框架外观可全局设置，也可针对单个框架单独指定，支持 box 和 bracket 两种样式。

该库无运行时依赖，并附带 Sorbet 类型桩，无论项目是否使用 Sorbet 都可以使用。通过 RubyGems 安装。

核心功能

  • 01交互式提示，支持方向键、vim 键位、数字选择和过滤
  • 02嵌套框架，用于组织输出内容
  • 03加载组可同时运行多个任务并显示标题和状态
  • 04提供进度条和状态组件
  • 05通过标记语法设置文本颜色和符号
  • 06支持全局或单个框架的 box 与 bracket 样式

适用场景

  • 用 Ruby 编写交互式安装或部署脚本
  • 并行执行多个构建或安装步骤并保持输出整洁
  • 在 Ruby 命令行工具中向用户征询选择或确认

快速上手

  1. 1

    从 RubyGems 安装该 gem

    gem install cli-ui
  2. 2

    在代码中引入库并启用 stdout 路由

标签

#cli#terminal#ruby#ui#prompts#spinner#progress-bar

常见问题

cli-ui 是什么？
一个用于构建交互式命令行界面的 Ruby 小型框架，提供提示、加载动画和进度条等组件。 CLI UI 是一个 Ruby 库，用于在命令行工具中输出结构清晰、视觉美观的终端界面。它提供了常见交互需求的组件，例如让用户从选项中选择或输入自由文本，以及展示长时间运行任务的状态。
cli-ui 可以免费使用吗？用的什么许可证？
cli-ui 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
cli-ui 还在维护吗？
半年内有更新。cli-ui 最近一次提交是在 2026年9月15日。
cli-ui 适合用来做什么？
用 Ruby 编写交互式安装或部署脚本 并行执行多个构建或安装步骤并保持输出整洁 在 Ruby 命令行工具中向用户征询选择或确认
cli-ui 怎么安装和运行？
从 RubyGems 安装该 gem: gem install cli-ui 在代码中引入库并启用 stdout 路由
在哪里获取 cli-ui？
源代码和安装说明在 GitHub 上：https://github.com/Shopify/cli-ui

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目