index.rst

API Reference

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 |version|.

.. toctree::
   :maxdepth: 1
   :hidden:

   cmd
   ansi
   argparse_completer
   argparse_custom
   constants
   command_definition
   decorators
   exceptions
   history
   parsing
   plugin
   py_bridge
   table_creator
   utils
   plugin_external_test

Modules

• :ref:`api/cmd:cmd2.Cmd` - functions and attributes of the main class in this library
• :ref:`api/ansi:cmd2.ansi` - convenience classes and functions for generating ANSI escape sequences to style text in the terminal
• :ref:`api/argparse_completer:cmd2.argparse_completer` - classes for argparse-based tab completion
• :ref:`api/argparse_custom:cmd2.argparse_custom` - classes and functions for extending argparse
• :ref:`api/command_definition:cmd2.command_definition` - supports the definition of commands in separate classes to be composed into cmd2.Cmd
• :ref:`api/constants:cmd2.constants` - just like it says on the tin
• :ref:`api/decorators:cmd2.decorators` - decorators for cmd2 commands
• :ref:`api/exceptions:cmd2.exceptions` - custom cmd2 exceptions
• :ref:`api/history:cmd2.history` - classes for storing the history of previously entered commands
• :ref:`api/parsing:cmd2.parsing` - classes for parsing and storing user input
• :ref:`api/plugin:cmd2.plugin` - data classes for hook methods
• :ref:`api/py_bridge:cmd2.py_bridge` - classes for bridging calls from the embedded python environment to the host app
• :ref:`api/table_creator:cmd2.table_creator` - table creation module
• :ref:`api/utils:cmd2.utils` - various utility classes and functions
• :ref:`api/plugin_external_test:cmd2_ext_test` - External test plugin