Overview
-
module Samovar-
class CommandRepresents a command in the command-line interface.
-
module CompletionShell completion support for Samovar commands.
-
class ContextThe context provided to dynamic completion callbacks.
-
class ProviderExpands static, dynamic, and native completion providers.
-
class ResultA collection of completion suggestions.
-
class SuggestionA single completion suggestion.
-
-
class ErrorThe base class for all Samovar errors.
-
class InvalidInputErrorRaised when invalid input is provided on the command line.
-
class MissingValueErrorRaised when a required value is missing.
-
class FailureRepresents a runtime failure in command execution.
-
class FlagsRepresents a collection of flag alternatives for an option.
-
class FlagRepresents a single command-line flag.
-
class ValueFlagRepresents a flag that accepts a value or acts as a boolean.
-
class BooleanFlagRepresents a boolean flag with
--flagand--no-flagvariants. -
class ManyRepresents multiple positional arguments in a command.
-
class NestedRepresents nested sub-commands in a command.
-
class OneRepresents a single positional argument in a command.
-
class OptionRepresents a single command-line option.
-
class OptionsRepresents a collection of command-line options.
-
module OutputNamespace for output formatting classes.
-
class ColumnsRepresents column widths for aligned output formatting.
-
class HeaderRepresents a header row in usage output.
-
class RowRepresents a row in usage output.
-
class RowsRepresents a collection of rows for usage output.
-
class UsageFormatterFormats and prints usage information to a terminal.
-
-
class SplitRepresents a split point in the command-line arguments.
-
class TableRepresents a table of parsing rows for a command.
-