UNPKG

@open-utils/cli-colorize

Version:

A powerful and customizable library for terminal colors and styling. Add beautiful ANSI colors, progress bars, spinners, and formatted tables to your Node.js CLI applications.

80 lines (58 loc) โ€ข 2.73 kB
# @open-utils/cli-colorize > The most comprehensive terminal styling toolkit for Node.js CLI applications [![npm version](https://img.shields.io/npm/v/@open-utils/cli-colorize.svg)](https://www.npmjs.com/package/@open-utils/cli-colorize) [![npm downloads](https://img.shields.io/npm/dm/@open-utils/cli-colorize.svg)](https://www.npmjs.com/package/@open-utils/cli-colorize) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ## ๐Ÿ“ข Why Use @open-utils/cli-colorize? `@open-utils/cli-colorize` is the perfect solution if you're building CLI applications in Node.js and want: - ๐ŸŒˆ **Beautiful ANSI colors** for your terminal output - ๐Ÿ“Š **Progress bars** to show task completion status - โณ **Spinners** for long-running operations - ๐Ÿ“‹ **Formatted tables** to display data neatly - ๐ŸŽจ **Theme support** for consistent styling - ๐Ÿงฉ **Modular design** for flexibility - ๐Ÿ“ **Semantic methods** for expressive logging - ๐Ÿงช **Full TypeScript support** for type safety ## ๐Ÿ“ฅ Quick Install ```bash npm install @open-utils/cli-colorize ``` ## ๐Ÿš€ Quick Example ```javascript // CommonJS const { logger } = require('@open-utils/cli-colorize'); // ES Modules import { logger } from '@open-utils/cli-colorize'; // Semantic logging logger.success('Operation completed successfully!'); logger.error('Something went wrong'); logger.warning('This might cause issues'); logger.info('Processing data...'); // Progress bars const progress = logger.createProgressBar(100); progress.update(50, "Halfway there!"); // Spinners const spinner = logger.createSpinner('Loading...'); spinner.start(); // Later spinner.success('Data loaded!'); // Method chaining for concise code logger .info('Starting process') .success('Step 1 complete') .success('Step 2 complete') .info('All done!'); ``` ## ๐ŸŒŸ Features - **Zero dependencies** - lightweight and secure - **ESM & CommonJS support** - works with any project - **Theme-based styling** - customize to match your app - **Full TypeScript definitions** - great developer experience - **Workflow logging** - structured output for complex operations ## ๐Ÿ“š Documentation For full documentation, visit our [GitHub repository](https://github.com/saadyehahmmad/open-utils-cli-colorize#readme). ## ๐Ÿ“ฑ Related Packages - [@open-utils/cli-input](https://www.npmjs.com/package/@open-utils/cli-input) - Interactive command-line input utilities - [@open-utils/cli-menu](https://www.npmjs.com/package/@open-utils/cli-menu) - Create interactive command-line menus ## ๐Ÿ“„ License MIT ยฉ [Ahmad Sadieh](https://github.com/saadyehahmmad)