Docopt

Docopt es un analizador de argumentos de línea de comandos y herramienta de interfaz declarativa que convierte la entrada cruda de la terminal en un mapa de datos estructurado. Deriva su lógica de análisis y requisitos directamente de un mensaje de ayuda estandarizado al estilo POSIX, utilizando la documentación como especificación formal para la interfaz.

El sistema implementa un analizador de patrones de uso POSIX para traducir cadenas de ayuda legibles por humanos en reglas para extraer opciones y argumentos posicionales. Genera automáticamente pantallas de ayuda e información de versión basada en los patrones de uso internos definidos por el usuario.

La herramienta garantiza una experiencia de usuario predecible mediante un orden estricto de argumentos y opciones, evitando la mezcla de entradas una vez que se encuentran argumentos posicionales. Proporciona una implementación completa para el diseño de interfaces de línea de comandos, haciendo coincidir los tokens de entrada con patrones predefinidos para poblar estructuras de datos.

Features

Usage-Pattern-Based Parsing - Translates a formal help string into a set of rules for extracting options and positional arguments from input.
CLI Token Consumption - Processes the input stream sequentially to identify flags and arguments while adhering to specified order constraints.
CLI Token Matching - Matches raw command line tokens against defined usage patterns to populate a structured data map.
Declarative Argument Definitions - Defines CLI interfaces using a human-readable help message as a declarative source of truth instead of imperative logic.
Command Line Argument Parsers - Parses raw shell input strings into structured objects based on a predefined usage pattern.
POSIX Usage Parsers - Derives command-line logic and requirements directly from a standardized POSIX-style help message.
POSIX CLI Compliance - Creates command line tools that follow standard POSIX conventions for flags and arguments.
CLI Specification Design - Defines how a program accepts user inputs by writing a clear usage message that the system automatically parses.
Strict Argument Ordering - Ensures all options appear before positional arguments to prevent mixing inputs and ensure predictable command parsing.
Command Help Displays - Displays formatted help screens and version information when specific command flags are provided.
Help Generators - Automatically generates terminal-friendly documentation and version information from the internal usage specification.
Help Text Generators - Automatically constructs and formats instructional help documentation based on the parsed usage patterns.
Strict Option Sequencing - Stops accepting options once the first positional argument is encountered to maintain a strict sequence of command inputs.
CLI Development - Creates command-line interfaces based on usage documentation strings.
Python CLI Frameworks - Pythonic argument parser based on help messages.

Historial de estrellas

docoptdocopt

Name: docopt/docopt
Author: docopt

View on GitHub

8,008 estrellas558 forksPythonMIT4 vistas

Docopt

Features

Usage-Pattern-Based Parsing - Translates a formal help string into a set of rules for extracting options and positional arguments from input.
CLI Token Consumption - Processes the input stream sequentially to identify flags and arguments while adhering to specified order constraints.
CLI Token Matching - Matches raw command line tokens against defined usage patterns to populate a structured data map.
Declarative Argument Definitions - Defines CLI interfaces using a human-readable help message as a declarative source of truth instead of imperative logic.
Command Line Argument Parsers - Parses raw shell input strings into structured objects based on a predefined usage pattern.
POSIX Usage Parsers - Derives command-line logic and requirements directly from a standardized POSIX-style help message.
POSIX CLI Compliance - Creates command line tools that follow standard POSIX conventions for flags and arguments.
CLI Specification Design - Defines how a program accepts user inputs by writing a clear usage message that the system automatically parses.
Strict Argument Ordering - Ensures all options appear before positional arguments to prevent mixing inputs and ensure predictable command parsing.
Command Help Displays - Displays formatted help screens and version information when specific command flags are provided.
Help Generators - Automatically generates terminal-friendly documentation and version information from the internal usage specification.
Help Text Generators - Automatically constructs and formats instructional help documentation based on the parsed usage patterns.
Strict Option Sequencing - Stops accepting options once the first positional argument is encountered to maintain a strict sequence of command inputs.
CLI Development - Creates command-line interfaces based on usage documentation strings.
Python CLI Frameworks - Pythonic argument parser based on help messages.

Alternativas open-source a Docopt

Proyectos open-source similares, clasificados según cuántas características comparten con Docopt.

commandlineparser/commandline
commandlineparser/commandline
4,817Ver en GitHub
This library is a .NET command line parser for C# and F# that implements POSIX getopt conventions to map shell arguments into strongly typed objects. It provides a framework for building console applications that process Unix-style flags and options. The project features a routing system that directs program execution based on action-oriented verbs, supporting sub-commands and default actions. It includes an automatic help generator that produces localized usage instructions and formatted help screens based on the defined command options. The toolset covers argument parsing with strongly typ
C#command-linedotnetdotnet-core
Ver en GitHub4,817
remkop/picocli
remkop/picocli
5,387Ver en GitHub
picocli is a command line interface development framework and argument parser for JVM-based applications. It maps command line options and positional parameters to strongly typed Java methods and fields using a declarative, annotation-based model. The framework provides specific support for native image compilation, producing the reflection and resource configuration files necessary to build standalone binaries with reduced startup overhead. It further distinguishes itself with a dedicated system for generating shell autocompletion scripts and an ANSI terminal stylizer for applying colors and
Java
Ver en GitHub5,387
fastapi/typer
fastapi/typer
19,632Ver en GitHub
This project is a Python framework for building command-line interfaces by converting standard functions into executable programs. It uses type hints to automatically infer and generate argument parsers, validation logic, and help documentation, allowing developers to define complex terminal applications through simple function signatures. The framework distinguishes itself through a decorator-driven registration system that enables the construction of hierarchical command trees. It supports dependency injection to manage shared state and runtime configuration across subcommands, and it utili
Pythoncliclickpython
Ver en GitHub19,632
pallets/click
pallets/click
17,560Ver en GitHub
Click is a Python framework for building command-line interfaces. It provides a declarative approach to defining command structures, allowing developers to map functions to command-line arguments, options, and nested groups using decorators. The framework handles the complexities of parameter parsing, type validation, and help documentation generation automatically. The project distinguishes itself through its hierarchical context system, which propagates configuration and state across nested commands, and its environment-aware parameter resolution that prioritizes command-line inputs, enviro
Pythoncliclickpallets
Ver en GitHub17,560

Ver las 30 alternativas a Docopt

Preguntas frecuentes

¿Qué hace docopt/docopt?

¿Cuáles son las características principales de docopt/docopt?

Las características principales de docopt/docopt son: Usage-Pattern-Based Parsing, CLI Token Consumption, CLI Token Matching, Declarative Argument Definitions, Command Line Argument Parsers, POSIX Usage Parsers, POSIX CLI Compliance, CLI Specification Design.

¿Qué alternativas de código abierto existen para docopt/docopt?

Las alternativas de código abierto para docopt/docopt incluyen: commandlineparser/commandline — This library is a .NET command line parser for C# and F# that implements POSIX getopt conventions to map shell… remkop/picocli — picocli is a command line interface development framework and argument parser for JVM-based applications. It maps… fastapi/typer — This project is a Python framework for building command-line interfaces by converting standard functions into… pallets/click — Click is a Python framework for building command-line interfaces. It provides a declarative approach to defining… google/python-fire — Python Fire is a library that automatically generates command line interfaces from any Python object, function, or… cliutils/cli11 — CLI11 is a header-only C++ library for parsing command line arguments and managing configuration files. It maps shell…