@docmd/tui
Terminal User Interface (TUI) design system for docmd.
This package provides a unified, high-signal design system for all terminal output across the docmd ecosystem. It ensures a consistent, professional, and emoji-free aesthetic for core tools and third-party plugins.
Features
Semantic Styling - Predefined color tokens for consistent visual feedback
Layout Components - Box-drawing based sections, dividers, and footers
Progress Tracking - Standardized step-by-step progress logging
Zero Configuration - Works out of the box with reasonable defaults
Universal Branding - Centralised ASCII logo for consistent brand presence
Usage
import { TUI } from '@docmd/tui';
TUI.banner(undefined, '0.7.7');
TUI.section('Building Site');
TUI.step('Parsing content', 'DONE');
TUI.footer();
Part of the docmd documentation engine.
Documentation
See docs.docmd.io for full usage and API reference.
License
MIT
关于 @docmd/tui 的常见问题@docmd/tui 是什么? Terminal User Interface (TUI) design system for docmd.
如何安装 @docmd/tui? 在项目目录运行 npm install @docmd/tui,或使用 pnpm add / yarn add / bun add。
@docmd/tui 支持 TypeScript 吗? 支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@docmd/tui 支持 ESM 还是 CommonJS? 以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@docmd/tui 需要什么版本的 Node.js? package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@docmd/tui 可以商用吗? @docmd/tui 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@docmd/tui 的下载量有多少? 根据 npm 官方下载统计,@docmd/tui 在 2026/10/13 – 2026/11/11 这 30 天内被下载 78,026 次,日均约 2,601 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@docmd/tui 还在维护吗? 最新版本 0.9.9 发布于 2026/11/04(9 天前);至今共发布 32 个版本,其中过去 12 个月发布了 32 个;首次发布于 2026/05/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。