cmd2

A python package for building powerful command-line interpreter (CLI) programs. Extends the Python Standard Library's cmd package.

The basic use of cmd2 is identical to that of cmd.

1. Create a subclass of cmd2.Cmd. Define attributes and do_* methods to control its behavior. Throughout this documentation, we will assume that you are naming your subclass App:

   from cmd2 import Cmd
   class App(Cmd):
       # customized attributes and methods here

2. Instantiate App and start the command loop:

   app = App()
   app.cmdloop()

Getting Started

Migrating from cmd

Features

Examples

Plugins

Testing

API Reference

Meta

:doc:`doc_conventions`