flatiron/prompt
Prompt
Prompt is a terminal interface management library for Node.js applications that collects, validates, and styles interactive command-line user input. It handles user response collection and input stream controls, allowing developers to build command-line scripts and automation tools that require structured user input.
The library supports asynchronous event-driven prompt flows through both callback patterns and modern promises, alongside conditional prompt bypassing driven by command-line arguments, default values, preset overrides, and previous answers. Captured terminal responses can be appended directly onto existing target objects to streamline configuration workflows. Additional capabilities include ANSI-based terminal styling with custom delimiters and colored message strings, secure password masking for sensitive character input, and direct interception of standard input streams to manage lifecycle events and termination signals.
Input collection is governed by schema-driven validation rules that enforce data types, required fields, regular expressions, numeric and boolean formatting, and custom validation functions alongside default fallbacks.
Features
- Terminal Prompt Libraries - Provides interactive command-line prompt collection, schema-driven validation, and stream controls for Node.js applications.
- Command-Line Input Toolkits - Collects user input from the terminal using asynchronous methods with promise and callback support.
- Interactive CLI Prompts - Builds command-line interfaces in Node.js that prompt users for input and configuration details.
- Password Masking - Hides sensitive characters and passwords on the terminal screen as users type them.
- Terminal - Applies schema-driven validation rules and default fallbacks to structure and verify terminal responses.
- Input Validation Rules - Enforces validation rules, required fields, and regular expression patterns for data collection.
- Terminal Input Validation - Enforces schema definitions, data types, regular expressions, and custom rules on user-provided terminal inputs.
- Asynchronous Event Loop - Manages asynchronous event-driven prompt flows supporting callback patterns and modern promises.
- Prompt Bypassing - Skips interactive prompts automatically using command-line arguments and preset overrides.
- Terminal Prompt Customizers - Styles terminal prompts with custom messages, delimiters, and ANSI colors.
- Command Line Utilities - Writes terminal scripts and automation tools in Node.js requiring user input and styling.
- Input Event Interception - Controls standard input streams directly to manage lifecycle events and termination signals.
- Sensitive Input Prompts - Masks sensitive characters securely on the terminal screen as users type passwords or secret tokens.
- ANSI Style Composition - Formats command-line output dynamically using custom ANSI color codes and styled message strings.
