enquirer/enquirer
Enquirer
Enquirer is a Node.js library for creating interactive command-line interfaces to gather structured user input. It provides a set of terminal prompts, including menus, forms, and text fields, to collect data via autocomplete, multiselect, and boolean confirmations.
The project serves as a customizable framework that allows for the creation of custom prompt types through a base class and the extension of functionality via a plugin architecture.
The library covers a wide range of interaction patterns, such as capturing numerical and sensitive data, validating user input against custom rules, and executing sequences of prompts to collect complex feedback. It also includes capabilities for sorting lists, filling text snippets, and managing terminal form collection.
Features
- Interactive CLI Prompts - Provides a framework for executing sequences of interactive prompts to gather structured user input for configuration.
- Interactive Input Collecters - Provides a comprehensive system for gathering structured user data through a series of sequential interactive prompts.
- Terminal User Interfaces - Provides a complete system for building interactive terminal user interfaces with autocomplete, multiselect, and boolean prompts.
- Node.js CLI Libraries - Provides a specialized Node.js library for gathering structured user input via interactive terminal components.
- Secure Text Inputs - Captures text input with a secure masked mode for collecting passwords and secret keys.
- Custom Prompt APIs - Provides a base class and API for developers to create custom prompt types with unique rendering and behavior.
- Interactive Prompt Sequences - Runs a series of interactive questions in order and aggregates the collected responses into a single structured object.
- Core Capability Extensions - Allows the registration of custom prompt types and plugins to extend the library's core interaction capabilities.
- Prompt Logic Plugins - Features a plugin architecture allowing the injection of custom logic into the prompt runner instance.
- Plugin Integrations - Enables the integration of external plugin functions to augment the functionality of prompt instances.
- ANSI Terminal UI Libraries - Provides a system for rendering dynamic content and layouts in the terminal using ANSI escape codes.
- Boolean Prompts - Ships a dedicated yes/no toggle interface that returns a boolean value for user confirmations.
- Terminal Buffer Rendering - Updates the terminal interface by mapping internal state changes to specific screen coordinates and character buffers.
- Terminal Input Validation - Provides logic to validate user responses in terminal prompts against custom rules before allowing submission.
- Numeric Inputs - Includes specialized input prompts for capturing and returning numerical values.
- Scalar Input Fields - Provides specialized input fields for capturing strings, numbers, and booleans as single values.
- Select Menus - Provides selection menus for picking single or multiple options from a list using autocomplete or scales.
- Selectable Lists - Implements interactive vertical lists that allow users to select one or multiple options with custom labels.
- Multiple Selections - Implements multiple-choice lists and toggleable options for selecting one or more valid entries.
- Terminal Form Frameworks - Provides a framework for building multi-field forms and sequences for structured data collection in the terminal.
- Survey & Feedback Tools - Provides specialized prompt interfaces to collect structured feedback and survey data within a terminal environment.
- CLI Frameworks - Offers an extensible framework with a base class for creating custom prompt types and plugin-based logic.
- Custom Prompt Definitions - Allows developers to build specialized input components by extending the base prompt logic.
- Custom Key Action Bindings - Allows mapping specific keyboard inputs to custom actions to modify prompt interaction.
- Class Inheritance - Implements a class hierarchy where custom prompts inherit common logic and behaviors from a base prompt class.
- Credential Collection Interfaces - Implements secure input fields that mask keystrokes for collecting passwords and secret keys.
- Input Masking - Allows capturing passwords and secret keys by masking or hiding keystrokes in the terminal.
- Plugin-Based Architectures - Features a plugin architecture that allows extending the core prompt behavior with external modular logic.
- List Reordering - Includes a specialized prompt for reordering a list of items to define a specific preference or sequence.
- Real-time Prefix Filtering - Filters a list of choices in real-time as the user types to accelerate the selection process.
- Terminal Form Collection - Display multiple input fields on a single screen for users to fill out and submit together.
- Keyboard-to-Action Mappings - Maps keyboard input sequences to internal actions to control navigation and selection within interactive prompts.
- CLI Frameworks - User-friendly CLI prompt library.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
