These pages document the public API for cmd2. If a method, class, function, attribute, or constant
is not documented here, consider it private and subject to change. There are many classes, methods,
functions, and constants in the source code which do not begin with an underscore but are not
documented here. When looking at the source code for this library, you cannot safely assume that
because something doesn't start with an underscore, it is a public API.
If a release of this library changes any of the items documented here, the version number will be incremented according to the Semantic Version Specification.
- cmd2.Cmd - functions and attributes of the main class in this library
- cmd2.argparse_completer - classes for
argparse-based tab completion - cmd2.argparse_custom - classes and functions for extending
argparse - cmd2.clipboard - functions to copy from and paste to the clipboard/pastebuffer
- cmd2.colors - StrEnum of all color names supported by the Rich library
- cmd2.command_definition - supports the definition of commands in separate classes to be composed into cmd2.Cmd
- cmd2.constants - just like it says on the tin
- cmd2.decorators - decorators for
cmd2commands - cmd2.exceptions - custom
cmd2exceptions - cmd2.history - classes for storing the history of previously entered commands
- cmd2.parsing - classes for parsing and storing user input
- cmd2.plugin - data classes for hook methods
- cmd2.py_bridge - classes for bridging calls from the embedded python environment to the host app
- cmd2.rich_utils - common utilities to support Rich in cmd2 applications
- cmd2.rl_utils - imports the proper Readline for the platform and provides utility functions for it
- cmd2.string_utils - string utility functions
- cmd2.styles - cmd2-specific Rich styles and a StrEnum of their corresponding names
- cmd2.terminal_utils - support for terminal control escape sequences
- cmd2.transcript - functions and classes for running and validating transcripts
- cmd2.utils - various utility classes and functions