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.
This documentation is for cmd2
version .
cmd ansi argparse_completer argparse_custom constants command_definition decorators exceptions history parsing plugin py_bridge table_creator utils plugin_external_test
Modules
api/cmd:cmd2.Cmd
- functions and attributes of the main class in this libraryapi/ansi:cmd2.ansi
- convenience classes and functions for generating ANSI escape sequences to style text in the terminalapi/argparse_completer:cmd2.argparse_completer
- classes forargparse
-based tab completionapi/argparse_custom:cmd2.argparse_custom
- classes and functions for extendingargparse
api/command_definition:cmd2.command_definition
- supports the definition of commands in separate classes to be composed into cmd2.Cmdapi/constants:cmd2.constants
- just like it says on the tinapi/decorators:cmd2.decorators
- decorators forcmd2
commandsapi/exceptions:cmd2.exceptions
- customcmd2
exceptionsapi/history:cmd2.history
- classes for storing the history of previously entered commandsapi/parsing:cmd2.parsing
- classes for parsing and storing user inputapi/plugin:cmd2.plugin
- data classes for hook methodsapi/py_bridge:cmd2.py_bridge
- classes for bridging calls from the embedded python environment to the host appapi/table_creator:cmd2.table_creator
- table creation moduleapi/utils:cmd2.utils
- various utility classes and functionsapi/plugin_external_test:cmd2_ext_test
- External test plugin