cli-helper-log

A beautiful, dependency-free command-line interface logger for Node.js featuring colors, badges, timestamps, and log-level filtering.

Features

• 🚀 Zero dependencies — extremely fast and leaves a tiny footprint.
• 🎨 ANSI Colors — uses native ANSI escape codes for coloring console logs.
• 🏷️ Categorized Logs — built-in support for Success, Info, Warning, Error, and Debug levels.
• ⏱️ Optional Timestamps — prepend clean, gray timestamps to every log message.
• ⚙️ LogLevel Filtering — suppress debug logs in production or disable logging completely.
• 🛠️ Custom Logs — create your own category with customized text colors, background colors, and badge symbols.

Installation

npm install cli-helper-log

Usage

const logger = require('cli-helper-log');

// Setup options (default shown)
logger.configure({
  level: 'info',         // Minimum log level ('debug', 'info', 'warn', 'error', 'none')
  showTimestamp: true,   // Display [HH:MM:SS] timestamp
  enabled: true          // Toggle logging
});

// standard levels
logger.info('Starting server on port 3000...');
logger.success('Database connected successfully!');
logger.warn('Disk usage is at 85%');
logger.error('Failed to write file to disk.');

// Debug logs are hidden because min level is set to 'info'
logger.debug('Testing internal pipeline...'); // will not log

// Update configuration to show debug logs
logger.configure({ level: 'debug' });
logger.debug('Testing internal pipeline...'); // will now log

// Custom Categories
logger.custom(
  { badge: '🔑', label: 'AUTH', color: 'magenta' },
  'User token generated for ID %d', 99
);

Formatting support

The logger functions wrap standard console methods, which natively support format specifiers such as %s (string), %d (number), or %o (object):

logger.info('Loading modules: %o', ['auth', 'database', 'routing']);

Custom Options

logger.custom(options, message, ...args) accepts the following properties inside options:

| Property | Type | Default | Description | |---|---|---|---| | badge | string | '♦' | Symbol prepended to the label. | | label | string | 'CUSTOM' | Category text tag. | | color | string | 'white' | Text color (red, green, yellow, blue, magenta, cyan, white, gray, black). | | bgColor | string | '' | Background color (red, green, yellow, blue, magenta, cyan, white, black). |

License

MIT