yargs/yargs

Features

• Argument Parsing - Translates raw command-line strings into structured JavaScript objects with support for types and aliases.
• CLI Command Frameworks - Provides a comprehensive framework for defining extensible command-line interfaces with asynchronous handler support.
• Argument Parsers - Parses command-line arguments and flags into structured JavaScript objects for Node.js applications.
• Argument Aliasing - Maps multiple flags to a single canonical key so that updates to one propagate to all associated aliases.
• CLI Command Registrars - Maps specific command-line keywords to handler functions to execute distinct application logic.
• Command Aliasing - Assigns multiple keywords to a single command so any defined alias triggers the same application logic.
• Nested Command Structures - Enables the creation of nested sub-commands with dedicated handlers and options to organize complex CLI structures.
• CLI Argument Definitions - Configures command-line arguments with fallback default values to ensure the application functions when flags are omitted.
• Positional Argument Configurations - Provides mechanisms to define expected positional arguments and handle variadic inputs during command execution.
• Positional Argument Mappings - Maps keywords to handler functions while supporting optional, required, and variadic positional arguments.
• Command-Line Argument Parsers - Translates raw command-line strings into structured JavaScript objects supporting various data types.
• Command Line Documentation - Automatically generates formatted help menus and usage instructions based on the defined command structure.
• Command Line Interface Frameworks - Provides a comprehensive toolkit for building professional terminal applications with nested commands and dedicated handlers.
• CLI Option Mappers - Provides mechanisms for mapping function parameters to optional command-line flags, aliases, and default values.
• Help Text Generators - Automatically constructs and formats detailed usage instructions and help menus based on command metadata.
• CLI Argument Validators - Enforces the presence of required arguments and displays custom error messages when they are missing.
• Command Line Interface Design - Provides a framework for designing structured terminal applications with sub-commands, flags, and positional arguments.
• CLI Input Coercion - Checks for required arguments and coerces input values into specific formats before program execution.
• Raw Argument Capture - Stops flag parsing at a specific delimiter and captures all remaining input as a list of raw strings.
• Argument Type Inference - Automatically maps command-line options to specific types using defined types, default values, and restricted choice lists.
• Environment Variable Configuration - Implements logic to read and use environment variables as fallback values for command-line options.
• Modular Command Structures - Supports importing command definitions, builders, and handlers from external modules to organize complex CLI hierarchies.
• Configuration Inheritance - Enables hierarchical configuration by loading base settings from external files or modules and applying overrides.
• Execution Middleware - Executes synchronous or asynchronous middleware functions before command handlers for shared tasks like setup.
• Configuration Merging Utilities - Merges configuration settings from environment variables, config files, and command-line flags into a single object.
• Shell Completion - Generates Bash and Zsh scripts to enable tab-completion for commands and options in the terminal.
• Shell Completion Generators - Generates platform-specific auto-completion scripts for Bash and Zsh based on the defined command tree.
• Input Behavior Configurations - Allows customization of parsing behaviors, including camel-case expansion, dot-notation, and boolean negation.
• Command-Line Correction Engines - Recommends the correct command or option when a typo is detected using string distance calculations.
• Configuration File Loading - Provides the ability to load and parse structured configuration files such as JSON or JS to supplement command-line arguments.
• File-Based Configuration Loaders - Merges settings from JSON or JS files with command-line arguments and environment variables.
• Middleware Pipelines - Provides a pipeline of interceptor functions to transform or validate parsed arguments before command execution.
• Argument Interception Pipelines - Runs a stack of functions to transform, validate, or overwrite parsed arguments before execution.
• Conflicting Argument Restrictions - Prevents specific combinations of arguments from being used together to avoid invalid configurations.
• Typo Correction Suggestions - Recommends the closest matching command when a typo is detected using Levenshtein or similar distance algorithms.
• Type Coercion Utilities - Coerces raw string arguments into specific data types like booleans, numbers, or arrays based on definitions.
• CLI Input Strictness - Includes a strict mode to reject unknown options and require valid commands to prevent user errors.
• CLI Frameworks - Interactive CLI tool collection.
• Command Line Interfaces - Parser for command-line arguments with automatic UI generation.
• Command Line Tools - The modern, pirate-themed successor to optimist.
• JavaScript CLI Frameworks - Library for parsing arguments and generating interfaces.

Star history