urfave/cli
Cli
This is a framework for building structured terminal applications in Go. It provides the core components necessary to define a command-line interface, including a system for managing commands, sub-commands, and their associated flags.
The library distinguishes itself through an automated help generator that produces formatted usage instructions and manual pages, and a shell completion generator that creates tab-completion scripts for Bash, Zsh, Fish, and PowerShell. It also features a command lifecycle manager to handle pre- and post-execution logic and process exit codes.
The toolkit covers comprehensive argument parsing for various types, including strings, integers, slices, and maps, with support for environment variable overrides and value validation. It also includes utilities for error handling, command categorization, and the generation of Markdown documentation.
Features
- CLI Frameworks - Provides a comprehensive framework for defining structured terminal applications with commands, flags, and actions.
- Flag Definitions - Provides a comprehensive system for defining command-line flags with required values, defaults, and environment overrides.
- Go CLI Frameworks - Provides a complete framework for building structured terminal applications with commands and flags in Go.
- Argument Parsing - Implements a comprehensive system for defining and processing command-line flags and typed arguments.
- Argument Parsers - Uses a consistent interface to convert raw string arguments into typed Go values like slices and maps.
- Nested Command Structures - Provides a recursive hierarchy for organizing commands and sub-commands with associated metadata.
- String Parsers - Captures textual input from the command line and provides optional whitespace trimming.
- Command Lifecycle Managers - Manages the execution lifecycle of commands, including pre- and post-execution hooks and exit code handling.
- Exit Status Signaling - Controls terminal exit status based on error interfaces to communicate process success or failure.
- Boolean Toggles - Provides command-line flags that accept true or false values to toggle features or settings.
- Typed Flag Parsers - Enables the creation of typed command-line flags that handle specific value types and validation logic.
- Flag Propagation - Supports persistent flags that are inherited across the command and sub-command hierarchy.
- Flag Validation Utilities - Runs custom validation functions against flag inputs and default values to ensure they meet specific criteria.
- Help Text Generators - Automatically constructs formatted usage instructions and manual pages from command and flag metadata.
- Shell Completion Generators - Produces completion scripts for bash, zsh, fish, and PowerShell to enable tab-completion of commands and flags.
- Constraint Enforcers - Prevents users from providing conflicting command line options by requiring exactly one option from a specific group.
- Duration Parsers - Converts command line input strings into time duration types for precise time-based configuration.
- Integer Parsers - Parses command line arguments into unsigned integer types with range validation.
- Execution Middleware - Supports a sequence of before and after hooks to manage command execution setup and teardown.
- Boolean Flag Generators - Supports boolean switches with both positive and negative forms to explicitly enable or disable features.
- Map Parsers - Processes command line arguments into key-value pairs using configurable separators or JSON deserialization.
- Schema Exporters - Maps command line flags to standard schema types to facilitate automated documentation generation.
- Timestamp Parsers - Converts string input into time objects using configurable layouts and timezones.
- Man Page Generation - Produces formatted manual pages and Markdown documentation to describe the tool's interface and usage.
- Numeric Slice Parsers - Converts comma-separated or repeated flag inputs into slices of integers or floating-point numbers.
- String Slice Parsers - Collects multiple occurrences of a single flag into a slice of strings.
- Numeric Parsers - Extracts numeric values from command line flags as floating point numbers.
- Value Resolution Strategies - Resolves final configuration values by prioritizing flags, environment variables, and default settings.
- Error Handling - Intercepts usage errors or missing commands to provide customized error messages and recovery.
- Command Line Interfaces - Tool for building fast command-line applications.
- Command Line Tools - Tool for building command-line applications.
- Console Interfaces - Listed in the “Console Interfaces” section of the Awesome Go awesome list.
- Developer Tools and CLIs - Declarative package for building command-line tools.
- Go CLI Frameworks - Package for building fast and fun command-line apps.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
