Skip to content

API Reference

Generated from docstrings, organized by area:

  • ArgsArgs, Argument, ArgumentBuilder, the Arg/NS annotation helpers, Meta (the typed, typo-safe metadata form), the argument factories (Count, Append, Const, Choice, Extend), UpdateAction, and the module-level entry points (parser, parse, main, value_sources).
  • Discoverydiscover_commands, discover_entry_points (installed-distribution plugins), CmdBuilder, ModuleCommand, and the register_command_provider extension seam.
  • Formatters — opt-in --help formatters: DefaultsFormatter (append (default: X)), ColorHelpFormatter (ANSI), and ColorDefaultsFormatter (both), selected via a class's _help_formatter_.
  • PresetsLoggingArgs, the ready-made verbosity/log-level mixin.
  • Logging — colored formatting, custom levels, and stderr setup helpers.
  • Completion — bash/zsh/fish/PowerShell completion-script generation.